[asp.net core 源碼分析] 01 - Session

1、Session文檔介紹 2、Session簡單應用 2.1、在Startup類的ConfigureServices方法中添加因為Session的服務端存儲需要緩存，所以需要引入.Net core的緩存DistributedMemoryCache； 2.2、在Startup類的Configure ...

1、Session文檔介紹

毋庸置疑學習.Net core最好的方法之一就是學習微軟.Net core的官方文檔；https://docs.microsoft.com/zh-cn/aspnet/core；
.Net core Session的官方文檔 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/app-state
.Net core Session Github源碼 https://github.com/aspnet/Session

2、Session簡單應用

2.1、在Startup類的ConfigureServices方法中添加

services.AddDistributedMemoryCache();
services.AddSession();

因為Session的服務端存儲需要緩存，所以需要引入.Net core的緩存DistributedMemoryCache；

2.2、在Startup類的Configure方法中添加

app.UseSession();

2.3、使用（存儲和獲取）

// 存儲
HttpContext.Session.Set("LoginId", System.Text.Encoding.Default.GetBytes("666"));

// 獲取
HttpContext.Session.TryGetValue("LoginId", out byte[] byteLoginId);
var loginId = System.Text.Encoding.Default.GetString(byteLoginId); // LoginId="666";

3、源碼分析圖

4、源碼分析

4.1、程式載入

4.1.1、在ConfigureServices中添加分散式緩存，services.AddDistributedMemoryCache()；

微軟官方建議使用AddDistributedMemoryCache，當然也可以使用AddMemoryCache、AddDistributedRedisCache、AddDistributedSqlServerCache或者自定義緩存也是可以的；

如果是分散式系統或者SSO單點登錄，建議使用分散式的緩存，不要使用AddMemoryCache；

緩存的官方文檔 https://docs.microsoft.com/zh-cn/aspnet/core/performance/caching/memory

4.1.2、在ConfigureServices中添加AddSession；

 1 public static IServiceCollection AddSession(this IServiceCollection services)
 2 {
 3     if (services == null)
 4     {
 5         throw new ArgumentNullException(nameof(services));
 6     }
 7 
 8     services.AddTransient<ISessionStore, DistributedSessionStore>();
 9     services.AddDataProtection();
10     return services;
11 }
12  
13 public static IServiceCollection AddSession(this IServiceCollection services, Action<SessionOptions> configure)
14 {
15     if (services == null)
16     {
17         throw new ArgumentNullException(nameof(services));
18     }
19 
20     if (configure == null)
21     {
22         throw new ArgumentNullException(nameof(configure));
23     }
24 
25     services.Configure(configure);
26     services.AddSession();
27 
28     return services;
29 }

View Code

AddSession為IServiceCollection的擴展方法，有1個重載（傳入Session的設置，使用services.Configure(configure)，載入設置）；

services.AddDataProtection()註入數據加密解密DataProtection()，在加密解密SessionKey時使用；

services.AddTransient<ISessionStore, DistributedSessionStore>();註入DistributedSessionStore，其中的Create 方法用做創建Session，調用Create方法時執行new DistributedSession(); DistributedSession類中包含了對IDictionary<EncodedKey, byte[]>的增刪改查；

4.1.3、在Configure中UseSession

 1 public static IApplicationBuilder UseSession(this IApplicationBuilder app)
 2 {
 3     if (app == null)
 4     {
 5         throw new ArgumentNullException(nameof(app));
 6     }
 7 
 8     return app.UseMiddleware<SessionMiddleware>();
 9 }
10 
11 
12 public static IApplicationBuilder UseSession(this IApplicationBuilder app, SessionOptions options)
13 {
14     if (app == null)
15     {
16         throw new ArgumentNullException(nameof(app));
17     }
18     if (options == null)
19     {
20         throw new ArgumentNullException(nameof(options));
21     }
22 
23     return app.UseMiddleware<SessionMiddleware>(Options.Create(options));
24 }

View Code

UseSession為IApplicationBuilder的擴展方法，也有1個重載，同樣也是載入Session的設置，使用Options.Create(options)結合中間件載入設置；

關於中間件可以參考文檔 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware

SessionMiddleware.cs為Session的中間件；其中包含Session的核心代碼，操作MVC之前和之後的代碼都在中間件中；

4.2、SessionMiddleware.cs類解析

在SessionMiddleware中一個非同步方法Invoke；主要邏輯中包含了註釋，應該很好理解；

 1   /// <summary>
 2         /// Invokes the logic of the middleware.
 3         /// </summary>
 4         /// <param name="context">The <see cref="HttpContext"/>.</param>
 5         /// <returns>A <see cref="Task"/> that completes when the middleware has completed processing.</returns>
 6         public async Task Invoke(HttpContext context)
 7         {
 8             var isNewSessionKey = false;
 9             Func<bool> tryEstablishSession = ReturnTrue;
10             var cookieValue = context.Request.Cookies[_options.Cookie.Name];
11 
12             // 解密cookieValue
13             var sessionKey = CookieProtection.Unprotect(_dataProtector, cookieValue, _logger);
14             if (string.IsNullOrWhiteSpace(sessionKey) || sessionKey.Length != SessionKeyLength)
15             {
16 
17                 // 生成36位隨機數
18                 var guidBytes = new byte[16];
19                 CryptoRandom.GetBytes(guidBytes);
20                 sessionKey = new Guid(guidBytes).ToString();
21 
22                 // 加密cookieValue
23                 cookieValue = CookieProtection.Protect(_dataProtector, sessionKey);
24 
25                 // 設置Cookie
26                 var establisher = new SessionEstablisher(context, cookieValue, _options);
27                 tryEstablishSession = establisher.TryEstablishSession;
28                 isNewSessionKey = true;
29             }
30 
31             var feature = new SessionFeature();
32             // 創建Sessin放入 HttpContext Features
33             feature.Session = _sessionStore.Create(sessionKey, _options.IdleTimeout, _options.IOTimeout, tryEstablishSession, isNewSessionKey);
34             context.Features.Set<ISessionFeature>(feature);
35 
36             try
37             {
38                 // 執行邏輯（MVC）之間
39                 await _next(context);
40                 // 執行邏輯（MVC）之後
41             }
42             finally
43             {
44                 // 設置HttpContext Features為空
45                 context.Features.Set<ISessionFeature>(null);
46 
47                 if (feature.Session != null)
48                 {
49                     try
50                     {
51                         // Commit Session，把 IDictionary<EncodedKey, byte[]>中的值放入緩存
52                         await feature.Session.CommitAsync(context.RequestAborted);
53                     }
54                     catch (OperationCanceledException)
55                     {
56                         _logger.SessionCommitCanceled();
57                     }
58                     catch (Exception ex)
59                     {
60                         _logger.ErrorClosingTheSession(ex);
61                     }
62                 }
63             }
64         }

View Code

4.3、DistributedSession.cs 類解析

在SessionMiddleware Invoke方法中，可以看到創建Session最終執行的是new DistributedSession();

此類就不做過多的介紹了，主要就是對IDictionary<EncodedKey, byte[]>增刪改查，序列化值、從緩存中Load數據和把數據放入緩存中；

代碼過多就不放置博客上，可移至github ：https://github.com/aspnet/Session/blob/master/src/Microsoft.AspNetCore.Session/DistributedSession.cs

5、總結

1、在asp.net core中Session的代碼還是比較簡單的，運用操作也比較簡單；

2、可以清楚的理解asp.net core中Session的原理；

3、可以學習其他生產隨機數的方法；

4、可以學習在中間件中怎麼運用設置（Options.Create(options)、services.Configure(configure)）；

5、知道了中間件的簡單運用；

6、學寫了Httpcontext Features 的簡單運用，關於 HttpContext可以直接使用Session（HttpContext.Session）在講asp.net core http時會詳細介紹；

7、簡單知道了對於緩存的獲取和增加；

8、下一篇將分析 .net core configuration，敬請關註；

9、記得推薦評論，或者可以留言希望分析哪部分asp.net core的源碼