如何在ASP.NET Core中使用Session的示例代碼

Posted on by

ASP.NET Core 是一個跨平臺，開源的，輕量級，高性能 並且 高度模塊化的web框架，Session 可以實現用戶信息存儲從而可以在同一個客戶端的多次請求之間實現用戶追蹤，在 ASP.Net Core 中可以使用 Microsoft.AspNetCore.Session 中間件來啟用 Session 機制。

中間件的價值在於可以在 request -> response 的過程中做一些定制化的操作，比如說：監視數據，切換路由，修改流轉過程中的消息體，通常來說：中間件是以鏈式的方式灌入到 ASP.Net Core 的 pipeline 管道中，這篇文章主要討論如何使用 Session 中間件。

安裝 Session 中間件

要想使用 session 中間件，你可以使用 Visual Studio 2019 中的 NuGet package manager 可視化界面進行安裝，或者通過 NuGet package manager console 命令行輸入如下命令：

Install-Package Microsoft.AspNetCore.Session

配置 session 中間件

現在 Microsoft.AspNetCore.Session 已經成功安裝到你的項目中瞭，接下來可以將它添加到 ASP.Net Core pipeline 中，請註意：為瞭能夠啟動 Session，你必須要使用一個 實現瞭 IDistributedCache 接口的 cache store 來作為 session 的底層存儲，然後你還要在 ConfigureServices 方法下調用 AddSession 方法將其塞入 IOC 容器，最後在 Startup.Configure 方法下使用 UseSession 將其塞入到 request -> response 請求管道中，具體代碼如下：

  public void ConfigureServices(IServiceCollection services)
  {
    services.AddDistributedMemoryCache();
    services.AddSession(options =>
    {
      options.IdleTimeout = TimeSpan.FromSeconds(5);
      options.Cookie.HttpOnly = true;
      options.Cookie.IsEssential = true;
    });
    services.AddMvc()
      .SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
  }

一旦 session 中間件加入到瞭 IOC 容器之後，接下來可以在 Configure 方法中調用 UseSession 來啟動 session。

  public void Configure(IApplicationBuilder app, IHostingEnvironment env)
  {
    app.UseHttpsRedirection();
    app.UseStaticFiles();
    app.UseSession();
    app.UseHttpContextItemsMiddleware();
    app.UseMvc();
  }

存儲和獲取 session

你可以使用 Set, SetInt32 和 SetString 這三個方法來實現 Session 的存儲，這些方法有兩個參數，一個是鍵，一個是鍵對應的數據，而且 Set 方法的 value 對應的是 byte[] 形式。

類似的，你可以使用 Get,GetInt32 和 GetString 方法來實現 session 的讀取，同時 Get 方法接收一個 string 格式的 key，並且返回 byte[] 數組，要使用這些擴展方法，你需要將 Microsoft.AspNetCore.Http 引用到項目中。

下面的代碼展示瞭如何將數據添加到 session 中。

public IActionResult Index()
{
  HttpContext.Session.SetString("Message", "Hello World!");
  HttpContext.Session.SetInt32("Year", 2019);
  return View();
}

接下來再看看如何從 session 中獲取數據，如下代碼所示：

public IActionResult About()
{
  ViewBag.Message = HttpContext.Session.GetString("Message");
  ViewBag.Year = HttpContext.Session.GetInt32("Year");
  return View();
}

如果你想設置或者獲取屬於其他類型的數據，可以在 ISession 接口上新增一個擴展方法並且自己來實現序列化邏輯，從 session 中設置或者獲取 復雜類型時，可以把這個類型序列化為 json，或者 json 反序列化為 model。

還有一點要特別註意，默認的 session 是基於內存的，也就是說進程關閉瞭 session 就會丟失，如果你想實現session持久化，可以采用 sqlserver 或者 redis。

譯文鏈接：https://www.infoworld.com/article/3411563/how-to-work-with-session-state-in-aspnet-core.html

到此這篇關於如何在ASP.NET Core中使用Session的示例代碼的文章就介紹到這瞭,更多相關ASP.NET Core使用Session內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：