asp.net core系列 43 Web應用 Session分布式存儲(in memory與Redis)

一.概述

　　HTTP 是無狀態的協議。 默認情況下，HTTP 請求是不保留用戶值或應用狀態的獨立消息。 本文介紹了幾種保留請求間用戶數據和應用狀態的方法。下面以表格形式列出這些存儲方式,本篇專講Session會話狀態，計划下篇再講應用狀態。

存儲方法	存儲機制
Cookie	HTTP Cookie（可能包括使用服務器端應用代碼存儲的數據）
Session 狀態	HTTP Cookie 和服務器端應用代碼
TempData	HTTP Cookie 或Session狀態
查詢字符串	HTTP 查詢字符串
隱藏字段	HTTP 窗體字段
HttpContext.Items	服務器端應用代碼
Cache	服務器端應用代碼
依賴關系注入	服務器端應用代碼

　　1.1 Cookie

　　　　Cookie是服務器產生ID的標簽。是識別用戶，實現持久會話的最好方式。Cookie分為兩類：會話Cookie和持久Cookie。二者唯一區別是設置過期時間。

　　　　(1)會話Cookie是臨時的，當用戶退出瀏覽器時，就會被刪除。

　　　　(2)持久Cookie生存時間更長，存儲在硬盤上，當瀏覽器退出或計算機重啟時它們仍然存在。

　　　　Cookie跨請求存儲數據,每次請求都會發送Cookie。Cookie的大小應該保持在最低限度。理想情況下，僅標識符存儲在 Cookie 中。大多數瀏覽器 Cookie 大小限制為 4096 個字節。每個域僅有有限數量的 Cookie 可用，比如IE6.0每個域cookie個數最多為20個。

　　　　下面看Cookie是如何工作的：

　　　　(a) 客戶端首次Request請求Web站點時，Web服務器對客戶端一無所知。

　　　　(b) Web服務器通過Response報文的 Set-Cookie或Set-Cookie2產生標識Cookie id=”34294”，返回給客戶端，客戶端瀏覽器會存儲該Cookie。

　　　　(c) 當客戶端再次Request請求時，帶上Cookie，Web服務器就能識別該客戶端，實現會話。

 

　　1.2 Session (會話)介紹

　　　　Session數據由緩存支持並被視為臨時數據，Session狀態是用戶瀏覽Web應用程序時，存儲用戶數據的ASP.NET Core方案。Session狀態使用應用維護的存儲，來保存客戶端所有請求的數據。ASP.NET Core通過向客戶端提供包含Session ID的cookie來維護Session狀態，該Session ID隨每個請求一起發送到應用程序(Web服務器)。該應用程序使用Session ID來獲取Session數據(Session數據存儲在Web服務器上)。Session會話狀態以下主要行為：

       　　(1) 由於cookie Session是特定於瀏覽器的，因此不能跨瀏覽器共享會話。

　　　　(2) 應用在上次請求后保留Session的時間有限。 應用程序可以設置Session超時，或者使用 20 分鍾的默認值。

　　　　(3) 建議不使用粘性會話, 更好的方法是使用Redis或SQL Server分布式緩存，它不需要粘性會話。

　　

　　1.3  Session會話選項

　　　　若要替代Session默認值，使用 SessionOptions (services.AddSession)。下面是主要選項，以及示例：

選項	說明
Cookie	確定用於創建 Cookie 的設置。名稱默認為.AspNetCore.Session
IdleTimeout	空閑多長時間Session重置。 此設置僅適用於Session內容，不適用於 Cookie。 默認為 20 分鍾。
IOTimeout	允許從存儲加載會話或者將其提交回存儲的最大時長。 此設置可能僅適用於異步操作。 可以使用 InfiniteTimeSpan 禁用超時。 默認值為 1 分鍾

　　   //選項配置
　　   services.AddSession(options =>
      {
          options.Cookie.Name = ".AdventureWorks.Session";
          options.IdleTimeout = TimeSpan.FromSeconds(10);
      });

 

 　　1.4 Session設置和獲取值

　　　　在 Microsoft.AspNetCore.Session 包中提供中間件來管理Session狀態。 若要啟用Session中間件，Startup 必須包含如下：

　　　　(1) 任何IDistributedCache內存緩存。該IDistributedCache實現用作Session的后備存儲,下面會講到分布式緩存在 ASP.NET Core 中。

　　　　(2) 對 ConfigureServices 方法中 AddSession 的調用。

　　　　(3) 對 Configure 中 UseSession(); 的調用。

 

二. Session存儲 in memory

　　在 ASP.NET Core中,分布式緩存無論使用in memory、SQL Server、Redis都需要應用程序使用IDistributedCache接口與緩存進行交互。Session存儲在in memory中，稱為”分布式內存緩存”(AddDistributedMemoryCache)。是框架提供的IDistributedCache實現。注意：分布式內存緩存不是實際的分布式緩存,該緩存是存儲在運行應用程序的服務器上。

 　　運用場景一般用在開發或測試中。也可以用在生產環境下，但必須是內存消耗不高並且應用程序是單個節點(沒有Web分發負載)。

 

　　2.1 Startup文件配置session

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
           //..
            services.AddDistributedMemoryCache();
            services.AddHttpContextAccessor();
            services.AddSession(options =>
            {
                //空閑10秒后, session自動清空
                options.IdleTimeout = TimeSpan.FromSeconds(10);
                options.Cookie.HttpOnly = true; });
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
       //..
       //順序很重要,必須放在UseMvc之前。配置后HttpContext.Session可用
 app.UseSession();
        app.UseMvc();
    }
}

 

　　2.2 使用屬性 HttpContext.Session 從 Razor Pages PageModel 類或 MVC 控制器類訪問會話狀態。

 　public class HomeController : Controller
    {
        private readonly IHttpContextAccessor _accessor;
        public HomeController( IHttpContextAccessor httpContextAccessor)
        {
            this._accessor = httpContextAccessor;
        }

        public IActionResult Index()
        {
            HttpContext.Session.SetString("SessionTest", "Ben Rules!");
            return View();
        }
        
        public IActionResult Privacy()
        {
            ViewData["SessionTest"] = _accessor.HttpContext.Session.GetString("SessionTest");
            return View();
        }
    }

　　　　 先運行index頁設置Session后，再運行Privacy頁讀取該Session。如下圖：Session會話設置和獲取值成功，再查看瀏覽器中的Cookies名稱默認為.AspNetCore.Session。

　　　　

　　2.3 Session數據序列化

　　　　必須對所有Session數據進行序列化以啟用分布式緩存方案，即使是在使用in memory緩存的時候。對於字符串和數據序列化以由ISession 擴展方法實現了。對於復雜類型，添加以下擴展方法以設置和獲取可序列化的對象。

public static class SessionExtensions
{
    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);
    }
}

　　　　//以下示例演示如何使用擴展方法設置和獲取可序列化的對象：
　　　　HttpContext.Session.Set<DateTime>(SessionKeyTime, currentTime);

 

三.Session存儲Redis

　　Redis緩存比SQL Server緩存提供更高的吞吐量和更低的延遲。這里不在演示SQL Server存儲，如果要用SQL Server存儲，建議為分布式緩存提供專用的SQL Server實例(與應用程序的數據庫實例分開)。

 　　3.1 Redis服務器

　　　　關於redis的安裝，這里不在介紹。

#啟動redis服務成功
[root@localhost bin]# ./redis-server redis.conf

#啟動redis客戶端測試成功
[root@localhost bin]# ./redis-cli -h 172.168.18.200  -a 123456
127.0.0.1:6379> set msg "hello"
OK
127.0.0.1:6379> get msg
"hello"

 　　

　　3.2 asp.net core應用端

　　　　(1)演示項目是基於上面的in memory案例，先安裝redis中間件。

　　　　PM> Install-Package Microsoft.Extensions.Caching.Redis

　　　　(2)將in memory改為redis存儲，代碼改動如下：

            //services.AddDistributedMemoryCache();
            services.AddDistributedRedisCache(options =>
            {
                options.Configuration = "172.168.18.200:6379,allowAdmin=true,password=123456,defaultdatabase=0";
            });
            services.AddHttpContextAccessor();
            services.AddSession(options =>
            {
                options.IdleTimeout = TimeSpan.FromSeconds(10);
                options.Cookie.HttpOnly = true;
            });
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

　　　　(3)設置和獲取Session

　　　　　　在HomeController類中，設置和獲取Session，代碼不變，可參考上面2.2。運行index頁后，再運行Privacy頁，Session會話設置和獲取值成功，再使用redis工具查看已存儲到了redis服務中（空閑10秒后，redis存儲的session將自動清空）如下圖所示：

 

　　參考資料

　　　　ASP.NET Core 中的會話和應用狀態

　　　　Redis可視化管理

 　　　   分布式緩存在 ASP.NET Core 中