C#怎么使用Session_C# WebAPI分布式Session与Redis集成【实用】

风枫酱_9496

风枫酱_9496

2026-04-27

535人浏览

原创

asp.net core web api 默认不启用 session,需同时注册 adddistributedrediscache、addsession 并调用 usesession(在 userouting 后、useendpoints 前),且 cookie.isessential = true;session 数据以加密 blob 存于 redis 字符串键 .aspnetcore.session:{sessionid} 中,应始终通过 isession 操作。

c#怎么使用session_c# webapi分布式session与redis集成【实用】

ASP.NET Core Web API 默认不带 Session 支持,直接调用 HttpContext.Session 会抛出 NullReferenceException —— 因为 Session 中间件根本没注册,更别说连 Redis 了。

为什么 Web API 项目里 HttpContext.Session 是 null?

Web API 模板默认不启用 Session,它被设计为无状态服务。即使你装了 Microsoft.Extensions.Caching.Redis,也只提供了分布式缓存能力,不是 Session 功能本身。

Session 的完整链路需要三样东西同时到位:

  • AddDistributedRedisCache():注册 Redis 缓存提供者(仅提供底层存储)
  • AddSession():启用 Session 中间件,并指定使用哪个分布式缓存
  • UseSession():在请求管道中插入 Session 中间件(必须在 UseRouting 之后、UseEndpoints 之前)

漏掉任意一个,HttpContext.Session 就是 null。常见错误是只配了 Redis 缓存,忘了调 AddSession 和 UseSession。

AddDistributedRedisCache 和 AddSession 怎么配才生效?

在 Program.cs(.NET 6+)里顺序不能错:

var builder = WebApplication.CreateBuilder(args);

// 1. 注册 Redis 分布式缓存(必须先于 Session)
builder.Services.AddStackExchangeRedisCache(options =>
{
    options.Configuration = builder.Configuration.GetConnectionString("Redis");
    options.InstanceName = "session_";
});

// 2. 启用 Session(关键!指定使用上面注册的 Redis 缓存)
builder.Services.AddSession(options =>
{
    options.IdleTimeout = TimeSpan.FromMinutes(20);
    options.Cookie.HttpOnly = true;
    options.Cookie.IsEssential = true; // 否则 UseSession 可能跳过
});

var app = builder.Build();

// 3. 使用 Session(必须在 UseRouting 之后、UseEndpoints 之前)
app.UseRouting();
app.UseSession(); // ← 这行不能少,也不能放错位置
app.UseAuthorization();
app.MapControllers();

注意点:

Ai Session Analysis
Ai Session Analysis

用于分析本地AI编程助手会话数据(如Claude Code、Codex、Kimi Code)。当用户请求分析编程会话时触发。

下载
  • options.Cookie.IsEssential = true 是硬性要求,否则 UseSession 会静默跳过 Cookie 初始化
  • IdleTimeout 控制的是“不活动超时”,不是绝对 TTL;Redis 中实际键的过期时间由 Session 中间件自动续期管理
  • 不要手动调用 ISession.SetString 前检查 HttpContext.Session != null —— 如果配置正确,它一定不为 null;为空说明配置失败,该查中间件顺序

Session ID 是怎么和 Redis 键关联的?

ASP.NET Core Session 不把整个对象序列化后塞进一个 Redis key,而是拆成两层:

  • 主键格式:.AspNetCore.Session:{sessionId}(由 InstanceName + 默认前缀拼成)
  • 值是二进制 blob,内容是经过加密、压缩、序列化的 Session 字典(含所有 SetString/SetInt32 存的数据)

这意味着:

  • 你无法用 redis-cli 直接 GET 看清内容(它是加密的,默认用 Data Protection 加密)
  • 不能用 HGETALL 查字段 —— 它不是 Hash 类型,是 String 类型的 blob
  • 如果想调试,可临时关闭加密:services.AddDataProtection().DisableAutomaticKeyGeneration();(仅开发环境)

别试图绕过 ISession 接口直接操作 Redis —— Session 中间件内部有并发控制、脏检查、过期刷新逻辑,手写容易丢数据或破坏一致性。

跨域或非浏览器客户端怎么传 Session ID?

Session 依赖 Cookie,而 Cookie 默认受同源策略限制。如果你的前端是 Vue/React 独立域名,或移动端 App 调用 Web API:

  • 浏览器端:必须让前端发请求时带上 credentials: 'include',且后端 CorsPolicy 开启 AllowCredentials = true,并显式指定 WithOrigins("https://your-frontend.com")(不能用 *)
  • 非浏览器客户端(如 App):Cookie 很难可靠传递,建议改用 Token 方案 —— 登录成功后,把用户标识写入 Redis(key 为 token,value 为用户信息),再把 token 通过响应体返回;后续请求由客户端在 Header(如 Authorization: Bearer xxx)里传 token,服务端自己查 Redis 验证

强行让 App 模拟 Cookie 行为,不仅复杂,还容易因 Cookie 存储机制差异导致失效 —— 这不是 Session 的设计场景。

最常被忽略的一点:Session ID 的生成和传输完全由框架控制,你不需要、也不应该自己生成或解析 ASP.NET_SessionId Cookie。所有操作都应通过 ISession 接口进行,哪怕只是存个字符串。一旦开始混用 IDistributedCache 直接操作 Redis,就等于绕过了 Session 的生命周期管理,超时、续期、并发安全全得自己兜底。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

redis session c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1032

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

3011

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

885

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2635

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

312

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

389

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

session失效的原因
session失效的原因

session失效的原因有会话超时、会话数量限制、会话完整性检查、服务器重启、浏览器或设备问题等等。详细介绍:1、会话超时:服务器为Session设置了一个默认的超时时间,当用户在一段时间内没有与服务器交互时,Session将自动失效;2、会话数量限制:服务器为每个用户的Session数量设置了一个限制,当用户创建的Session数量超过这个限制时,最新的会覆盖最早的等等。

2023.10.17

580

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习