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

 1、Session文檔介紹

1. 毋庸置疑學習.Net core最好的方法之一就是學習微軟.Net core的官方文檔；https://docs.microsoft.com/zh-cn/aspnet/core；
2. .Net core Session的官方文檔 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/app-state
3. .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，當然也可以使用AddDistributedRedisCache、AddDistributedSqlServerCache或者自定義緩存也是可以的；

如果是分布式系統或者SSO單點登錄，建議使用分布式的緩存AddDistributedRedisCache，AddDistributedSqlServerCache；

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

4.1.2、在ConfigureServices中添加AddSession；

public static IServiceCollection AddSession(this IServiceCollection services)
{
    if (services == null)
    {
        throw new ArgumentNullException(nameof(services));
    }

    services.AddTransient<ISessionStore, DistributedSessionStore>();
    services.AddDataProtection();
    return services;
}
 
public static IServiceCollection AddSession(this IServiceCollection services, Action<SessionOptions> configure)
{
    if (services == null)
    {
        throw new ArgumentNullException(nameof(services));
    }

    if (configure == null)
    {
        throw new ArgumentNullException(nameof(configure));
    }

    services.Configure(configure);
    services.AddSession();

    return services;
}

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

public static IApplicationBuilder UseSession(this IApplicationBuilder app)
{
    if (app == null)
    {
        throw new ArgumentNullException(nameof(app));
    }

    return app.UseMiddleware<SessionMiddleware>();
}


public static IApplicationBuilder UseSession(this IApplicationBuilder app, SessionOptions options)
{
    if (app == null)
    {
        throw new ArgumentNullException(nameof(app));
    }
    if (options == null)
    {
        throw new ArgumentNullException(nameof(options));
    }

    return app.UseMiddleware<SessionMiddleware>(Options.Create(options));
}

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；主要邏輯中包含了注釋，應該很好理解；

  /// <summary>
        /// Invokes the logic of the middleware.
        /// </summary>
        /// <param name="context">The <see cref="HttpContext"/>.</param>
        /// <returns>A <see cref="Task"/> that completes when the middleware has completed processing.</returns>
        public async Task Invoke(HttpContext context)
        {
            var isNewSessionKey = false;
            Func<bool> tryEstablishSession = ReturnTrue;
            var cookieValue = context.Request.Cookies[_options.Cookie.Name];

            // 解密cookieValue
            var sessionKey = CookieProtection.Unprotect(_dataProtector, cookieValue, _logger);
            if (string.IsNullOrWhiteSpace(sessionKey) || sessionKey.Length != SessionKeyLength)
            {

                // 生成36位隨機數
                var guidBytes = new byte[16];
                CryptoRandom.GetBytes(guidBytes);
                sessionKey = new Guid(guidBytes).ToString();

                // 加密cookieValue
                cookieValue = CookieProtection.Protect(_dataProtector, sessionKey);

                // 設置Cookie
                var establisher = new SessionEstablisher(context, cookieValue, _options);
                tryEstablishSession = establisher.TryEstablishSession;
                isNewSessionKey = true;
            }

            var feature = new SessionFeature();
            // 創建Sessin放入 HttpContext Features
            feature.Session = _sessionStore.Create(sessionKey, _options.IdleTimeout, _options.IOTimeout, tryEstablishSession, isNewSessionKey);
            context.Features.Set<ISessionFeature>(feature);

            try
            {
                // 執行邏輯（MVC）之間
                await _next(context);
                // 執行邏輯（MVC）之后
            }
            finally
            {
                // 設置HttpContext Features為空
                context.Features.Set<ISessionFeature>(null);

                if (feature.Session != null)
                {
                    try
                    {
                        // Commit Session，把 IDictionary<EncodedKey, byte[]>中的值放入緩存
                        await feature.Session.CommitAsync(context.RequestAborted);
                    }
                    catch (OperationCanceledException)
                    {
                        _logger.SessionCommitCanceled();
                    }
                    catch (Exception ex)
                    {
                        _logger.ErrorClosingTheSession(ex);
                    }
                }
            }
        }

 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的源碼