Asp.net Core中使用Session

前言

      2017年就這麼悄無聲息的開始了，2017年對我來說又是特別重要的一年。

      元旦放假在家寫了個Asp.net Core驗證碼登錄， 做demo的過程中遇到兩個小問題，第一是在Asp.net Core中引用dll，以往我們引用DLL都是直接引用，在Core里這樣是不行的，必須基於NuGet添加，或者基於project.json添加，然後保存VS會啟動還原類庫。

第二就是使用Session的問題，Core里使用Session需要添加Session類庫。

添加Session

     在你的項目上基於NuGet添加：Microsoft.AspNetCore.Session。

修改startup.cs

    在startup.cs找到方法ConfigureServices(IServiceCollection services) 註入Session(這個地方是Asp.net Core pipeline):services.AddSession();

    接下來我們要告訴Asp.net Core使用記憶體存儲Session數據，在Configure(IApplicationBuilder app,...)中添加代碼:app.UserSession();

Session

1、在MVC Controller里使用HttpContext.Session

using Microsoft.AspNetCore.Http;

public class HomeController:Controller
{
      public IActionResult Index()
      {
              HttpContext.Session.SetString("code","123456");
              return View();  
       }

       public IActionResult About()
       {
              ViewBag.Code=HttpContext.Session.GetString("code");
              return View();
        }
}

2、如果不是在Controller里，你可以註入IHttpContextAccessor

public class SomeOtherClass
{
      private readonly IHttpContextAccessor _httpContextAccessor;
      private ISession _session=> _httpContextAccessor.HttpContext.Session;

      public SomeOtherClass(IHttpContextAccessor httpContextAccessor)
     {
           _httpContextAccessor=httpContextAccessor;              
     }

     public void Set()
     {
          _session.SetString("code","123456");
     }
    
     public void Get()
    {
         string code = _session.GetString("code");
     }
}

存儲複雜對象

      存儲對象時把對象序列化成一個json字元串存儲。

public static class SessionExtensions
{
      public static void SetObjectAsJson(this ISession session, string key, object value)
    {
        session.SetString(key, JsonConvert.SerializeObject(value));
    }

    public static T GetObjectFromJson<T>(this ISession session, string key)
    {
        var value = session.GetString(key);

        return value == null ? default(T) : JsonConvert.DeserializeObject<T>(value);
    }
}

var myComplexObject = new MyClass();
HttpContext.Session.SetObjectAsJson("Test", myComplexObject);


var myComplexObject = HttpContext.Session.GetObjectFromJson<MyClass>("Test");

使用SQL Server或Redis存儲

1、SQL Server

添加引用  "Microsoft.Extensions.Caching.SqlServer": "1.0.0"

註入：

// Microsoft SQL Server implementation of IDistributedCache.
// Note that this would require setting up the session state database.
services.AddSqlServerCache(o =>
{
    o.ConnectionString = "Server=.;Database=ASPNET5SessionState;Trusted_Connection=True;";
    o.SchemaName = "dbo";
    o.TableName = "Sessions";
});

2、Redis

添加引用   "Microsoft.Extensions.Caching.Redis": "1.0.0"

註入：

// Redis implementation of IDistributedCache.
// This will override any previously registered IDistributedCache service.
services.AddSingleton<IDistributedCache, RedisCache>();

 參考

http://benjii.me/2016/07/using-sessions-and-httpcontext-in-aspnetcore-and-mvc-core/