第十六節：Asp.Net Core中Session的使用、擴展、進程外Session

一. 簡介

 　　關於Session的原理可參照Asp.Net版本Session的文章，去查閱。

1. 普通用法

　(1).通過Nuget引入【Microsoft.AspNetCore.Http】程序集，Core Mvc中已經默認引入了,在哪使用using一下即可。

　(2).注入Session相關的服務。

　　A：在ConfigureService注冊基於服務器內存的Session， services.AddDistributedMemoryCache(); services.AddSession(); 在Configure中進行啟用Session，app.UseSession();

　   注：一定要在mvc前面進行注入，進程外Session的注入后面介紹。

　　B：如果項目中使用了CookiePolicyOptions，一定要將里面true改為false，如： options.CheckConsentNeeded = context => false; 或者配置Session的性質，options.Cookie.IsEssential = true;（表示cookie是必須的），否則chrome中拿不到Session值

　解釋：這是個GDRP條例，讓用戶自己選擇使用用cookie，詳見 http://www.zhibin.org/archives/667 或 https://www.cnblogs.com/GuZhenYin/p/9154447.html

　　C：在控制器中通過 HttpContext.Session 來向Session中讀寫各種值。

注冊和啟用相關的代碼：

 public void ConfigureServices(IServiceCollection services)
 {
            services.Configure<CookiePolicyOptions>(options =>
            {
                // This lambda determines whether user consent for non-essential cookies is needed for a given request.
                options.CheckConsentNeeded = context => false;       //改為false或者直接注釋掉，上面的Session才能正常使用
                options.MinimumSameSitePolicy = SameSiteMode.None;
            });
            //注冊Session服務
            //基於內存的Session
            services.AddDistributedMemoryCache();
            //默認過期時間為20分鍾，每次訪問都會重置
            services.AddSession();

            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
  }
  public void Configure(IApplicationBuilder app, IHostingEnvironment env)
  {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseExceptionHandler("/Home/Error");
            }
            app.UseStaticFiles();
            app.UseCookiePolicy();
            //啟用Session管道
            app.UseSession();

            app.UseMvc(routes =>
            {
                routes.MapRoute(
                    name: "default",
                    template: "{controller=CoreSession}/{action=Index6}/{id?}");
            });
  }

測試代碼：

      public IActionResult Index()
        {
            string userName = HttpContext.Session.GetString("userName");
            if (string.IsNullOrEmpty(userName))
            {
                userName = "ypf";
                HttpContext.Session.SetString("userName", userName);
            }
            var t1 = HttpContext.Session.GetString("userName");
            ViewBag.userName = userName;
            return View();
        }

        public IActionResult Index2()
        {
            string userName = HttpContext.Session.GetString("userName");
            ViewBag.userName = userName;
            return View();
        }

補充Session默認提供的方法：

2. 全局注冊使用

(1).背景：通常便於管理，我們將Session進行全局統一注入，方便管理。

(2).步驟:

　　A: 在普通用法的前提下，在ConfigureService中進行統一對象的注冊， services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

　　B：在控制器利用構造函數進行注入。

　　C：正常使用即可，案例詳見項目的Index3和Index4

代碼分享：

 

 public class CoreSessionController : Controller
    {
        private readonly IHttpContextAccessor httpContextAccessor;

        private ISession MySession => httpContextAccessor.HttpContext.Session;

        public CoreSessionController(IHttpContextAccessor httpContextAccessor)
        {
            this.httpContextAccessor = httpContextAccessor;
        }
        #region 02-測試統一注入的用法
        /// <summary>
        /// 下面是統一注入使用的寫法
        /// </summary>
        /// <returns></returns>

        public IActionResult Index3()
        {
            string userName = MySession.GetString("userName");
            if (string.IsNullOrEmpty(userName))
            {
                userName = "ypf";
                MySession.SetString("userName", userName);
            }
            var t1 = MySession.GetString("userName");
            ViewBag.userName = userName;
            return View();
        }

        public IActionResult Index4()
        {
            string userName = MySession.GetString("userName");
            ViewBag.userName = userName;
            return View();
        }
        #endregion

    }

 

二. 高級

1. Session的擴展

(1).背景

　　我們發現系統默認提供的Session方法，僅能存儲byte、string、int類型，很不靈活，我們想能存儲任何對象，這個時候就需要我們自行擴展。 對SessionExtensions類進行擴展

(2).利用Newtonsoft.Json進行擴展

　　A. 擴展代碼詳見SessionExtensions中的Set和Get方法

　　B. 案例詳見Index5

(3).利用protobuf-net進行擴展

　　A. 通過Nuget安裝程序集【protobuf-net】，這是谷歌的一個程序集，序列化和反序列效率更高

　　B. 擴展代碼詳見SessionExtensions中的Set2和Get2方法, 如果寫入的是個類，類名上要加 [ProtoContract]，屬性上要加 [ProtoMember(1)] [ProtoMember(2)]等等， 如：UserInfor2

　　C. 案例詳見Index6

擴展代碼：

  public static class SessionExtensions
    {
        #region 01-利用Newtonsoft.Json進行擴展
        public static void Set<T>(this ISession session, string key, T value)
        {
            session.SetString(key, JsonConvert.SerializeObject(value));
        }

        public static T Get<T>(this ISession session, string key)
        {
            var value = session.GetString(key);
            return value == null ? default(T) : JsonConvert.DeserializeObject<T>(value);
        }
        #endregion

        #region 02-利用protobuf-net進行擴展
        public static void Set2<T>(this ISession session, string key, T value)
        {
            using (MemoryStream stream = new MemoryStream())
            {
                Serializer.Serialize(stream, value);
                byte[] byteArrary = stream.ToArray();
                session.Set(key, byteArrary);
            }
        }

        public static T Get2<T>(this ISession session, string key)
        {
            byte[] byteArray = session.Get(key);
            if (byteArray == null)
            {
                return default(T);
            }
            else
            {
                using (MemoryStream stream = new MemoryStream(byteArray))
                {
                    return Serializer.Deserialize<T>(stream);
                }
            }
        }
        #endregion
    }

類代碼：

 public class UserInfor1
    {
        public string id { get; set; }
        public string userName { get; set; }
    }
    [ProtoContract]
    public class UserInfor2
    {
        [ProtoMember(1)]
        public string id { get; set; }
        [ProtoMember(2)]
        public string userName { get; set; }

    }

測試代碼：

  #region 03-測試Newtonsoft.Json進行擴展
        public IActionResult Index5()
        {
            UserInfor1 user = HttpContext.Session.Get<UserInfor1>("u1");
            if (user == null)
            {
                user = new UserInfor1();
                user.id = "001";
                user.userName = "Marren";
                HttpContext.Session.Set<UserInfor1>("u1", user);
            }
            ViewBag.id = user.id;
            ViewBag.userName = user.userName;
            return View();
        }
        #endregion

        #region 04-測試protobuf-net進行擴展
        public IActionResult Index6()
        {
            UserInfor2 user = HttpContext.Session.Get2<UserInfor2>("u2");
            if (user == null)
            {
                user = new UserInfor2();
                user.id = "001";
                user.userName = "Marren";
                HttpContext.Session.Set2<UserInfor2>("u2", user);
            }
            ViewBag.id = user.id;
            ViewBag.userName = user.userName;
            return View();
        }
        #endregion

2.Session的性質

(1). Session的過期時間(多次訪問將會被重置，默認過期時間為20分鍾)

　　如：options.IdleTimeout = TimeSpan.FromMinutes(120);

(2). 設置為true表示前端js等腳本無法讀取cookie，防止了xss攻擊(默認是true)

　　如：options.Cookie.HttpOnly = true;

(3). Cookie是必須的(默認是false),可以覆蓋上面的cookie策略

　　如：options.Cookie.IsEssential = true;

3. 如何在普通類中使用Session對象？

(1).說明

　　再普通類中如何調用Session，大約有兩種思路：以構造函數的注入進去，但是如果這個類不是過濾器，使用的時候就需要實例化，又需要傳入對象進去，如CheckLogin類，很麻煩，所以建議用第二種方案，直接吧實例好的Session傳入進去，直接使用即可，如CheckLogin2.

(2). 方案一

　　先統一注入， services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();，然后再在控制器中進行構造函數注入,但調用的時候還需要傳入進去。

PS:過濾器中可以直接context.httpContext.Session來設置

(3). 方案二

　　直接把實例好的Session傳進去

 public class CheckLogin2
    {
        private ISession MySession { get; set; }

        public CheckLogin2(ISession mySession)
        {
            MySession = mySession;
        }
        public bool isLogin()
        {
            string userName = MySession.GetString("userName");
            if (string.IsNullOrEmpty(userName))
            {
                return false;
            }
            return true;
        }
    }

 

三. 進程外Session

 　　關於進程外Session的好處、解決了什么痛點問題，可以參考Asp.Net 中的進程外Session，去查閱。 （解決了IIS重啟Session丟失的問題，解決了Session空間有限容易被擠爆的問題，但不能解決瀏覽器重啟找不到Session的問題！）

　　特別說明：基於SQLServer或Redis數據的進程外Session 的數據庫方面的配置和前面分布式緩存章節數據庫的配置完全相同，去查閱。

1. 基於SQLServer

 (1). 安裝【Microsoft.Extensions.Caching.SqlServer】程序集，如果是Core MVC程序，自帶的Microsoft.AspNetCore.App包里已經涵蓋了該程序集，無需重復安裝。

 (2). 首先要有個目標數據庫中(比如CacheDB數據庫)，然后以管理員身份cmd運行下面指令，會創建一張名叫“AspNetCoreSession”表，相應的Session信息都存在於這張表中。

       【dotnet sql-cache create "Server=localhost;User=sa;Password=123456;Database=CacheDB" dbo AspNetCoreSession】成功后會提示：Table and index were created successfully.

PS：補充表的結構和含義, 分別是鍵、值、到期時刻(有問題)、滑動過期時間、絕對過期時間。

(3). 將原先基於內存的Session代碼( services.AddDistributedMemoryCache(); )替換成基於SqlServer的代碼，如下：

            //01-基於內存的Session
            //services.AddDistributedMemoryCache();

            //02-基於SQLServer的Session
            services.AddDistributedSqlServerCache(options =>
            {
                options.ConnectionString = Configuration["SqlSeverConnectionString"];
                options.SchemaName = "dbo";
                options.TableName = "AspNetCoreSession";
            });

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*",
  "SqlSeverConnectionString": "Server=localhost;User=sa;Password=123456;Database=CacheDB"
}

(4). 其它的配置都不變，正常使用即可。

2. 基於Redis

 (1). 安裝【Microsoft.Extensions.Caching.StackExchangeRedis】程序集，Core MVC中這個也是不包含的。

 (2). 下載Redis程序，打開redis-server.exe，啟動Redis。

 

(3). 將原先基於內存的Session代碼 ( services.AddDistributedMemoryCache(); ) 替換成基於Redis的代碼，如下：

            //01-基於內存的Session
            //services.AddDistributedMemoryCache();

            //03-基於Redis的Session
            services.AddStackExchangeRedisCache(options =>
            {
                options.Configuration = "localhost";
                options.InstanceName = "SampleInstance";
            });

(4). 其它配置都不變，正常使用即可。

 

 

 

!

• 作       者 : Yaopengfei(姚鵬飛)
• 博客地址 : http://www.cnblogs.com/yaopengfei/
• 聲     明1 : 本人才疏學淺，用郭德綱的話說“我是一個小學生”，如有錯誤，歡迎討論，請勿謾罵^_^。
• 聲     明2 : 原創博客請在轉載時保留原文鏈接或在文章開頭加上本人博客地址，否則保留追究法律責任的權利。