2. 程式人生 > >ASP.NET Core中介軟體實現分散式 Session

ASP.NET Core中介軟體實現分散式 Session

阿新 • • 發佈：2019-01-06

1.1. 中介軟體原理

1.1.1. 什麼是中介軟體

中介軟體是段程式碼用於處理請求和響應，通常多箇中間件連結起來形成管道，由每個中介軟體自己來決定是否要呼叫下一個中介軟體。

2017-10-10-21-47-00

1.1.2. 中介軟體執行過程

舉一個示例來演示中介軟體的執行過程（分別有三個中介軟體：日誌記錄、許可權驗證和路由）：當請求進入應用程式時，執行執行日誌記錄的中介軟體，它記錄請求屬性並呼叫鏈中的下一個中介軟體許可權驗證，如果許可權驗證通過則將控制權傳遞給下一個中介軟體，不通過則設定401 HTTP程式碼並返回響應，響應傳遞給日誌中介軟體進行返回。

2017-10-10-22-47-32

1.1.3. 中介軟體的配置

中介軟體配置主要是用Run

、Map和Use方法進行配置，三者的不同參見上篇ASP.NET Core 執行原理剖析；簡單的中介軟體可以直接使用匿名方法就可以搞定，如下程式碼：

app.Run(async (context,next) =>
        {
            await context.Response.WriteAsync("environment " + env);
            await next();
        });

如果想重用中介軟體，就需要單獨封裝到一個類中進行呼叫。

1.2. 依賴注入中介軟體

在實際專案中，中介軟體往往需要呼叫其它物件的方法。所以要建立物件之間的依賴,由於ASP.NET Core 內建的依賴注入系統，寫程式的時候可以建立更優雅的程式碼。

首先需要要在IOC容器中註冊類，就是Startup類中的ConfigureServices方法中進行註冊，ConfigureServices方法會在Configure方法之前被執行。以便在用中介軟體時所有依賴都準備好了。

現在有一個Greeter類：

public class Greeter : IGreeter
{
    public string Greet()
    {
        return "Hello from Greeter!";
    }
}

public interface IGreeter
{
    string Greet();
}

第一步在ConfigureServices

方法中進行註冊


public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient<IGreeter, Greeter>();
}

筆者這裡使用的是AddTransient進行註冊，該方法在每次請求時建立該類的新例項。可以選擇其它方法：AddSingleton，AddScoped或簡單的Add（所有在幕後前使用）。整個DI系統在官方文件中有所描述。

在註冊了依賴項後，就可以使用它們了。IApplicationBuilder例項允許在Configure方法中有一個RequestServices屬性用於獲取Greeter例項。由於已經註冊了這個IGreeter介面，所以不需要將中介軟體與具體的Greeter實現相結合。


app.Use(async (ctx, next) =>
    {
        IGreeter greeter = ctx.RequestServices.GetService<IGreeter>();
        await ctx.Response.WriteAsync(greeter.Greet());
        await next();
    });

如果Greeter類有一個引數化的建構函式，它的依賴關係也必須在其中註冊ConfigureServices。

中介軟體可以很容易解決依賴關係。可以向中介軟體建構函式新增其他引數：


public class MyMiddleware
{
    private readonly RequestDelegate _next;
    private readonly IGreeter _greeter;

    public MyMiddleware(RequestDelegate next, IGreeter greeter)
    {
        _next = next;
        greeter = greeter;
    }

    public async Task Invoke(HttpContext context)
    {
        await context.Response.WriteAsync(_greeter.Greet());
        await _next(context);
    }
}

或者，可以將此依賴關係新增到Invoke方法中：


public async Task Invoke(HttpContext context, IGreeter greeter)
{
    await context.Response.WriteAsync(greeter.Greet());
    await _next(context);
}

如果DI系統知道這些引數的型別，則在類被例項化時，它們將被自動解析。很簡單！

1.3. Cookies和session中介軟體

1.3.1. Session

HTTP是一個無狀態協議，Web伺服器將每一個請求都視為獨立請求。並且不儲存之前請求中使用者的值。

Session 狀態是ASP.NET Core提供的一個功能，它可以在使用者通應用訪問網路伺服器的時候儲存和儲存使用者資料。由伺服器上的字典和散列表組成，Session狀態通過瀏覽器的請求中得到，Session的資料儲存到快取中。

ASP.NET Core通過包含Session ID的Cookie來維護會話狀態，每個請求都會攜帶此Session ID。

在Microsoft.AspNetCore.Session包中提供的中介軟體用來管理Session狀態。要啟用Session中介軟體，Startup類裡面需要做以下幾個操作：

  • 使用任何一個實現了IDistributedCache介面的服務來啟用記憶體快取，
  • 設定AddSession回撥，由於AddSession是在Microsoft.AspNetCore.Session包內實現的，所以必須在Nuget中新增Microsoft.AspNetCore.Session包
  • UseSession回撥

具體示例程式碼如下：


using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using System;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();

        // 新增一個記憶體快取
        services.AddDistributedMemoryCache();

        services.AddSession(options =>
        {
            // 設定10秒鐘Session過期來測試
            options.IdleTimeout = TimeSpan.FromSeconds(10);
            options.Cookie.HttpOnly = true;
        });
    }

    public void Configure(IApplicationBuilder app)
    {
        app.UseSession();
        app.UseMvcWithDefaultRoute();
    }
}

上面程式碼中IdleTimeout屬性用來確定使用者多久沒有操作時丟棄Session。此屬性和Cookie超時無關，通過Session中介軟體的每個請求都會重置超時時間。

1.3.2. Session儲存到Redis中

實現分散式Session方法官方提供有Redis、Sql Server等。但是Sql Server效率對於這種以key/value獲取值的方式遠遠不及Redis效率高，所以這裡筆者選用Redis來作示例實現分散式Session。

準備Redis

由於目前Redis還不支援windows，所以大家在安裝Redis的時候準備一臺linux作業系統，筆者這裡的系統是ubuntu 16.04；下載及安裝方式可以參考官方示例。

安裝成功以後啟動Redis 服務，如果看到以下資訊，就代表Redis啟動成功：

2017-10-30-20-33-47

相關配置

首先需要用Nuget安裝包Microsoft.Extensions.Caching.Redis，安裝成功以後就可以在app.csproj檔案中可以看到。

2017-10-30-20-12-20

在Configure方法中新增app.UseSession()；然後再ConfigureServices新增Redis服務


public void ConfigureServices(IServiceCollection services){
    services.AddDistributedRedisCache(options=>{
        options.Configuration="127.0.0.1"; //多個redis伺服器：{RedisIP}:{Redis埠},{RedisIP}:{Redis埠}
        options.InstanceName="sampleInstance";
    });
    services.AddMvc();
    services.AddSession();
}

以上程式碼中筆者只用一個Redis伺服器來作測試，實際專案中需要多個Redis伺服器；配置方法如：options.Configuration="地址1:埠,地址2:埠";，這裡筆者並沒有給埠而是用的預設埠6379

完整程式碼

Startup.cs


using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Caching.Redis;
using Microsoft.Extensions.Caching.Distributed;

namespace app{    
    public class Startup{        
        public Startup(IConfiguration configuration)        
        {            
            Configuration = configuration;        
        }
        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services){                     
            services.AddDistributedRedisCache(options =>{                
                options.Configuration = "127.0.0.1";                
                options.InstanceName = "sampleInstance";            
            });            
            services.AddMvc();            
            services.AddSession();        
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env){            
            if (env.IsDevelopment())
            {                
                app.UseDeveloperExceptionPage();            
            }            
            else            
            {                
                app.UseExceptionHandler("/Home/Error");            
            }
            app.UseSession();
            app.UseStaticFiles();
            app.UseMvc(routes =>{                
                routes.MapRoute(name: "default",template: "{controller=Home}/{action=Index}/{id?}");           
            });        
        }    
    }
}

HomeControler.cs


public class HomeController : Controller   
{        
    public IActionResult Index()       
    {            
        HttpContext.Session.Set("apptest",Encoding.UTF8.GetBytes("apptestvalue"));
        return View();        
    }
    public IActionResult ShowRedis()        
    {            
        byte[] temp;
        if(HttpContext.Session.TryGetValue("apptest",out temp))
        {                
            ViewData["Redis"]=Encoding.UTF8.GetString(temp);            
        }            
        return View();        
    }
}

Index頁面只做一件事給Session設定值："apptestvalue"，ShowRedis頁面顯示Session值。

ShowRedis.cshtml


Redis Session Value:ViewData["Redis"]

演示結果

現在開始執行頁面，首先直接進入到ShowRedis頁面，Session值顯示為空

2017-10-31-06-47-24

當點選SetSessionValue以後，再次回到ShowRedis頁面，Session就值顯示出來了

2017-10-31-23-56-58

看到apptestvalue代表Session值已經存到Redis裡面，怎樣證明apptestvalue值是從Redis裡面取到呢？接下來就證明給大家看。

1.3.3. 實現分佈Session

前面已經將Session儲存到Redis中，但是大家不清楚這個值是否是真的儲存到Redis裡面去了還是在專案記憶體中；所以這裡就實現在兩個不的應用程式（或兩臺不同的機器）中共享Session，也就是實現分散式Session，分散式即代表了不同的機器不同的應用程式，但往往有下面的一種尷尬的情況，就算是每個HTTP請求時都攜帶了相同的cookie值。

2017-10-30-20-35-19

造成這個的問題的原因是每個機器上面的ASP.NET Core的應用程式的金鑰是不一樣的，所以沒有辦法得到前一個應用程式儲存的Session資料;為了解決這個問題，.NET Core團隊為提供了Microsoft.AspNetCore.DataProtection.AzureStorage和Microsoft.AspNetCore.DataProtection.Redis包將金鑰儲存到Azure或Redis中。這裡選擇將金鑰儲存到Redis。

共享金鑰

利用Microsoft.AspNetCore.DataProtection.Redis包提供的PersistKeysToRedis過載方法將金鑰儲存到Redis裡面去。所以這裡需要在ConfigureServices方法中添AddDataProtection()


var redis = ConnectionMultiplexer.Connect("127.0.0.1:6379");
    services.AddDataProtection()
        .SetApplicationName("session_application_name")
        .PersistKeysToRedis(redis, "DataProtection-Keys");

下面演示怎樣實現分散式Session

配置步驟

  • 同時建立兩個專案，分別為app1和app2
  • 新增Microsoft.AspNetCore.DataProtection.Redis和StackExchange.Redis.StrongName包

2017-10-31-23-41-37

  • 由於在同一臺機器上，ASP.NET Core程式預設啟動的時候埠為5000，由於app1已經佔用了，所以將app2的啟埠設定為5001

2017-10-31-23-54-19

完整程式碼

  • app1專案

Startup.cs


using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Caching.Redis;
using Microsoft.Extensions.Caching.Distributed;

namespace app1{    
    public class Startup{        
        public Startup(IConfiguration configuration)        
        {            
            Configuration = configuration;        
        }
        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services){
            var redis = ConnectionMultiplexer.Connect("127.0.0.1:6379");
            services.AddDataProtection()
                .SetApplicationName("session_application_name")
                .PersistKeysToRedis(redis, "DataProtection-Keys");          
            services.AddDistributedRedisCache(options =>{                
                options.Configuration = "127.0.0.1";                
                options.InstanceName = "sampleInstance";            
            });            
            services.AddMvc();            
            services.AddSession();        
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env){            
            if (env.IsDevelopment())
            {                
                app.UseDeveloperExceptionPage();            
            }            
            else            
            {                
                app.UseExceptionHandler("/Home/Error");            
            }
            app.UseSession();
            app.UseStaticFiles();
            app.UseMvc(routes =>{                
                routes.MapRoute(name: "default",template: "{controller=Home}/{action=Index}/{id?}");           
            });        
        }    
    }
}

HomeControler.cs


public class HomeController : Controller   
{        
    public IActionResult Index()       
    {            
        HttpContext.Session.Set("app1test",Encoding.UTF8.GetBytes("app1testvalue"));
        return View();        
    }
    public IActionResult ShowRedis()        
    {            
        byte[] temp;
        if(HttpContext.Session.TryGetValue("app1test",out temp))
        {                
            ViewData["Redis"]=Encoding.UTF8.GetString(temp);            
        }            
        return View();        
    }
}

ShowRedis.cshtml


Redis Session Value:ViewData["Redis"]
  • app2專案

Startup.cs
配置同app1配置一樣。

HomeControler.cs


public class HomeController : Controller   
{        
    public IActionResult Index()       
    {            
        byte[] temp;
        if(HttpContext.Session.TryGetValue("app1test",out temp))
        {                
            ViewData["Redis"]=Encoding.UTF8.GetString(temp);            
        }  
        return View();        
    }
}

Index.cshtml


ViewData["Redis"]

執行效果

  • app1 專案

首次開啟進入ShowRedis頁面，Session值為空

2017-10-31-06-47-24

點選SetSessionValue以後，再回到ShowRedis頁面：

2017-11-01-00-04-13

2017-11-01-00-00-30

以上是用Redis實現分散式Session示例。

1.4. 總結

本節講解了中介軟體的執行原理及配置過程，中介軟體之間物件依賴關係的配置和平時專案中常用到Session的配置問題。並在實際程式碼展示了怎樣使用中介軟體實現分散式Session。

相關推薦

ASP.NET Core中介軟體實現分散式 Session

1.1. 中介軟體原理 1.1.1. 什麼是中介軟體 中介軟體是段程式碼用於處理請求和響應，通常多箇中間件連結起來形成管道，由每個中介軟體自己來決定是否要呼叫下一個中介軟體。 1.1.2. 中介軟體執行過程 舉一個示例來演示中介軟體的執行過程（

ASP.NET Core 中介軟體的幾種實現方式

前言 ASP.NET Core 中 HTTP 管道使用中介軟體組合處理的方式, 換句人話來說, 對於寫程式碼的人而言,一切皆中介軟體. 業務邏輯/資料訪問/等等一切都需要以中介軟體的方式來呈現. 那麼我們必須學會如何實現自定義中介軟體 這裡劃重點,必考 這裡我們介紹下中介軟體的幾種實現方式... 匿名函式 通

asp.net core 中介軟體應用

每個中介軟體擴充套件方法都通過 Microsoft.AspNetCore.Builder 名稱空間在 IApplicationBuilder 上公開。 中介軟體的執行方式 預設情況下，中介軟體的執行順序根據Startup.cs檔案中，在public void Configure(IApplicationB

（4）ASP.NET Core 中介軟體

1.前言 中介軟體（middleware）是一種裝配到應用管道以處理請求和響應的元件。每個元件：●可選擇是否將請求傳遞到管道中的下一個元件。●可在管道中的下一個元件前後執行工作。請求委託（request delegates）用於建立請求管道（request pipeline），請求委託處理每個HTTP請求。

ASP.NET Core中介軟體計算Http請求時間

ASP.NET Core通過RequestDelegate這個委託型別來定義中介軟體 public delegate Task RequestDelegate(HttpContext context); 可將一個單獨的請求委託並行指定為匿名方法（稱為並行中介軟體），或在類中對其進行定義。可通過Use，或在Mi

ASP.NET Core 中介軟體自定義全域性異常處理

## 目錄 - 背景 - ASP.NET Core過濾器(Filter) - ASP.NET Core 中介軟體(Middleware) - 自定義全域性異常處理 - .Net Core中使用ExceptionFilter - .Net Core中使用中介軟體 - 總結 - 參考 ## 背景

換個角度學習ASP.NET Core中介軟體

## 中介軟體真面目 關於ASP.NET Core中介軟體是啥，簡單一句話描述就是：用來處理HTTP請求和響應的一段邏輯，並且可以決定是否把請求傳遞到`管道`中的下一個中介軟體！ 上面只是概念上的一種文字描述，那問題來了，中介軟體在程式中到底是個啥:question: 一切還是從`IApplicatio

ASP.NET Core中介軟體與HttpModule有何不同

# 前言 在ASP.NET Core中最大的更改之一是對Http請求管道的更改，在ASP.NET中我們瞭解`HttpHandler`和`HttpModule`但是到現在這些已經被替換為`中介軟體`那麼下面我們來看一下他們的不同處。 # HttpHandler Handlers處理基於擴充套件的特定請求，

asp .net core 中介軟體

### 前言 對中介軟體的一個概況，在《重新整理.net core 計1400篇》系列後面會深入。 ### 正文 #### 什麼是中介軟體呢？ 其實中介軟體這個概念來源於分散式，當然這是一個狹隘的概念了，現在中介軟體概念就非常廣泛了。 ![](https://img2020.cnblogs.com/

ASP .Net Core 中介軟體的使用（一）：搭建靜態檔案伺服器/訪問指定檔案

前言 隨著Asp .Net Core的升級迭代，很多開發者都逐漸傾向於.net core開發。 .net core是一個跨平臺的應用程式，可以在windows、Linux、macOS系統上進行開發和部署，是一個體繫結構更精簡模組化框架。 生成WebUi和WebApi的統一使用場景； 整合新的客戶端框架和開發

ASP.NET Core 中介軟體的使用（二）：依賴注入的使用

寫在前面 上一篇大家已經粗略接觸瞭解到.NET Core中介軟體的使用：ASP .Net Core 中介軟體的使用（一）：搭建靜態檔案伺服器/訪問指定檔案， .NET Core框架中很多核心物件都是通過依賴注入的方式提供的，那什麼是依賴注入？ 這也是個老生常談的問題，到底依賴注入是什麼？ 為什麼要用它？ 初學

ASP.NET Core 中介軟體（Middleware)（一）

本文主要目標：記錄Middleware的執行原理流程，並繪製流程圖。 目錄結構： >1、執行環境 >2、Demo實踐 >3、原始碼追蹤 >4、AspnetCore內建middleware ![](https://img2020.cnblogs.com/blog/380359/202102/38035

窺探ASP.Net MVC底層原理 實現跨越Session的分散式TempData

1、問題的引出 我相信大家在專案中都使用過TempData，TempData是一個字典集合，一般用於兩個請求之間臨時快取資料或者頁面之間傳遞訊息。也都知道TempData是用Session來實現的，既然是用Session來實現的，那麼模式就是執行緒模式，這樣的Session是沒法用到分散式系統中的，那麼

asp.net mvc 用Redis實現分散式叢集共享Session

1、這兩天研究Redis搞分散式session問題，網上找的資料都是用ServiceStack.Redis來實現的，但是在做效能測試的時候發現最新的v4版本有限制每小時候最多請求6000次，因為官網開始商業化要收費了，好坑爹的說，還好我前期弄了個性能測試列子，不然上線以後

.Net Core中介軟體和過濾器實現錯誤日誌記錄

1.中介軟體的概念 ASP.NET Core的處理流程是一個管道，中介軟體是組裝到應用程式管道中用來處理請求和響應的元件。 每個中介軟體可以： 選擇是否將請求傳遞給管道中的下一個元件。 可以在呼叫管道中的下一個元件之前和之後執行業務邏輯。 　　中介軟體是一個請求委託（ 

[Asp.Net Core] - 使用 ViewComponents 實現分頁控件

world asi action span ring easyn eba orm clas 分頁控件（定義分頁參數） ~/ViewComponents/PaginationViewComponent.cs using HelloWorld.DataContext; u

ASP.NET Core 開源GitServer 實現自己的GitHub

date pes name spn isp des odin control validate ASP.NET Core 2.0 開源Git HTTP Server，實現類似 GitHub、GitLab。 GitHub：https://github.com/linezero

ASP.NET Core + Docker +Jenkins 實現持續集成

before hash net stuck 超時時間 ref shell 腳本 conf cut 1.新建一個ASP.NET Core MVC應用程序： 2.將其上傳到git: 3.建立Jenkins任務 （1）選擇“新建任務”，輸入任務名稱，選擇“自由風格項目”，然後

Asp.Net Core 2.0實現HttpResponse中繁切換

== sed 存儲 中文簡體 選擇 .net tin contains nts 隨筆背景：因為項目中有個簡單的功能是需要實現中文簡體到繁體的切換，數據庫中存儲的源數據都是中文簡體的，為了省事就想著通過HttpHeader的方式來控制Api返回對應的繁體數據。 實現方式：通過

Asp.Net Core 輕鬆學-實現跨平臺的自定義Json資料包

前言     在前後端分離的業務開發中，我們總是需要返回各種各樣的資料包格式，一個良好的 json 格式資料包是我們一貫奉行的原則，下面就利用 Json.Net 來做一個簡單具有跨平臺的序列化資料包實現類。 1. 應用 Json.Net 1.1 首先在專案中引用 NuGet　包 1