分布式中Redis实现Session终结篇

时间 2019-11-10

原文原文链接

　　上一篇使用Redis实现Session共享方式虽然可行,可是实际操做起来却很麻烦，现有代码已是这个样子了,总不可能所有换掉吧！好吧,这是个很实际的问题,那么能不能实现无侵入式的分布式Session共享方案呢？mode="InProc"这是web.config里面使用iis进程保存Session的配置,不知你注意过没,mode除了InProc,SQLServer,StateServer这几个经常使用的,还有一个Custom。这里我要使用的是网友提供给的一种方自定义Session，须要继承System.Web.SessionState.SessionStateStoreProviderBase实现本身的SessionStateStoreProvide,下面讲解如何实现自定义的RedisSessionStateStore。git

阅读目录web

回到顶部

SessionStateStoreProviderBase

　　SessionStateStoreProviderBase是asp.net提供的定义数据存储区的会话状态提供程序所需的成员。像经常使用InProcSessionStateStore(mode="InProc"),SqlSessionStateStore(mode="SQLServer"),都是继承SessionStateStoreProviderBase实现的存储。咱们来看看msdn对其成员的定义redis

成员	说明
InitializeRequest 方法json	执行会话状态存储提供程序必需的全部初始化操做。跨域
EndRequest 方法浏览器	执行会话状态存储提供程序必需的全部清理操做。cookie
Dispose 方法session	释放会话状态存储提供程序再也不使用的全部资源。并发
GetItemExclusive 方法asp.net	从会话数据存储区中检索会话的值和信息，并在请求持续期间锁定数据存储区中的会话项数据。GetItemExclusive 方法设置几个输出参数值，这些参数值将数据存储区中当前会话状态项的状态通知给执行调用的 SessionStateModule。若是数据存储区中未找到任何会话项数据，则GetItemExclusive 方法将 locked 输出参数设置为false，并返回 null。这将致使 SessionStateModule调用 CreateNewStoreData 方法来为请求建立一个新的SessionStateStoreData 对象。若是在数据存储区中找到会话项数据但该数据已锁定，则GetItemExclusive 方法将 locked 输出参数设置为true，将 lockAge 输出参数设置为当前日期和时间与该项锁定日期和时间的差，将 lockId 输出参数设置为从数据存储区中检索的锁定标识符，并返回 null。这将致使SessionStateModule 隔半秒后再次调用GetItemExclusive 方法，以尝试检索会话项信息和获取对数据的锁定。若是 lockAge 输出参数的设置值超过ExecutionTimeout 值，SessionStateModule 将调用ReleaseItemExclusive 方法以清除对会话项数据的锁定，而后再次调用 GetItemExclusive 方法。若是 regenerateExpiredSessionId 属性设置为 true，则 actionFlags 参数用于其 Cookieless 属性为 true 的会话。actionFlags 值设置为 InitializeItem (1) 则指示会话数据存储区中的项是须要初始化的新会话。经过调用CreateUninitializedItem 方法能够建立会话数据存储区中未初始化的项。若是会话数据存储区中的项已经初始化，则 actionFlags 参数设置为零。若是提供程序支持无 Cookie 会话，请将 actionFlags 输出参数设置为当前项从会话数据存储区中返回的值。若是被请求的会话存储项的 actionFlags 参数值等于InitializeItem 枚举值 (1)，则 GetItemExclusive 方法在设置 actionFlags `out` 参数以后应将数据存储区中的值设置为零。
GetItem 方法	除了不尝试锁定数据存储区中的会话项之外，此方法与GetItemExclusive 方法执行的操做相同。GetItem 方法在 EnableSessionState 属性设置为 ReadOnly 时调用。
SetAndReleaseItemExclusive 方法	采用当前请求的 HttpContext 实例、当前请求的SessionID 值、包含要存储的当前会话值的SessionStateStoreData 对象、当前请求的锁定标识符以及指示要存储的数据是属于新会话仍是现有会话的值做为输入。若是 newItem 参数为 true，则SetAndReleaseItemExclusive 方法使用提供的值将一个新项插入到数据存储区中。不然，数据存储区中的现有项使用提供的值进行更新，并释放对数据的任何锁定。请注意，只有与提供的 SessionID 值和锁定标识符值匹配的当前应用程序的会话数据才会更新。调用 SetAndReleaseItemExclusive 方法后，SessionStateModule 调用 ResetItemTimeout 方法来更新会话项数据的过时日期和时间。
ReleaseItemExclusive 方法	采用当前请求的 HttpContext 实例、当前请求的SessionID 值以及当前请求的锁定标识符做为输入，并释放对会话数据存储区中的项的锁定。在调用 GetItem 或GetItemExclusive 方法，而且数据存储区指定被请求项已锁定，但锁定时间已超过 ExecutionTimeout 值时会调用此方法。此方法清除锁定，释放该被请求项以供其余请求使用。
RemoveItem 方法	此方法在 Abandon 方法被调用时调用。
CreateUninitializedItem 方法	采用当前请求的 HttpContext 实例、当前请求的SessionID 值以及当前请求的锁定标识符做为输入，并向会话数据存储区添加一个 actionFlags 值为InitializeItem 的未初始化项。若是 regenerateExpiredSessionId 属性设置为 true，则 CreateUninitializedItem 方法用于无 Cookie 会话，这将致使遇到过时会话 ID 时，SessionStateModule 会生成一个新的 SessionID值。生成新的 SessionID 值的过程须要浏览器重定向到包含新生成的会话 ID 的 URL。在包含过时的会话 ID 的初始请求期间，会调用 CreateUninitializedItem 方法。SessionStateModule 获取一个新的 SessionID 值来替换过时的会话 ID 以后，它会调用CreateUninitializedItem 方法以将一个未初始化项添加到会话状态数据存储区中。而后，浏览器重定向到包含新生成的 SessionID 值的 URL。若是会话数据存储区中存在未初始化项，则能够确保包含新生成的 SessionID 值的重定向请求被视为新的会话，而不会被误认为是对过时会话的请求。会话数据存储区中未初始化的项与新生成的 SessionID值关联，而且仅包含默认值，其中包括到期日期和时间以及与 GetItem 和 GetItemExclusive 方法的actionFlags 参数相对应的值。会话状态存储区中的未初始化项应包含一个与 InitializeItem 枚举值 (1) 相等的actionFlags 值。此值由 GetItem 和GetItemExclusive 方法传递给SessionStateModule，并针对 SessionStateModule指定当前会话是新会话。而后，SessionStateModule将初始化该新会话，并引起 Session_OnStart 事件。
CreateNewStoreData 方法	采用当前请求的 HttpContext 实例和当前会话的Timeout 值做为输入，并返回带有空ISessionStateItemCollection 对象的新的SessionStateStoreData 对象、一个HttpStaticObjectsCollection 集合和指定的 Timeout值。使用 GetSessionStaticObjects 方法能够检索 ASP.NET 应用程序的 HttpStaticObjectsCollection 实例。

上面的定义有点长,其实不少都在说明一点那就是原生了Session是单线程的方式实现的，当多个进行读的时候会加锁后面的会等待。咱们下面实现的去掉了这些锁，加快并发读写。

回到顶部

实现本身的RedisSessionStateStore

继承SessionStateStoreProviderBase实现本身的RedisSessionStateStore也很简单,只需继承SessionStateStoreProviderBase重写CreateNewStoreData,CreateUninitializedItem,GetItem等几个方法便可，下面贴出代码，参考InProcSessionStateStore实现。

/// <summary>
    /// 使用Cookie实现SessionStateStoreProviderBase
    /// 注意：它只适合保存简单的基元类型数据。
    /// </summary>
    public class RedisSessionStateStore : SessionStateStoreProviderBase
    {
        public override SessionStateStoreData CreateNewStoreData(HttpContext context, int timeout)
        {
            return CreateLegitStoreData(context, null, null, timeout);
        }

        internal static SessionStateStoreData CreateLegitStoreData(HttpContext context, ISessionStateItemCollection sessionItems, HttpStaticObjectsCollection staticObjects, int timeout)
        {
            if (sessionItems == null)
                sessionItems = new SessionStateItemCollection();
            if (staticObjects == null && context != null)
                staticObjects = SessionStateUtility.GetSessionStaticObjects(context);
            return new SessionStateStoreData(sessionItems, staticObjects, timeout);
        }

        public override void CreateUninitializedItem(HttpContext context, string id, int timeout)
        {
            RedisSessionState state = new RedisSessionState(null, null, timeout);
            RedisBase.Item_Set<string>(id, state.ToJson(), timeout);
        }

        private SessionStateStoreData DoGet(HttpContext context, string id, bool exclusive, out bool locked, out TimeSpan lockAge, out object lockId, out SessionStateActions actionFlags)
        {
            locked = false;
            lockId = null;
            lockAge = TimeSpan.Zero;
            actionFlags = SessionStateActions.None;
            RedisSessionState state = RedisSessionState.FromJson(RedisBase.Item_Get<string>(id));
            if (state == null)
            {
                return null;
            }
            RedisBase.Item_SetExpire(id, state._timeout);
            return CreateLegitStoreData(context, state._sessionItems, state._staticObjects, state._timeout);
        }

        public override SessionStateStoreData GetItem(HttpContext context, string id, out bool locked, out TimeSpan lockAge, out object lockId, out SessionStateActions actionFlags)
        {
            return this.DoGet(context, id, false, out locked, out lockAge, out lockId, out actionFlags);
        }

        public override SessionStateStoreData GetItemExclusive(HttpContext context, string id, out bool locked, out TimeSpan lockAge, out object lockId, out SessionStateActions actionFlags)
        {
            return this.DoGet(context, id, true, out locked, out lockAge, out lockId, out actionFlags);
        }

        public override void SetAndReleaseItemExclusive(HttpContext context, string id, SessionStateStoreData item, object lockId, bool newItem)
        {
            ISessionStateItemCollection sessionItems = null;
            HttpStaticObjectsCollection staticObjects = null;

            if (item.Items.Count > 0)
                sessionItems = item.Items;
            if (!item.StaticObjects.NeverAccessed)
                staticObjects = item.StaticObjects;

            RedisSessionState state2 = new RedisSessionState(sessionItems, staticObjects, item.Timeout);

            RedisBase.Item_Set<string>(id, state2.ToJson(), item.Timeout);
        }

        #region "未实现方法"

        public override void Dispose()
        {

        }

        public override void EndRequest(HttpContext context)
        {

        }

        public override void InitializeRequest(HttpContext context)
        {

        }

        public override void ReleaseItemExclusive(HttpContext context, string id, object lockId)
        {
        }

        public override void RemoveItem(HttpContext context, string id, object lockId, SessionStateStoreData item)
        {
            RedisBase.Item_Remove(id);
        }

        public override void ResetItemTimeout(HttpContext context, string id)
        {

        }

        public override bool SetItemExpireCallback(SessionStateItemExpireCallback expireCallback)
        {
            return true;
        }

        #endregion

    }
    internal sealed class SessionStateItem
    {
        public Dictionary<string, SaveValue> Dict;
        public int Timeout;
    }

    internal sealed class SaveValue
    {
        public object Value { get; set; }

        public Type Type { get; set; }
    }

    internal sealed class RedisSessionState
    {
        internal ISessionStateItemCollection _sessionItems;
        internal HttpStaticObjectsCollection _staticObjects;
        internal int _timeout;

        internal RedisSessionState(ISessionStateItemCollection sessionItems, HttpStaticObjectsCollection staticObjects, int timeout)
        {
            this.Copy(sessionItems, staticObjects, timeout);
        }

        internal void Copy(ISessionStateItemCollection sessionItems, HttpStaticObjectsCollection staticObjects, int timeout)
        {
            this._sessionItems = sessionItems;
            this._staticObjects = staticObjects;
            this._timeout = timeout;
        }

        public string ToJson()
        {
            // 这里忽略_staticObjects这个成员。

            if (_sessionItems == null || _sessionItems.Count == 0)
            {
                return null;
            }

            Dictionary<string, SaveValue> dict = new Dictionary<string, SaveValue>(_sessionItems.Count);

            NameObjectCollectionBase.KeysCollection keys = _sessionItems.Keys;
            string key;
            object objectValue = string.Empty;
            Type type = null;
　　　　　　//2016-09-04解决存入值没有类型致使读取值是jobject问题　　 for (int i = 0; i < keys.Count; i++)
            {
                key = keys[i];
                objectValue = _sessionItems[key];
                if (objectValue != null)
                {
                    type = objectValue.GetType();
                }
                else
                {
                    type = typeof(object);
                }
                dict.Add(key, new SaveValue { Value = objectValue, Type = type });
            }

            SessionStateItem item = new SessionStateItem { Dict = dict, Timeout = this._timeout };

            return JsonConvert.SerializeObject(item);
        }

        public static RedisSessionState FromJson(string json)
        {
            if (string.IsNullOrEmpty(json))
            {
                return null;
            }
            try
            {
                SessionStateItem item = JsonConvert.DeserializeObject<SessionStateItem>(json);

                SessionStateItemCollection collections = new SessionStateItemCollection();

                SaveValue objectValue = null;
　　　　　　　　　　//2016-09-04解决读取出来的值 没有类型的问题
                JsonSerializer serializer = new JsonSerializer();
                StringReader sr = null;
                JsonTextReader tReader = null;

                foreach (KeyValuePair<string, SaveValue> kvp in item.Dict)
                {
                    objectValue = kvp.Value as SaveValue;
                    if (objectValue.Value == null)
                    {
                        collections[kvp.Key] = null;
                    }
                    else
                    {
                        if (!IsValueType(objectValue.Type))
                        {
                            sr = new StringReader(objectValue.Value.ToString());
                            tReader = new JsonTextReader(sr);
                            collections[kvp.Key] = serializer.Deserialize(tReader, objectValue.Type);
                        }
                        else
                        {
                            collections[kvp.Key] = objectValue.Value;
                        }
                    }
                }

                return new RedisSessionState(collections, null, item.Timeout);
            }
            catch
            {
                return null;
            }
        }

        /// <summary>
        /// 判断是否为值类型
        /// </summary>
        /// <param name="type">Type</param>
        /// <returns></returns>
        public static bool IsValueType(Type type)
        {
            if (type.IsValueType)
            {
                return true;
            }
            //基础数据类型
            if (type == typeof(string) || type == typeof(char)
                || type == typeof(ushort) || type == typeof(short) || type == typeof(uint) || type == typeof(int)
                || type == typeof(ulong) || type == typeof(long) || type == typeof(double) || type == typeof(decimal)
                || type == typeof(bool)
                || type == typeof(byte))
            {
                return true;
            }
            //可为null的基础数据类型
            if (type.IsGenericType && !type.IsGenericTypeDefinition)
            {
                Type genericType = type.GetGenericTypeDefinition();

                if (Object.ReferenceEquals(genericType, typeof(Nullable<>)))
                {
                    var actualType = type.GetGenericArguments()[0];
                    return IsValueType(actualType);

                }
            }
            return false;
        }
    }

使用也很简单，修改web.config,以下图

而后能够保持原先代码不变,像Session["UserCode"]="admin"方式进行使用，可是如今的Session已经具有了分布式的特征,支持跨域。这里得说一下该方式的缺点,在GetItem和SetAndReleaseItemExclusive时须要对键值对进行反序列化和序列化操做,对于保存数据量大的状况反而性能相对于系统提供的方式大打折扣,因此使用的时候须要考虑本身的实际场景。

回到顶部

总结　　

　原本分布式Session共享到上篇就完结了,可是因为方案的可行性差,还有更好的方案,因此花了点时间参考了前面MSND中的说明，和ASP.net源码中InProcSessionStateStore的实现,解决GetItemExclusive等方法的并发锁定问题,最终实现了Redis的存储方式，更加灵活方便。这里要感谢你们提的意见,让我又学会了一个知识点！

资源下载地址：redis_demo

　　svn下载地址：http://code.taobao.org/svn/ResidSessionDemo/

　　本文参考:

　　sessionstatestoreproviderbase定义：https://msdn.microsoft.com/zh-cn/library/system.web.sessionstate.sessionstatestoreproviderbase(VS.80).aspx

　　sessionstatestoreproviderbase成员:https://msdn.microsoft.com/zh-cn/library/ms178587(v=vs.80).aspx

若是，您认为阅读这篇博客让您有些收获，不妨点击一下右下角的【推荐】按钮。
若是，您但愿更容易地发现个人新博客，不妨点击一下绿色通道的【关注我】。

若是，想给予我更多的鼓励，求打

由于，个人写做热情也离不开您的确定支持。

感谢您的阅读，若是您对个人博客所讲述的内容有兴趣，请继续关注个人后续博客，我是焰尾迭。