淺談ASP.NET Core中間件實現(xiàn)分布式 Session
1.1. 中間件原理
1.1.1. 什么是中間件
中間件是段代碼用于處理請求和響應(yīng),通常多個中間件鏈接起來形成管道,由每個中間件自己來決定是否要調(diào)用下一個中間件。
1.1.2. 中間件執(zhí)行過程
舉一個示例來演示中間件的執(zhí)行過程(分別有三個中間件:日志記錄、權(quán)限驗證和路由):當請求進入應(yīng)用程序時,執(zhí)行執(zhí)行日志記錄的中間件,它記錄請求屬性并調(diào)用鏈中的下一個中間件權(quán)限驗證,如果權(quán)限驗證通過則將控制權(quán)傳遞給下一個中間件,不通過則設(shè)置401 HTTP代碼并返回響應(yīng),響應(yīng)傳遞給日志中間件進行返回。
1.1.3. 中間件的配置
中間件配置主要是用Run
、Map
和Use
方法進行配置;簡單的中間件可以直接使用匿名方法就可以搞定,如下代碼:
app.Run(async (context,next) => { await context.Response.WriteAsync("environment " + env); await next(); });
如果想重用中間件,就需要單獨封裝到一個類中進行調(diào)用。
1.2. 依賴注入中間件
在實際項目中,中間件往往需要調(diào)用其它對象的方法。所以要創(chuàng)建對象之間的依賴,由于ASP.NET Core 內(nèi)置的依賴注入系統(tǒng),寫程序的時候可以創(chuàng)建更優(yōu)雅的代碼。
首先需要要在IOC容器中注冊類,就是Startup
類中的ConfigureServices
方法中進行注冊,ConfigureServices
方法會在Configure
方法之前被執(zhí)行。以便在用中間件時所有依賴都準備好了。
現(xiàn)在有一個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進行注冊,該方法在每次請求時創(chuàng)建該類的新實例??梢赃x擇其它方法:AddSingleton,AddScoped或簡單的Add(所有在幕后前使用)。整個DI系統(tǒng)在官方文檔中有所描述。
在注冊了依賴項后,就可以使用它們了。IApplicationBuilder
實例允許在Configure
方法中有一個RequestServices
屬性用于獲取Greeter
實例。由于已經(jīng)注冊了這個IGreeter
接口,所以不需要將中間件與具體的Greeter
實現(xiàn)相結(jié)合。
app.Use(async (ctx, next) => { IGreeter greeter = ctx.RequestServices.GetService<IGreeter>(); await ctx.Response.WriteAsync(greeter.Greet()); await next(); });
如果Greeter
類有一個參數(shù)化的構(gòu)造函數(shù),它的依賴關(guān)系也必須在其中注冊ConfigureServices
。
中間件可以很容易解決依賴關(guān)系。可以向中間件構(gòu)造函數(shù)添加其他參數(shù):
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); } }
或者,可以將此依賴關(guān)系添加到Invoke方法中:
public async Task Invoke(HttpContext context, IGreeter greeter) { await context.Response.WriteAsync(greeter.Greet()); await _next(context); }
如果DI系統(tǒng)知道這些參數(shù)的類型,則在類被實例化時,它們將被自動解析。很簡單!
1.3. Cookies和session中間件
1.3.1. Session
HTTP是一個無狀態(tài)協(xié)議,Web服務(wù)器將每一個請求都視為獨立請求。并且不保存之前請求中用戶的值。
Session 狀態(tài)是ASP.NET Core提供的一個功能,它可以在用戶通應(yīng)用訪問網(wǎng)絡(luò)服務(wù)器的時候保存和存儲用戶數(shù)據(jù)。由服務(wù)器上的字典和散列表組成,Session狀態(tài)通過瀏覽器的請求中得到,Session的數(shù)據(jù)保存到緩存中。
ASP.NET Core通過包含Session ID的Cookie來維護會話狀態(tài),每個請求都會攜帶此Session ID。
在Microsoft.AspNetCore.Session
包中提供的中間件用來管理Session狀態(tài)。要啟用Session中間件,Startup類里面需要做以下幾個操作:
- 使用任何一個實現(xiàn)了IDistributedCache接口的服務(wù)來啟用內(nèi)存緩存,
- 設(shè)置AddSession回調(diào),由于AddSession是在Microsoft.AspNetCore.Session包內(nèi)實現(xiàn)的,所以必須在Nuget中添加Microsoft.AspNetCore.Session包
- UseSession回調(diào)
具體示例代碼如下:
using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.DependencyInjection; using System; public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddMvc(); // 添加一個內(nèi)存緩存 services.AddDistributedMemoryCache(); services.AddSession(options => { // 設(shè)置10秒鐘Session過期來測試 options.IdleTimeout = TimeSpan.FromSeconds(10); options.Cookie.HttpOnly = true; }); } public void Configure(IApplicationBuilder app) { app.UseSession(); app.UseMvcWithDefaultRoute(); } }
上面代碼中IdleTimeout
屬性用來確定用戶多久沒有操作時丟棄Session。此屬性和Cookie超時無關(guān),通過Session中間件的每個請求都會重置超時時間。
1.3.2. Session保存到Redis中
實現(xiàn)分布式Session方法官方提供有Redis、Sql Server等。但是Sql Server效率對于這種以key/value獲取值的方式遠遠不及Redis效率高,所以這里筆者選用Redis來作示例實現(xiàn)分布式Session。
準備Redis
由于目前Redis還不支持windows,所以大家在安裝Redis的時候準備一臺linux操作系統(tǒng),筆者這里的系統(tǒng)是ubuntu 16.04;下載及安裝方式可以參考官方示例。
安裝成功以后啟動Redis 服務(wù),如果看到以下信息,就代表Redis啟動成功:
相關(guān)配置
首先需要用Nuget安裝包Microsoft.Extensions.Caching.Redis,安裝成功以后就可以在app.csproj文件中可以看到。
在Configure方法中添加app.UseSession();然后再ConfigureServices添加Redis服務(wù)
public void ConfigureServices(IServiceCollection services){ services.AddDistributedRedisCache(options=>{ options.Configuration="127.0.0.1"; //多個redis服務(wù)器:{RedisIP}:{Redis端口},{RedisIP}:{Redis端口} options.InstanceName="sampleInstance"; }); services.AddMvc(); services.AddSession(); }
以上代碼中筆者只用一個Redis服務(wù)器來作測試,實際項目中需要多個Redis服務(wù)器;配置方法如: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設(shè)置值:"apptestvalue",ShowRedis頁面顯示Session值。
ShowRedis.cshtml
Redis Session Value:ViewData["Redis"]
演示結(jié)果
現(xiàn)在開始運行頁面,首先直接進入到ShowRedis頁面,Session值顯示為空
當點擊SetSessionValue以后,再次回到ShowRedis頁面,Session就值顯示出來了
看到apptestvalue代表Session值已經(jīng)存到Redis里面,怎樣證明apptestvalue值是從Redis里面取到呢?接下來就證明給大家看。
1.3.3. 實現(xiàn)分布Session
前面已經(jīng)將Session保存到Redis中,但是大家不清楚這個值是否是真的保存到Redis里面去了還是在項目內(nèi)存中;所以這里就實現(xiàn)在兩個不的應(yīng)用程序(或兩臺不同的機器)中共享Session,也就是實現(xiàn)分布式Session,分布式即代表了不同的機器不同的應(yīng)用程序,但往往有下面的一種尷尬的情況,就算是每個HTTP請求時都攜帶了相同的cookie值。
造成這個的問題的原因是每個機器上面的ASP.NET Core的應(yīng)用程序的密鑰是不一樣的,所以沒有辦法得到前一個應(yīng)用程序保存的Session數(shù)據(jù);為了解決這個問題,.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");
下面演示怎樣實現(xiàn)分布式Session
配置步驟
同時創(chuàng)建兩個項目,分別為app1和app2
添加Microsoft.AspNetCore.DataProtection.Redis
和StackExchange.Redis.StrongName包
由于在同一臺機器上,ASP.NET Core程序默認啟動的時候端口為5000,由于app1已經(jīng)占用了,所以將app2的啟端口設(shè)置為5001
完整代碼
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值為空
點擊SetSessionValue以后,再回到ShowRedis頁面:
app2項目,直接在瀏覽器訪問:http://localhost:5001
以上是用Redis實現(xiàn)分布式Session示例。
1.4. 總結(jié)
本節(jié)講解了中間件的運行原理及配置過程,中間件之間對象依賴關(guān)系的配置和平時項目中常用到Session的配置問題。并在實際代碼展示了怎樣使用中間件實現(xiàn)分布式Session。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
- 如何在ASP.NET Core中使用Session的示例代碼
- 如何解決asp.net負載均衡時Session共享的問題
- Asp.Net Core中基于Session的身份驗證的實現(xiàn)
- 解析Asp.net Core中使用Session的方法
- asp.net(C#)清除全部Session與單個Session的方法
- 詳解ASP.NET中Session的用法
- ASP.NET ASHX中獲得Session的方法
- ASP.NET將Session保存到數(shù)據(jù)庫中的方法
- asp.net session的使用與過期實例代碼
- Asp.net中判斷一個session是否合法的方法
- ASP.NET MVC在基控制器中處理Session
相關(guān)文章
asp.net(vb)實現(xiàn)金額轉(zhuǎn)換成大寫的函數(shù)
asp.net(vb)實現(xiàn)金額轉(zhuǎn)換成大寫的函數(shù)代碼,需要的朋友可以參考下。2011-10-10.NET?SkiaSharp?生成二維碼驗證碼及指定區(qū)域截取方法實現(xiàn)
這篇文章主要為大家介紹了.NET?SkiaSharp?生成二維碼驗證碼及指定區(qū)域截取方法實現(xiàn)詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-10-10