SignalRSetup.cs 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. using Furion.Logging.Extensions;
  7. using Microsoft.AspNetCore.DataProtection;
  8. using Newtonsoft.Json;
  9. using StackExchange.Redis;
  10. namespace Admin.NET.Core;
  11. public static class SignalRSetup
  12. {
  13. /// <summary>
  14. /// 即时消息SignalR注册
  15. /// </summary>
  16. /// <param name="services"></param>
  17. /// <param name="SetNewtonsoftJsonSetting"></param>
  18. public static void AddSignalR(this IServiceCollection services, Action<JsonSerializerSettings> SetNewtonsoftJsonSetting)
  19. {
  20. var signalRBuilder = services.AddSignalR(options =>
  21. {
  22. options.EnableDetailedErrors = true;
  23. options.ClientTimeoutInterval = TimeSpan.FromMinutes(2);
  24. options.KeepAliveInterval = TimeSpan.FromMinutes(1);
  25. options.MaximumReceiveMessageSize = 1024 * 1024 * 10; // 数据包大小10M,默认最大为32K
  26. }).AddNewtonsoftJsonProtocol(options => SetNewtonsoftJsonSetting(options.PayloadSerializerSettings));
  27. // 若未启用Redis缓存,直接返回
  28. var cacheOptions = App.GetConfig<CacheOptions>("Cache", true);
  29. if (cacheOptions.CacheType != CacheTypeEnum.Redis.ToString())
  30. return;
  31. // 若已开启集群配置,则把SignalR配置为支持集群模式
  32. var clusterOpt = App.GetConfig<ClusterOptions>("Cluster", true);
  33. if (!clusterOpt.Enabled)
  34. return;
  35. var redisOptions = clusterOpt.SentinelConfig;
  36. ConnectionMultiplexer connection1;
  37. if (clusterOpt.IsSentinel) // 哨兵模式
  38. {
  39. var redisConfig = new ConfigurationOptions
  40. {
  41. AbortOnConnectFail = false,
  42. ServiceName = redisOptions.ServiceName,
  43. AllowAdmin = true,
  44. DefaultDatabase = redisOptions.DefaultDb,
  45. Password = redisOptions.Password
  46. };
  47. redisOptions.EndPoints.ForEach(u => redisConfig.EndPoints.Add(u));
  48. connection1 = ConnectionMultiplexer.Connect(redisConfig);
  49. }
  50. else
  51. {
  52. connection1 = ConnectionMultiplexer.Connect(clusterOpt.SignalR.RedisConfiguration);
  53. }
  54. // 密钥存储(数据保护)
  55. services.AddDataProtection().PersistKeysToStackExchangeRedis(connection1, clusterOpt.DataProtecteKey);
  56. signalRBuilder.AddStackExchangeRedis(options =>
  57. {
  58. // 此处设置的ChannelPrefix并不会生效,如果两个不同的项目,且[程序集名+类名]一样,使用同一个redis服务,请注意修改 Hub/OnlineUserHub 的类名。
  59. // 原因请参考下边链接:
  60. // https://github.com/dotnet/aspnetcore/blob/f9121bc3e976ec40a959818451d126d5126ce868/src/SignalR/server/StackExchangeRedis/src/RedisHubLifetimeManager.cs#L74
  61. // https://github.com/dotnet/aspnetcore/blob/f9121bc3e976ec40a959818451d126d5126ce868/src/SignalR/server/StackExchangeRedis/src/Internal/RedisChannels.cs#L33
  62. options.Configuration.ChannelPrefix = new RedisChannel(clusterOpt.SignalR.ChannelPrefix, RedisChannel.PatternMode.Auto);
  63. options.ConnectionFactory = async writer =>
  64. {
  65. ConnectionMultiplexer connection;
  66. if (clusterOpt.IsSentinel)
  67. {
  68. var config = new ConfigurationOptions
  69. {
  70. AbortOnConnectFail = false,
  71. ServiceName = redisOptions.ServiceName,
  72. AllowAdmin = true,
  73. DefaultDatabase = redisOptions.DefaultDb,
  74. Password = redisOptions.Password
  75. };
  76. redisOptions.EndPoints.ForEach(u => config.EndPoints.Add(u));
  77. connection = await ConnectionMultiplexer.ConnectAsync(config, writer);
  78. }
  79. else
  80. {
  81. connection = await ConnectionMultiplexer.ConnectAsync(clusterOpt.SignalR.RedisConfiguration);
  82. }
  83. connection.ConnectionFailed += (_, e) =>
  84. {
  85. "连接 Redis 失败".LogError();
  86. };
  87. if (!connection.IsConnected)
  88. {
  89. "无法连接 Redis".LogError();
  90. }
  91. return connection;
  92. };
  93. });
  94. }
  95. }