记录Dotnet6中使用Redis共享Session的实现

1
        public void ConfigureServices(IServiceCollection services)
2
        {
3
            // ... 其他中间件
4
            services.AddHttpContextAccessor();
5
            services.AddMvc().AddSessionStateTempDataProvider();
6

7
            services.AddHttpClient();
8
            // 注入Session
9
            services.AddSessionService("CacheProvider");
10
            // 使用Redis作为系统缓存
11
            services.AddCacheService("CacheProvider");
12
            services.AddControllersWithViews(ConfigureMvcOptions)
13
                .AddNewtonsoftJson(options =>
14
                {
15
                    options.UseMemberCasing();
16
                    // 格式化时间
17
                    options.SerializerSettings.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
18
                });
19
            // ... 其他中间件
20
        }

1
 public static void AddSessionService(this IServiceCollection services, string key)
2
 {
3
     using (ServiceProvider provider = services.BuildServiceProvider())
4
     {
5
         IConfiguration configuration = provider.GetRequiredService<IConfiguration>();
6
         if (configuration == null)
7
         {
8
             throw new ArgumentNullException(nameof(IConfiguration));
9
         }
10
         IConfigurationSection section = configuration.GetSection(key);
11
         if (!section.Exists())
12
         {
13
             Console.WriteLine($"appsetting.json 文件中不存在 '{key}' 配置项，如需使用redis缓存，请增加此配置。将使用系统缓存。");
14
         }
15
         CacheOptions options = section.Get<CacheOptions>();
16
         if (options == null)
17
         {
18
             Console.WriteLine($"读取appsetting.json中'{key}'配置项失败，请正确配置。将使用系统缓存");
19
         }
20

21
         if (options?.CacheType == CacheTypeEnum.Redis.ToString())
22
         {
23
             Console.WriteLine($"将使用Redis缓存Session信息");
24

25
             var connStr = options.RedisConnectionString;
26
             var dic =
27
                 connStr.Contains(',') && !connStr.Contains(';') ?
28
                     connStr.SplitAsDictionary("=", ",", true) :
29
                     connStr.SplitAsDictionary("=", ";", true);
30

31
             var Server = dic["Server"]?.Trim();
32
             var UserName = dic["UserName"]?.Trim();
33
             var Password = dic["Password"]?.Trim();
34

35
             #region 配置说明
36

37
             // var options = new ConfigurationOptions
38
             // {
39
             //     AbortOnConnectFail = false, // 连接失败时是否中止
40
             //     AllowAdmin = false, // 是否允许使用管理命令
41
             //     ConnectTimeout = 5000, // 连接超时时间（毫秒）
42
             //     SyncTimeout = 5000, // 同步操作超时时间（毫秒）
43
             //     ResponseTimeout = 5000, // 响应超时时间（毫秒）
44
             //     ReconnectRetryPolicy = new LinearRetry(1000), // 重连策略
45
             //     DefaultDatabase = 0, // 默认数据库索引
46
             //     EndPoints = { "localhost:6379" }, // Redis节点的地址和端口
47
             //     Ssl = false, // 是否使用SSL加密连接
48
             //     SslHost = "localhost", // SSL连接时的主机名验证
49
             //     Password = "yourpassword", // Redis认证密码
50
             //     ClientName = "MyClient", // 客户端名称
51
             //     KeepAlive = 1800000 // 保持连接间隔时间（毫秒）
52
             // };
53
             #endregion
54

55
             //获取Redis 连接字符串
56
             ConfigurationOptions redisConfigOption = new ConfigurationOptions();
57
             redisConfigOption.EndPoints.Add(Server);
58
             redisConfigOption.AllowAdmin = false;
59
             redisConfigOption.Password = Password;
60
             redisConfigOption.ConnectTimeout = 60000;
61
             redisConfigOption.ResponseTimeout = 60000;
62
             redisConfigOption.SyncTimeout = 60000;
63
             redisConfigOption.ReconnectRetryPolicy = new LinearRetry(1000);// 重连策略
64
             var redis = ConnectionMultiplexer.Connect(redisConfigOption);//建立Redis 连接
65

66
             //添加数据保护服务，设置统一应用程序名称，并指定使用Reids存储私钥
67
             services.AddDataProtection()
68
                 .SetApplicationName("YZ")
69
                 .PersistKeysToStackExchangeRedis(redis, "DataProtection-Keys");
70

71
             //添加Redis缓存用于分布式Session
72
             services.AddStackExchangeRedisCache(options =>
73
             {
74
                 options.ConfigurationOptions = redisConfigOption;
75
                 options.InstanceName = "YZ";
76
             });
77
         }
78
         //添加Session
79
         services.AddSession(options =>
80
         {
81
             options.Cookie.Name = "YZ";
82
             options.IdleTimeout = TimeSpan.FromMinutes(60 * 60); //设置session的过期时间
83
             options.Cookie.HttpOnly = true; //设置在浏览器不能通过js获得该cookie的值
84
             options.Cookie.IsEssential = true;
85
         });
86

87
     }
88
 }

1
    /// <summary>
2
    /// 缓存注册（新生命Redis组件）
3
    /// </summary>
4
    /// <param name="services"></param>
5
    public static void AddCacheService(this IServiceCollection services, string key)
6
    {
7
        using (ServiceProvider provider = services.BuildServiceProvider())
8
        {
9
            ICache cache = NewLife.Caching.Cache.Default;
10

11
            IConfiguration configuration = provider.GetRequiredService<IConfiguration>();
12
            if (configuration == null)
13
            {
14
                throw new ArgumentNullException(nameof(IConfiguration));
15
            }
16
            IConfigurationSection section = configuration.GetSection(key);
17
            if (!section.Exists())
18
            {
19
                Console.WriteLine($"appsetting.json 文件中不存在 '{key}' 配置项，如需使用redis缓存，请增加此配置。将使用系统缓存。");
20
            }
21
            CacheOptions options = section.Get<CacheOptions>();
22
            if (options == null)
23
            {
24
                Console.WriteLine($"读取appsetting.json中'{key}'配置项失败，请正确配置。将使用系统缓存");
25
            }
26

27
            if (options?.CacheType == CacheTypeEnum.Redis.ToString())
28
            {
29
                Console.WriteLine($"将使用Redis缓存");
30
                var redis = new FullRedis();
31
                redis.Init(options.RedisConnectionString);
32
                cache = redis;
33

34
            }
35

36
            services.AddSingleton(cache);
37
        }
38
    }