Redis简单案例 Session的管理

Posted 2020-08-13

　　负载均衡，这应该是一个永恒的话题，也是一个十分重要的话题。毕竟当网站成长到一定程度，访问量自然也是会跟着增长，这个时候，

一般都会对其进行负载均衡等相应的调整。现如今最常见的应该就是使用nginx来进行处理了吧。当然Jexus也可以达到一样的效果。既然是

负载均衡，那就势必有多台服务器，如果不对session进行处理，那么就会造成Session丢失的情况。有个高大上的名字叫做分布式Session。

　　举个通俗易懂的例子，假设现在有3台服务器做了负载，用户在登陆的时候是在a服务器上进行的，此时的session是写在a服务器上的，那

么b和c两台服务器是不存在这个session的，当这个用户进行了一个操作是在b或c进行处理的，而且这个操作是要登录后才可以的，那么就会

提示用户重新登陆。这样显然就是很不友好，造成的用户体验可想而知。

　　背景交待完毕，简单的实践一下。

相关技术	说明
ASP.NET Core	演示的两个站点所用的技术
Redis	用做Session服务器
Nginx/Jexus	用做反向代理服务器，演示主要用了Nginx，最后也介绍了Jexus的用法
IIS/Jexus	用做应用服务器，演示用了本地的IIS，想用Jexus来部署可参考前面的相关文章

　　先来看看不进行Session处理的做法，看看Session丢失的情况，然后再在其基础上进行改善。

　　在ASP.NET Core中，要使用session需要在Startup中的ConfigureServices添加 services.AddSession();  以及在Configure中添加

 app.UseSession(); 才能使用。在控制器中的用法就是 HttpContext.Session.XXX ，下面是演示控制器的具体代码：

 1  　　　　[HttpGet("/")]
 2         [ResponseCache(NoStore =true)]
 3         public IActionResult Index()
 4         {
 5             ViewBag.Site = "site 1";
 6             return View();
 7         }
 8         [HttpPost("/")]
 9         public IActionResult Index(string sessionName,string sessionValue)
10         {
11             //set the session            
12      　　　　HttpContext.Session.Set(sessionName,System.Text.Encoding.UTF8.GetBytes(sessionValue));
13             return Redirect("/about?sessionName="+sessionName);
14         }
15 
16         [HttpGet("/about")]
17         [ResponseCache(NoStore = true)]
18         public IActionResult About(string sessionName)
19         {
20             byte[] bytes;            
21             ViewBag.Site = "site 1";
22             //get the session
23             if (HttpContext.Session.TryGetValue(sessionName, out bytes))
24             {
25                 ViewBag.Session = System.Text.Encoding.UTF8.GetString(bytes);
26             }
27             else
28             {
29                 ViewBag.Session = "empty";
30             }
31             return View();
32         }

　　其中的ViewBag.Site是用来标识当前访问的是那个负载的站点。这用就不用去查日记访问了那个站点了，直接在页面上就能看到了。从

Session的用法也看出了与之前的有所不同，Session的值是用byte存储的。我们可以写个扩展方法把它封装一下，这样就方便我们直接向之

前一样的写法，不用每次都转成byte再进行读写了。

　　视图比较简单，一个写Session，一个读Session。Index.cshtml用于填写Session的信息，提交后跳转到About.cshtml。

 1 @{
 2     ViewData["Title"] = "Home Page";
 3 }
 4 <div class="row">
 5     <div class="col-md-6">
 6         <form method="post" action="/">
 7             <div class="form-group">
 8                 <label>session name</label>
 9                 <input type="text" name="sessionName" />
10             </div>
11             <div class="form-group">
12                 <label>session value</label>
13                 <input type="text" name="sessionValue" />
14             </div>
15             <button type="submit">set session</button>
16         </form>
17     </div>
18 </div>
19 <div class="row">
20     <div class="col-md-6">
21         <p>
22             site: @ViewBag.Site
23         </p>
24     </div>
25 </div>

Index.cshtml 

1 @{
2     ViewData["Title"] = "About";
3 }
4 <p>@ViewBag.Session </p>
5 <p>site:@ViewBag.Site</p>

About.cshtml

　　到这里，我们是已经把我们要的“网站”给开发好了，下面是把这个“网站”部署到IIS上面。我们要在IIS上部署两个站点，这两个站点用于

我们负载均衡的使用。两个站点的区分就是ViewBag.Site，一个显示site1，一个显示site2。ASP.NET Core在IIS上部署可能不会太顺畅，

这时可以参考dotNET Core的文档，至于为什么没有放到Linux下呢，毕竟是台老电脑了，开多个虚拟机电脑吃不消，云服务器又还没想好要

租那家的，所以只好放到本地的IIS上来演示了，想在Linux下部署ASP.NET Core可以参考我前面的博文，也是很简单的喔。

　　这是部署到本地IIS上面的两个站点，site1和site2。

　　

　　站点我们是已经部署OK了，还是要先检查一下这两个站点是否能正常访问。如果这两个不能正常访问，那么我们下面的都是。。。

　　

　　OK!能正常访问，接下来就是今天下一个主角Nginx登场的时候了。用法很简单，下面给出主要的配置，主要的模块是upstream，这个是

Nginx的负载均衡模块，更多的细节可以去它的官网看一下。这里就不做详细的介绍，毕竟这些配置都十分的简单。　　

 　　Nginx的配置也配好了，接下来就是启动我们的Nginx服务器，执行 /usr/local/nginx/sbin/nginx 即可，最后就是访问我们Nginx这个

空壳站点http://192.168.198.128:8033(实际是访问我们在IIS上的那2个站点)，然后就可以看看效果了，建议把浏览器的缓存禁用掉，不然

轮询的效果可能会出不来。

　　

　　可以看到轮询的效果已经出来了，访问Linux下面的Nginx服务器，实际上是访问IIS上的site1和site2。我们是在站点2 设置了session，

但是在站点2却得不到这个session值，而是在站点1才能得到这个值。这是因为我们用的算法是Nginx默认的轮询算法，也就是说它是一直这样

循环访问我们的站点1和站点2，站点1->站点2 ->站点1->站点2....，演示是在站点2设置Session并提交，但它是提交到了站点1去执行，执行

完成后Redirect到了站点2，所以会看到站点2上没有session的信息而站点1上面有。

　　好了，警报提醒，Session丢失了，接下来我们就要想办法处理了这个常见并且棘手的问题了， 本文的处理方法是用Redis做一台单独的

Session服务器，用这台服务器来统一管理我们的Session，当然这台Redis服务器会做相应的持久化配置以及主从或Cluster集群，毕竟没人能

保证这台服务器不出故障。思路图如下：

 

　　思路有了，下面就是把思路用代码实现。

　　在上面例子的基础上，添加一个RedisSession类，用于处理Session,让其继承ISession接口　　

 1 using Microsoft.AspNetCore.Http;
 2 using System;
 3 using System.Collections.Generic;
 4 using System.Threading.Tasks;
 5 
 6 namespace AutoCompleteDemo.Common
 7 {
 8     public class RedisSession : ISession
 9     {
10         private IRedis _redis;
11         public RedisSession(IRedis redis)
12         {
13             _redis = redis;
14         }
15 
16         public string Id
17         {
18             get
19             {
20                 return Guid.NewGuid().ToString();                 
21             }
22         }
23 
24         public bool IsAvailable
25         {
26             get
27             {
28                 throw new NotImplementedException();
29             }
30         }
31 
32         public IEnumerable<string> Keys
33         {
34             get
35             {
36                 throw new NotImplementedException();
37             }
38         }      
39 
40         public void Clear()
41         {
42             throw new NotImplementedException();
43         }
44 
45         public Task CommitAsync()
46         {
47             throw new NotImplementedException();
48         }
49 
50         public Task LoadAsync()
51         {
52             throw new NotImplementedException();
53         }
54 
55         public void Remove(string key)
56         {
57             _redis.Del(key);
58         }
59 
60         public void Set(string key, byte[] value)
61         {
62             _redis.Set(key, System.Text.Encoding.UTF8.GetString(value),TimeSpan.FromSeconds(60));
63         }
64 
65         public bool TryGetValue(string key, out byte[] value)
66         {
67 
68             string res = _redis.Get(key);
69             if (string.IsNullOrWhiteSpace(res))
70             {
71                 value = null;
72                 return false;
73             }
74             else
75             { 
76                 value = System.Text.Encoding.UTF8.GetBytes(res);
77                 return true;
78             }
79         }        
80     }    
81 } 

　　ISession接口定义了不少东西，这里只实现了ISession中的部分内容，主要的Set和Get实现了，因为演示用不到那么多~~，就偷偷懒。Session

会有一个过期的时间，这里默认给了60秒，真正实践的时候可能要结合SessionOptions来进行修改这里的代码。前面也提到写个扩展方法，可以减少

调用的代码量和方便我们的使用，所以还写了一个对Session的扩展，方便在控制器中使用，这样就不用每次都把要存的东西再处理成byte。

 1     public static class SessionExtension
 2     {
 3         public static string GetExtension(this ISession session, string key)
 4         {
 5             string res = string.Empty;
 6             byte[] bytes;
 7             if (session.TryGetValue(key, out bytes))
 8             {
 9                 res = System.Text.Encoding.UTF8.GetString(bytes);
10             }
11             return res;           
12         }
13         public static void SetExtension(this ISession session, string key,string value)
14         {
15             session.Set(key, System.Text.Encoding.UTF8.GetBytes(value));            
16         }
17     } 　　

　　要使用刚才定义的RedisSession，还需要在Startup的ConfigureServices中添加下面这行代码。

 services.AddSingleton<ISession, RedisSession>();  

　　下面是修改之后控制器的代码：

 1 using AutoCompleteDemo.Common;
 2 using Microsoft.AspNetCore.Http;
 3 using Microsoft.AspNetCore.Mvc;
 4 
 5 namespace AutoCompleteDemo.Controllers
 6 {
 7     public class SessionController : Controller
 8     {
 9         private ISession _session;
10         public SessionController(ISession session)
11         {
12             _session = session;
13         }
14 
15         [HttpGet("/")]
16         [ResponseCache(NoStore =true)]
17         public IActionResult Index()
18         {
19             ViewBag.Site = "site 1";
20             return View();
21         }
22         [HttpPost("/")]
23         public IActionResult Index(string sessionName,string sessionValue)
24         {
25             //set the session
26             _session.SetExtension(sessionName, sessionValue);                       
27             return Redirect("/about?sessionName="+sessionName);
28         }
29 
30         [HttpGet("/about")]
31         [ResponseCache(NoStore = true)]
32         public IActionResult About(string sessionName)
33         {
34             //get the session
35             ViewBag.Session = _session.GetExtension(sessionName);                    
36             ViewBag.Site = "site 1";
37            return View();
38         }
39     }
40 }　　

　　通过构造函数注入我们的ISession。然后就能使用我们自己定义的方法了，这种做法在ASP.NET Core中是随处可见的。而且控制器中的代码

也整洁了不少。是直接用了自己写的扩展方法。

　　视图没有变化。Nginx的配置也没有变化。下面是对session进行一番简单处理后的效果。

 　　

 

　　可以看到无论在那个站点，都能正常的读取到session服务器里面的值。也就是说，经过简单的初步处理，我们的Session在负载均衡下面已经

不会丢失了。当然这个只能说是一个雏形，还有更多的细节要去完善。

　　文中讲到用Jexus也可以完成同样的功能，下面就简单说一下它的配置：

　　

　　这样就可以完成和上面演示中同样的功能。

　　当然，对于分布式Session的管理，这只是其中一种解决方法--基于Redis的解决方案，还有许多前人总结出来的方案，好比孤独侠客前辈的

这篇博客总结了6种方案：http://www.cnblogs.com/lonely7345/p/3796488.html，都是值得我们这些小辈去学习和研究的。