经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 数据库/运维 » Redis » 查看文章
从Redis读取.NET Core配置
来源：cnblogs　　作者：赵榕　　时间：2023/12/26 9:52:30　　对本文有异议

在本文中，我们将创建一个自定义的.NET Core应用配置源和提供程序，用于从Redis中读取配置。在此之前，您需要稍微了解一些.NET Core配置提供程序的工作原理，相关的内容可以在Microsoft开发者官网搜索到。另外您可能还需要了解一些Redis的基础知识，比如Redis的基础数据类型，持久化等等。

一、配置的数据格式

.NET Core应用支持多种配置源（例如json、xml、ini文件，环境变量，内存字典，自定义源等），并且支持同时添加多个配置源，这也是本文的前提条件。应用程序会按照加入的先后顺序替换或补充配置。默认情况下，.NET Core应用的配置是存储在appsettings.json文件中的。在早期的.NET Core应用中，Program.cs的CreateHost方法里面还能看到AddJsonFile("appsettings.json").AddJsonFile($"appsetting.{env.Environment}.json")这样的代码，但是.NET 5以后，这段代码默认被隐藏了。

看过源码的朋友应该知道，.NET Core应用读取配置后，会将数据转换为一个Key和Value都是string的字典。Key的格式为Node1:Node2:abc。例如：

  1. {
  2.   "Logging": {
  3.     "LogLevel": {
  4.       "Default": "Information",
  5.       "Microsoft": "Warning",
  6.       "Microsoft.Hosting.Lifetime": "Information"
  7.     }
  8.   },
  9.   "ConnectionStrings": {
  10.     "DefaultConnection": "Server=myserver;Database=mydb;User=myuser;Password=mypassword;"
  11.   },
  12.   "AppSettings": {
  13.     "ApiBaseUrl": "https://api.example.com",
  14.     "ApiKey": "your-api-key"
  15.   },
  16.   "AllowedHost":["foo1.com","foo2.com"]
  17. }

转换后的数据为：

  1. Logging:LogLevel:Default=Information
  2. Logging:LogLevel:Microsoft=Warning
  3. Logging:LogLevel:Microsoft.Hosting.Lifetime=Information
  4. ConnectionStrings:DefaultConnection=Server=myserver;Database=mydb;User=myuser;Password=mypassword;
  5. AppSettings:ApiBaseUrl=https://api.example.com
  6. AppSettings:ApiKey=your-api-key
  7. AllowedHost:0=foo1.com
  8. AllowedHost:1=foo2.com

二、Redis的Hash类型

通过上面介绍，Redis的Hash数据结构刚好完美的切合了这一特点。先简单的介绍一下：

在Redis中，Hash是一种数据结构，用于存储键值对的集合，其中每个键都映射到一个值。Redis的Hash是一个键值对的无序集合，其中的每个键都是唯一的。Hash是一个类似于字典或关联数组的概念，在其他编程语言中也称为Map或Dictionary。

三、代码实现

创建好项目之后，我们需要安装一个NuGet包，就是大家熟知的StackExchange.Redis，到目前为止应该是.NET应用程序使用最多的Redis客户端。

  1. PM> Install-Package StackExchange.Redis -v 2.7.10

您也可以通过Visual Studio、Rider自带的NuGet客户端安装，或者是直接在csproj文件中加入<PackageReference Include="StackExchange.Redis" Version="2.7.10" />。

RedisConfigurationProvider.cs

  1. public sealed class RedisConfigurationProvider : ConfigurationProvider, IAsyncDisposable
  2. {
  3. 	private readonly ConnectionMultiplexer _connection;
  4.     
  5.     private readonly IDatabase _database;
  6.     
  7.     private readonly string _key;
  9. 	public RedisConfigurationProvider(RedisConfigurationSource source)
  10. 	{
  11.         _key = source.Key;
  12. 		_connection = ConnectionMultiplexer.Connect(source.ConnectionString);
  13.         _database = _connection.GetDatabase(source.Database);
  14. 	}
  16. 	/// <inheritdoc />
  17. 	public override void Load()
  18. 	{
  19. 		Data = _connection.HashGetAll(_key).ToDictionary(x => x.Name.ToString(), x => ReadRedisValue(x.Value);
  20. 	}
  22.     private static string ReadRedisValue(RedisValue value)
  23. 	{
  24. 		if (value.IsNull)
  25. 		{
  26. 			return null;
  27. 		}
  29. 		return value.IsNullOrEmpty ? string.Empty : value.ToString();
  30. 	}
  31.     
  32. 	/// <inheritdoc />
  33. 	public async ValueTask DisposeAsync()
  34. 	{
  35. 		await _connection.CloseAsync();
  36. 		await _connection.DisposeAsync();
  37. 	}
  38. }

RedisConfigurationSource.cs

  1. public sealed class RedisConfigurationSource : IConfigurationSource
  2. {
  3. 	/// <summary>
  4. 	/// The Redis connection string.
  5. 	/// </summary>
  6. 	[DisallowNull]
  7. 	public string ConnectionString { get; set; }
  9. 	/// <summary>
  10. 	/// Gets or sets the Redis database ID.
  11. 	/// </summary>
  12. 	public int Database { get; set; } = -1;
  14. 	/// <summary>
  15. 	/// Gets or sets the Redis key this source will read from.
  16. 	/// </summary>
  17. 	/// <remarks>
  18. 	/// The key is expected to be a hash.
  19. 	/// </remarks>
  20. 	public string Key { get; set; } = "appsettings";
  21.     
  22. 	/// <inheritdoc />
  23. 	public IConfigurationProvider Build(IConfigurationBuilder builder)
  24. 	{
  25. 		return new RedisConfigurationProvider(this);
  26. 	}
  27. }

关键代码就这些，看上去似乎很简单……事实上确实很简单。

添加配置源

添加配置源的方法也很简单

  1. // Program.cs
  3. var builder = WebApplication.CreateBuilder(args);
  5. builder.Configuration.Add(new RedisConfigurationSource
  6. {
  7. 	ConnectionString = "localhost:6379",
  8. 	Key = "appsettings.dev"
  9. });

RedisConfigurationSource里面总共只有三个属性，ConnectionString用于配置Redis连接字符串，Database用于指定从哪个数据库读取数据，也可以在连接字符串里面指定。Key用于指定要读取的键名称。

通过编写一些简单的代码，我们实现了一个能满足基本需求的分布式.NET Core配置提供程序。

Starfish.Redis

不想动手的朋友可以直接用我已经制作好的包

https://www.nuget.org/packages/Starfish.Redis

安装

Visual Studio包管理器搜索Starfish.Redis，或者执行dotnet add package Starfish.Redis。

配置

  1. // Program.cs
  2. var builder = WebApplication.CreateBuilder(args);
  3. builder.Configuration.AddRedis("127.0.0.1:6379,defaultDatabase=0,connectTimeout=5000,connectRetry=3", "appsettings");

启用Redis Keyspace Notifications

Starfish.Redis有两种机制用于实现ReloadOnChanged（配置修改后重新加载数据），一种是定时查询指定的Key，时效性稍微差一些。另一种是利用Redis的Keyspace Event和Pub/Sub模式来实现，当订阅的Key发生变化（删除、修改、过期等）时会主动发送通知给订阅者，使用这种模式需要配置Redis服务的notify-keyspace-events。

关于notify-keyspace-events配置，可参考下面的描述：

  • K：Keyspace事件，将会以__keyspace@__作为事件的前缀
  • E：Keyevent事件，将会以__keyevent@__作为事件的前缀
  • g：非特定类型的通用命令，例如DEL、EXPIRE、RENAME等
  • $：字符串命令，例如SET、INCR等
  • l：列表命令，例如LPUSH、LPOP等
  • s：集合命令，例如SADD、SREM等
  • h：哈希表命令，例如HSET、HINCRBY等
  • z：有序集合命令，例如ZSET、ZREM等
  • t：流命令，例如XADD、XDEL等
  • x：过期事件（在每个发生键过期的时侯产生）
  • e：淘汰事件（在每个发生键被淘汰的时候产生）
  • m：未命中事件（在访问某个不存在的键使产生）
  • A：配置g$lshztxe的别名，但不包括未命中事件m

简单起见，我们直接配置为AKE（启用所有事件的通知）。

方法一：redis-cli

  1. redis-cli config set notify-keyspace-events AKE

方法二：docker参数

  1. docker run -d --name redisname -p 6379:6379 redis --notify-keyspace-events AKE

方法三：配置文件

找到并打开打开redis.conf，在末尾加上

  1. notify-keyspace-events AKE

注意事项

  1. Redis本身自带持久化策略，但是有的企业/团队没有开启或者是特意关闭了持久化，因此需要谨慎使用此方案。
  2. 强烈建议将存储配置数据的key设置为永不过期（TTL设置为-1），避免key过期带来一些不必要的麻烦。

导入appsettings.json到Redis

微软.NET库提供了一个内部类JsonConfigurationFileParser用于将json格式的配置转换为Dictionary<string, string>。

  1. namespace Microsoft.Extensions.Configuration.Json
  2. {
  3.     internal sealed class JsonConfigurationFileParser
  4.     {
  5.         private JsonConfigurationFileParser() { }
  7.         private readonly Dictionary<string, string?> _data = new Dictionary<string, string?>(StringComparer.OrdinalIgnoreCase);
  8.         private readonly Stack<string> _paths = new Stack<string>();
  10.         public static IDictionary<string, string?> Parse(Stream input)
  11.             => new JsonConfigurationFileParser().ParseStream(input);
  13.         private Dictionary<string, string?> ParseStream(Stream input)
  14.         {
  15.             var jsonDocumentOptions = new JsonDocumentOptions
  16.             {
  17.                 CommentHandling = JsonCommentHandling.Skip,
  18.                 AllowTrailingCommas = true,
  19.             };
  21.             using (var reader = new StreamReader(input))
  22.             using (JsonDocument doc = JsonDocument.Parse(reader.ReadToEnd(), jsonDocumentOptions))
  23.             {
  24.                 if (doc.RootElement.ValueKind != JsonValueKind.Object)
  25.                 {
  26.                     throw new FormatException(SR.Format(SR.Error_InvalidTopLevelJSONElement, doc.RootElement.ValueKind));
  27.                 }
  28.                 VisitObjectElement(doc.RootElement);
  29.             }
  31.             return _data;
  32.         }
  34.         private void VisitObjectElement(JsonElement element)
  35.         {
  36.             var isEmpty = true;
  38.             foreach (JsonProperty property in element.EnumerateObject())
  39.             {
  40.                 isEmpty = false;
  41.                 EnterContext(property.Name);
  42.                 VisitValue(property.Value);
  43.                 ExitContext();
  44.             }
  46.             SetNullIfElementIsEmpty(isEmpty);
  47.         }
  49.         private void VisitArrayElement(JsonElement element)
  50.         {
  51.             int index = 0;
  53.             foreach (JsonElement arrayElement in element.EnumerateArray())
  54.             {
  55.                 EnterContext(index.ToString());
  56.                 VisitValue(arrayElement);
  57.                 ExitContext();
  58.                 index++;
  59.             }
  61.             SetNullIfElementIsEmpty(isEmpty: index == 0);
  62.         }
  64.         private void SetNullIfElementIsEmpty(bool isEmpty)
  65.         {
  66.             if (isEmpty && _paths.Count > 0)
  67.             {
  68.                 _data[_paths.Peek()] = null;
  69.             }
  70.         }
  72.         private void VisitValue(JsonElement value)
  73.         {
  74.             Debug.Assert(_paths.Count > 0);
  76.             switch (value.ValueKind)
  77.             {
  78.                 case JsonValueKind.Object:
  79.                     VisitObjectElement(value);
  80.                     break;
  82.                 case JsonValueKind.Array:
  83.                     VisitArrayElement(value);
  84.                     break;
  86.                 case JsonValueKind.Number:
  87.                 case JsonValueKind.String:
  88.                 case JsonValueKind.True:
  89.                 case JsonValueKind.False:
  90.                 case JsonValueKind.Null:
  91.                     string key = _paths.Peek();
  92.                     if (_data.ContainsKey(key))
  93.                     {
  94.                         throw new FormatException(SR.Format(SR.Error_KeyIsDuplicated, key));
  95.                     }
  96.                     _data[key] = value.ToString();
  97.                     break;
  99.                 default:
  100.                     throw new FormatException(SR.Format(SR.Error_UnsupportedJSONToken, value.ValueKind));
  101.             }
  102.         }
  104.         private void EnterContext(string context) =>
  105.             _paths.Push(_paths.Count > 0 ?
  106.                 _paths.Peek() + ConfigurationPath.KeyDelimiter + context :
  107.                 context);
  109.         private void ExitContext() => _paths.Pop();
  110.     }
  111. }

点关注，不迷路。

如果您喜欢这篇文章，请不要忘记点赞、关注、转发，谢谢！如果您有任何高见，欢迎在评论区留言讨论……

公众号

原文链接：https://www.cnblogs.com/zhaorong/p/aspnet-configuration-redis.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Redis热门文章

  • Redis-复制
  • Redis
  • 关于SpringBoot整合redis使用Lettuce客户端超时问题
  • RedisTemplate常用方法封装
  • RedisTemplate中opsForValue和opsForList方法的使用详解
  • Redis7.0部署集群的实现步骤
  • Java&nbsp;Redis&nbsp;Redisson配置教程详解
  • Go语言开发redis封装及简单使用详解
  • SpringBoot Redis批量存取数据的操作
  • .NetCore下基于FreeRedis实现的Redis6.0客户端缓存之缓存键条件优雅过滤

    • Redis推荐文章

  • Redis系列：使用Stream实现消息队列 （图文总结+Go案例） - Hello-Brand
  • 记一次 redis 事件注册不当导致的内存泄露
  • Java Redis多限流
  • 【Azure Developer】一个复制Redis Key到另一个Redis服务的工具(redis_copy_net8)
  • Redis 高阶应用
  • 【长文】带你搞明白Redis
  • StackExchange.Redis跑起来，为什么这么溜？
  • 【进阶篇】基于 Redis 实现分布式锁的全过程
  • Higress 基于自定义插件访问 Redis
  • 美团二面：如何保证Redis与Mysql双写一致性？连续两个面试问到了！

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号