[asp.net core 源码分析] 01 - Session

时间:2022-09-09 16:53:12

1、Session文档介绍

  1. 毋庸置疑学习.Net core最好的方法之一就是学习微软.Net core的官方文档;https://docs.microsoft.com/zh-cn/aspnet/core
  2. .Net core Session的官方文档 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/app-state
  3. .Net core Session Github源码 https://github.com/aspnet/Session

2、Session简单应用

2.1、在Startup类的ConfigureServices方法中添加

services.AddDistributedMemoryCache();
services.AddSession();

因为Session的服务端存储需要缓存,所以需要引入.Net core的缓存DistributedMemoryCache;

2.2、在Startup类的Configure方法中添加

app.UseSession();

2.3、使用(存储和获取)

// 存储
HttpContext.Session.Set("LoginId", System.Text.Encoding.Default.GetBytes("")); // 获取
HttpContext.Session.TryGetValue("LoginId", out byte[] byteLoginId);
var loginId = System.Text.Encoding.Default.GetString(byteLoginId); // LoginId="666";

3、源码分析图

[asp.net core 源码分析] 01 - Session

4、源码分析

4.1、程序加载

4.1.1、在ConfigureServices中添加分布式缓存,services.AddDistributedMemoryCache();

微软官方建议使用AddDistributedMemoryCache,当然也可以使用AddDistributedRedisCache、AddDistributedSqlServerCache或者自定义缓存也是可以的;

如果是分布式系统或者SSO单点登录,建议使用分布式的缓存AddDistributedRedisCache,AddDistributedSqlServerCache;

缓存的官方文档https://docs.microsoft.com/zh-cn/aspnet/core/performance/caching/memory

4.1.2、在ConfigureServices中添加AddSession;

 public static IServiceCollection AddSession(this IServiceCollection services)
{
if (services == null)
{
throw new ArgumentNullException(nameof(services));
} services.AddTransient<ISessionStore, DistributedSessionStore>();
services.AddDataProtection();
return services;
} public static IServiceCollection AddSession(this IServiceCollection services, Action<SessionOptions> configure)
{
if (services == null)
{
throw new ArgumentNullException(nameof(services));
} if (configure == null)
{
throw new ArgumentNullException(nameof(configure));
} services.Configure(configure);
services.AddSession(); return services;
}

AddSession为IServiceCollection的扩展方法,有1个重载(传入Session的设置,使用services.Configure(configure),加载设置);

services.AddDataProtection()注入数据加密解密DataProtection(),在加密解密SessionKey时使用;

services.AddTransient<ISessionStore, DistributedSessionStore>();注入DistributedSessionStore,其中的Create 方法用做创建Session,调用Create方法时执行new DistributedSession();  DistributedSession类中包含了对IDictionary<EncodedKey, byte[]>的增删改查;

4.1.3、在Configure中UseSession

 public static IApplicationBuilder UseSession(this IApplicationBuilder app)
{
if (app == null)
{
throw new ArgumentNullException(nameof(app));
} return app.UseMiddleware<SessionMiddleware>();
} public static IApplicationBuilder UseSession(this IApplicationBuilder app, SessionOptions options)
{
if (app == null)
{
throw new ArgumentNullException(nameof(app));
}
if (options == null)
{
throw new ArgumentNullException(nameof(options));
} return app.UseMiddleware<SessionMiddleware>(Options.Create(options));
}

UseSession为IApplicationBuilder的扩展方法,也有1个重载,同样也是加载Session的设置,使用Options.Create(options)结合中间件加载设置;

关于中间件可以参考文档 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware

SessionMiddleware.cs为Session的中间件;其中包含Session的核心代码,操作MVC之前和之后的代码都在中间件中;

4.2、SessionMiddleware.cs类解析

在SessionMiddleware中一个异步方法Invoke;主要逻辑中包含了注释,应该很好理解;

   /// <summary>
/// Invokes the logic of the middleware.
/// </summary>
/// <param name="context">The <see cref="HttpContext"/>.</param>
/// <returns>A <see cref="Task"/> that completes when the middleware has completed processing.</returns>
public async Task Invoke(HttpContext context)
{
var isNewSessionKey = false;
Func<bool> tryEstablishSession = ReturnTrue;
var cookieValue = context.Request.Cookies[_options.Cookie.Name]; // 解密cookieValue
var sessionKey = CookieProtection.Unprotect(_dataProtector, cookieValue, _logger);
if (string.IsNullOrWhiteSpace(sessionKey) || sessionKey.Length != SessionKeyLength)
{ // 生成36位随机数
var guidBytes = new byte[];
CryptoRandom.GetBytes(guidBytes);
sessionKey = new Guid(guidBytes).ToString(); // 加密cookieValue
cookieValue = CookieProtection.Protect(_dataProtector, sessionKey); // 设置Cookie
var establisher = new SessionEstablisher(context, cookieValue, _options);
tryEstablishSession = establisher.TryEstablishSession;
isNewSessionKey = true;
} var feature = new SessionFeature();
// 创建Sessin放入 HttpContext Features
feature.Session = _sessionStore.Create(sessionKey, _options.IdleTimeout, _options.IOTimeout, tryEstablishSession, isNewSessionKey);
context.Features.Set<ISessionFeature>(feature); try
{
// 执行逻辑(MVC)之间
await _next(context);
// 执行逻辑(MVC)之后
}
finally
{
// 设置HttpContext Features为空
context.Features.Set<ISessionFeature>(null); if (feature.Session != null)
{
try
{
// Commit Session,把 IDictionary<EncodedKey, byte[]>中的值放入缓存
await feature.Session.CommitAsync(context.RequestAborted);
}
catch (OperationCanceledException)
{
_logger.SessionCommitCanceled();
}
catch (Exception ex)
{
_logger.ErrorClosingTheSession(ex);
}
}
}
}

4.3、DistributedSession.cs 类解析

在SessionMiddleware Invoke方法中,可以看到创建Session最终执行的是new DistributedSession();

此类就不做过多的介绍了,主要就是对IDictionary<EncodedKey, byte[]>增删改查,序列化值、从缓存中Load数据和把数据放入缓存中;

代码过多就不放置博客上,可移至github :https://github.com/aspnet/Session/blob/master/src/Microsoft.AspNetCore.Session/DistributedSession.cs

5、总结

1、在asp.net core中Session的代码还是比较简单的,运用操作也比较简单;

2、可以清楚的理解asp.net core中Session的原理;

3、可以学习其他生产随机数的方法;

4、可以学习在中间件中怎么运用设置(Options.Create(options)、services.Configure(configure));

5、知道了中间件的简单运用;

6、学写了Httpcontext Features 的简单运用,关于 HttpContext可以直接使用Session(HttpContext.Session)在讲asp.net core http时会详细介绍;

7、简单知道了对于缓存的获取和增加;

8、下一篇将分析 .net core configuration,敬请关注;

9、记得推荐评论,或者可以留言希望分析哪部分asp.net core的源码

[asp.net core 源码分析] 01 - Session的更多相关文章

  1. 一个由正则表达式引发的血案 vs2017使用rdlc实现批量打印 vs2017使用rdlc &lbrack;asp&period;net core 源码分析&rsqb; 01 - Session SignalR sql for xml path用法 MemCahe C&num; 操作Excel图形——绘制、读取、隐藏、删除图形 IOC&comma;DIP&comma;DI&comma;IoC容器

    1. 血案由来 近期我在为Lazada卖家中心做一个自助注册的项目,其中的shop name校验规则较为复杂,要求:1. 英文字母大小写2. 数字3. 越南文4. 一些特殊字符,如“&”,“- ...

  2. ASP&period;NET Core&lbrack;源码分析篇&rsqb; - WebHost

    _configureServicesDelegates的承接 在[ASP.NET Core[源码分析篇] - Startup]这篇文章中,我们得知了目前为止(UseStartup),所有的动作都是在_ ...

  3. ASP&period;NET Core&lbrack;源码分析篇&rsqb; - Authentication认证

    原文:ASP.NET Core[源码分析篇] - Authentication认证 追本溯源,从使用开始 首先看一下我们通常是如何使用微软自带的认证,一般在Startup里面配置我们所需的依赖认证服务 ...

  4. ASP&period;NET Core&lbrack;源码分析篇&rsqb; - 认证

    追本溯源,从使用开始 首先看一下我们的通常是如何使用微软自带的认证,一般在Startup里面配置我们所需的依赖认证服务,这里通过JWT的认证方式讲解 public void ConfigureServ ...

  5. ASP&period;NET Core&lbrack;源码分析篇&rsqb; - Startup

    应用启动的重要类 - Startup 在ASP.NET Core - 从Program和Startup开始这篇文章里面,我们知道了Startup这个类的重要性,它主要负责了: 配置应用需要的服务(服务 ...

  6. ASP&period;NET Core源码学习(一)Hosting

    ASP.NET Core源码的学习,我们从Hosting开始, Hosting的GitHub地址为:https://github.com/aspnet/Hosting.git 朋友们可以从以上链接克隆 ...

  7. ASP&period;NET MVC 源码分析(一)

    ASP.NET MVC 源码分析(一) 直接上图: 我们先来看Core的设计: 从项目结构来看,asp.net.mvc.core有以下目录: ActionConstraints:action限制相关 ...

  8. ASP&period;NET MVC源码分析

    MVC4 源码分析(Visual studio 2012/2013) HttpModule中重要的UrlRoutingModule 9:this.OnApplicationPostResolveReq ...

  9. asp&period;net mvc源码分析-DefaultModelBinder 自定义的普通数据类型的绑定和验证

    原文:asp.net mvc源码分析-DefaultModelBinder 自定义的普通数据类型的绑定和验证 在前面的文章中我们曾经涉及到ControllerActionInvoker类GetPara ...

随机推荐

  1. windows编程环境

    自行下载VS2010官方原版并破解你也可以从微软官方直接下载VS2010 正式版,然后自行破解.Microsoft Visual Studio 2010官方下载地址如下:页面:http://www.m ...

  2. 读取xml文件报错:Invalid byte 2 of 2-byte UTF-8 sequence。

    程序读取xml文件后,系统报“Invalid byte 2 of 2-byte UTF-8 sequence”错误,如何解决呢? 1.程序解析xml的时候,出现Invalid byte 2 of 2- ...

  3. Redis学习笔记&lpar;1&rpar;-Key

    package cn.com; import java.text.ParseException; import java.util.List; import java.util.Set; import ...

  4. &lbrack; CodeVS冲杯之路 &rsqb; P1171

    不充钱,你怎么AC? 题目:http://codevs.cn/problem/1171/ 代码调了很久才调好啊,一开始题目都看错了(要是真的NOIP肯定没戏了QuQ) 后面发现CodeVS上的数据输入 ...

  5. response 后刷新页面&comma;点击按钮后,禁用该按钮

    一,正常的点击按钮后,将其灰显,全部执行完毕再正常显示. this.btnSave.Attributes.Add("onclick", "if (typeof(Page_ ...

  6. 【BZOJ 1040】 &lbrack;ZJOI2008&rsqb;骑士

    Description Z国的骑士团是一个很有*的组织,帮会中汇聚了来自各地的精英.他们劫富济贫,惩恶扬善,受到社会各界的赞扬.最近发生了一件可怕的事情,邪恶的Y国发动了一场针对Z国的侵略战争.战火 ...

  7. Echop后台分页实现原理详解

    ecshop后台开发,工作中分页中遇到的问题 1.通过筛选条件筛选出数据后,点击下一页返回没有筛选(所有数据)的第二页数据 效果 结果 点击分页后效果 问题:ecshop分页利用ajax实现,在点击下 ...

  8. bool operator&equals;&equals;&lpar;const Array&amp&semi;&rpar;const&semi; 这最后一个const 是做什么用的

    字符重载也是个函数,在函数末尾加CONST 这样的函数叫常成员函数.常成员函数可以理解为是一个“只读”函数,它既不能更改数据成员的值,也不能调用那些能引起数据成员值变化的成员函数,只能调用const成 ...

  9. Spring - Spring容器概念及其初始化过程

    引言 工作4年多,做了3年的java,每个项目都用Spring,但对Spring一直都是知其然而不知其所以然.鄙人深知Spring是一个高深的框架,正好近期脱离加班的苦逼状态,遂决定从Spring的官 ...

  10. libguestfs手册&lpar;1&rpar;&colon; 架构

    要编辑一个image,则运行下面的命令 guestfish -a ubuntutest.img ><fs> 会弹出一个命令行工具 运行run ><fs> run 我 ...