第十六节：Asp.Net Core中Session的使用、扩展、进程外Session

一. 简介

　　关于Session的原理可参照Asp.Net版本Session的文章，去查阅。

1. 普通用法

　(1).通过Nuget引入【Microsoft.AspNetCore.Http】程序集，Core Mvc中已经默认引入了,在哪使用using一下即可。

　(2).注入Session相关的服务。

　　A：在ConfigureService注册基于服务器内存的Session， services.AddDistributedMemoryCache(); services.AddSession(); 在Configure中进行启用Session，app.UseSession();

　   注：一定要在mvc前面进行注入，进程外Session的注入后面介绍。

　　B：如果项目中使用了CookiePolicyOptions，一定要将里面true改为false，如： options.CheckConsentNeeded = context => false; 或者配置Session的性质，options.Cookie.IsEssential = true;（表示cookie是必须的），否则chrome中拿不到Session值

　解释：这是个GDRP条例，让用户自己选择使用用cookie，详见 http://www.zhibin.org/archives/667 或 https://www.cnblogs.com/GuZhenYin/p/9154447.html

　　C：在控制器中通过 HttpContext.Session 来向Session中读写各种值。

注册和启用相关的代码：

  public void ConfigureServices(IServiceCollection services)
  {
             services.Configure<CookiePolicyOptions>(options =>
             {
                 // This lambda determines whether user consent for non-essential cookies is needed for a given request.
                 options.CheckConsentNeeded = context => false;       //改为false或者直接注释掉，上面的Session才能正常使用
                 options.MinimumSameSitePolicy = SameSiteMode.None;
             });
             //注册Session服务
             //基于内存的Session
             services.AddDistributedMemoryCache();
             //默认过期时间为20分钟，每次访问都会重置
             services.AddSession();

             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
   }
   public void Configure(IApplicationBuilder app, IHostingEnvironment env)
   {
             if (env.IsDevelopment())
             {
                 app.UseDeveloperExceptionPage();
             }
             else
             {
                 app.UseExceptionHandler("/Home/Error");
             }
             app.UseStaticFiles();
             app.UseCookiePolicy();
             //启用Session管道
             app.UseSession();

             app.UseMvc(routes =>
             {
                 routes.MapRoute(
                     name: "default",
                     template: "{controller=CoreSession}/{action=Index6}/{id?}");
             });
   }

测试代码：

       public IActionResult Index()
         {
             string userName = HttpContext.Session.GetString("userName");
             if (string.IsNullOrEmpty(userName))
             {
                 userName = "ypf";
                 HttpContext.Session.SetString("userName", userName);
             }
             var t1 = HttpContext.Session.GetString("userName");
             ViewBag.userName = userName;
             return View();
         }

         public IActionResult Index2()
         {
             string userName = HttpContext.Session.GetString("userName");
             ViewBag.userName = userName;
             return View();
         }

补充Session默认提供的方法：

2. 全局注册使用

(1).背景：通常便于管理，我们将Session进行全局统一注入，方便管理。

(2).步骤:

　　A: 在普通用法的前提下，在ConfigureService中进行统一对象的注册， services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

　　B：在控制器利用构造函数进行注入。

　　C：正常使用即可，案例详见项目的Index3和Index4

代码分享：

  public class CoreSessionController : Controller
     {
         private readonly IHttpContextAccessor httpContextAccessor;

         private ISession MySession => httpContextAccessor.HttpContext.Session;

         public CoreSessionController(IHttpContextAccessor httpContextAccessor)
         {
             this.httpContextAccessor = httpContextAccessor;
         }
         #region 02-测试统一注入的用法
         /// <summary>
         /// 下面是统一注入使用的写法
         /// </summary>
         /// <returns></returns>

         public IActionResult Index3()
         {
             string userName = MySession.GetString("userName");
             if (string.IsNullOrEmpty(userName))
             {
                 userName = "ypf";
                 MySession.SetString("userName", userName);
             }
             var t1 = MySession.GetString("userName");
             ViewBag.userName = userName;
             return View();
         }

         public IActionResult Index4()
         {
             string userName = MySession.GetString("userName");
             ViewBag.userName = userName;
             return View();
         }
         #endregion

     }

二. 高级

1. Session的扩展

(1).背景

　　我们发现系统默认提供的Session方法，仅能存储byte、string、int类型，很不灵活，我们想能存储任何对象，这个时候就需要我们自行扩展。 对SessionExtensions类进行扩展

(2).利用Newtonsoft.Json进行扩展

　　A. 扩展代码详见SessionExtensions中的Set和Get方法

　　B. 案例详见Index5

(3).利用protobuf-net进行扩展

　　A. 通过Nuget安装程序集【protobuf-net】，这是谷歌的一个程序集，序列化和反序列效率更高

　　B. 扩展代码详见SessionExtensions中的Set2和Get2方法, 如果写入的是个类，类名上要加 [ProtoContract]，属性上要加 [ProtoMember(1)] [ProtoMember(2)]等等， 如：UserInfor2

　　C. 案例详见Index6

扩展代码：

   public static class SessionExtensions
     {
         #region 01-利用Newtonsoft.Json进行扩展
         public static void Set<T>(this ISession session, string key, T value)
         {
             session.SetString(key, JsonConvert.SerializeObject(value));
         }

         public static T Get<T>(this ISession session, string key)
         {
             var value = session.GetString(key);
             return value == null ? default(T) : JsonConvert.DeserializeObject<T>(value);
         }
         #endregion

         #region 02-利用protobuf-net进行扩展
         public static void Set2<T>(this ISession session, string key, T value)
         {
             using (MemoryStream stream = new MemoryStream())
             {
                 Serializer.Serialize(stream, value);
                 byte[] byteArrary = stream.ToArray();
                 session.Set(key, byteArrary);
             }
         }

         public static T Get2<T>(this ISession session, string key)
         {
             byte[] byteArray = session.Get(key);
             if (byteArray == null)
             {
                 return default(T);
             }
             else
             {
                 using (MemoryStream stream = new MemoryStream(byteArray))
                 {
                     return Serializer.Deserialize<T>(stream);
                 }
             }
         }
         #endregion
     }

类代码：

  public class UserInfor1
     {
         public string id { get; set; }
         public string userName { get; set; }
     }
     [ProtoContract]
     public class UserInfor2
     {
         [ProtoMember()]
         public string id { get; set; }
         [ProtoMember()]
         public string userName { get; set; }

     }

测试代码：

   #region 03-测试Newtonsoft.Json进行扩展
         public IActionResult Index5()
         {
             UserInfor1 user = HttpContext.Session.Get<UserInfor1>("u1");
             if (user == null)
             {
                 user = new UserInfor1();
                 user.id = "";
                 user.userName = "Marren";
                 HttpContext.Session.Set<UserInfor1>("u1", user);
             }
             ViewBag.id = user.id;
             ViewBag.userName = user.userName;
             return View();
         }
         #endregion

         #region 04-测试protobuf-net进行扩展
         public IActionResult Index6()
         {
             UserInfor2 user = HttpContext.Session.Get2<UserInfor2>("u2");
             if (user == null)
             {
                 user = new UserInfor2();
                 user.id = "";
                 user.userName = "Marren";
                 HttpContext.Session.Set2<UserInfor2>("u2", user);
             }
             ViewBag.id = user.id;
             ViewBag.userName = user.userName;
             return View();
         }
         #endregion

2.Session的性质

(1). Session的过期时间(多次访问将会被重置，默认过期时间为20分钟)

　　如：options.IdleTimeout = TimeSpan.FromMinutes(120);

(2). 设置为true表示前端js等脚本无法读取cookie，防止了xss攻击(默认是true)

　　如：options.Cookie.HttpOnly = true;

(3). Cookie是必须的(默认是false),可以覆盖上面的cookie策略

　　如：options.Cookie.IsEssential = true;

3. 如何在普通类中使用Session对象？

(1).说明

　　再普通类中如何调用Session，大约有两种思路：以构造函数的注入进去，但是如果这个类不是过滤器，使用的时候就需要实例化，又需要传入对象进去，如CheckLogin类，很麻烦，所以建议用第二种方案，直接吧实例好的Session传入进去，直接使用即可，如CheckLogin2.

(2). 方案一

　　先统一注入， services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();，然后再在控制器中进行构造函数注入,但调用的时候还需要传入进去。

PS:过滤器中可以直接context.httpContext.Session来设置

(3). 方案二

　　直接把实例好的Session传进去

  public class CheckLogin2
     {
         private ISession MySession { get; set; }

         public CheckLogin2(ISession mySession)
         {
             MySession = mySession;
         }
         public bool isLogin()
         {
             string userName = MySession.GetString("userName");
             if (string.IsNullOrEmpty(userName))
             {
                 return false;
             }
             return true;
         }
     }

三. 进程外Session

 　　关于进程外Session的好处、解决了什么痛点问题，可以参考Asp.Net 中的进程外Session，去查阅。 （解决了IIS重启Session丢失的问题，解决了Session空间有限容易被挤爆的问题，但不能解决浏览器重启找不到Session的问题！）

　　特别说明：基于SQLServer或Redis数据的进程外Session 的数据库方面的配置和前面分布式缓存章节数据库的配置完全相同，去查阅。

1. 基于SQLServer

(1). 安装【Microsoft.Extensions.Caching.SqlServer】程序集，如果是Core MVC程序，自带的Microsoft.AspNetCore.App包里已经涵盖了该程序集，无需重复安装。

(2). 首先要有个目标数据库中(比如CacheDB数据库)，然后以管理员身份cmd运行下面指令，会创建一张名叫“AspNetCoreSession”表，相应的Session信息都存在于这张表中。

【dotnet sql-cache create "Server=localhost;User=sa;Password=123456;Database=CacheDB" dbo AspNetCoreSession】成功后会提示：Table and index were created successfully.

PS：补充表的结构和含义, 分别是键、值、到期时刻(有问题)、滑动过期时间、绝对过期时间。

(3). 将原先基于内存的Session代码( services.AddDistributedMemoryCache(); )替换成基于SqlServer的代码，如下：

             //01-基于内存的Session
             //services.AddDistributedMemoryCache();

             //02-基于SQLServer的Session
             services.AddDistributedSqlServerCache(options =>
             {
                 options.ConnectionString = Configuration["SqlSeverConnectionString"];
                 options.SchemaName = "dbo";
                 options.TableName = "AspNetCoreSession";
             });

 {
   "Logging": {
     "LogLevel": {
       "Default": "Warning"
     }
   },
   "AllowedHosts": "*",
   "SqlSeverConnectionString": "Server=localhost;User=sa;Password=123456;Database=CacheDB"
 }

(4). 其它的配置都不变，正常使用即可。

2. 基于Redis

(1). 安装【Microsoft.Extensions.Caching.StackExchangeRedis】程序集，Core MVC中这个也是不包含的。

(2). 下载Redis程序，打开redis-server.exe，启动Redis。

(3). 将原先基于内存的Session代码 ( services.AddDistributedMemoryCache(); ) 替换成基于Redis的代码，如下：

            //01-基于内存的Session
            //services.AddDistributedMemoryCache();

            //03-基于Redis的Session
            services.AddStackExchangeRedisCache(options =>
            {
                options.Configuration = "localhost";
                options.InstanceName = "SampleInstance";
            });

(4). 其它配置都不变，正常使用即可。

!

• 作       者 : Yaopengfei(姚鹏飞)
• 博客地址 : http://www.cnblogs.com/yaopengfei/
• 声     明1 : 本人才疏学浅，用郭德纲的话说“我是一个小学生”，如有错误，欢迎讨论，请勿谩骂^_^。
• 声     明2 : 原创博客请在转载时保留原文链接或在文章开头加上本人博客地址，否则保留追究法律责任的权利。