.NET Core etcd 配置源

etcd 是一个高可用的 Key/Value 存储系统，主要用于共享配置和服务发现，和目前比较主流的配置中心（如：Spring Cloud Config、Apollo、Consul、Nacos）、注册中心（如：Zookeeper、Eureka、Consul、Nacos）功能上有很多相似之处，关于各框架之间的对比可以网上搜索。

ectd 的搭建不是本文的重点，本文将基于 ectd v3 版本来测试，为了方便查看效果，还将借助  etcd-manage 可视化管理工具。

etcd 客户端

既然程序需要获取 etcd 中的配置信息，那就必须有对 etcd 操作的客户端代码。官方提供了调用 etcd 服务的 gRPC 接口定义，而 gRPC 有一个特点就是跨语言，所以如果项目中需要引入 etcd 作为配置或注册中心，完全可以直接基于 gRPC 接口定义文件生成对应语言的客户端代码实现远程调用。而对于目前来说，客户端代码的封装在 Github 上早已有实现，如：Java 的 jetcd，.NET 的 dotnet-etcd ，所以我们完全可以站在巨人的肩膀上玩耍。

.NET Core 集成 etcd

关于如何在 .NET 中操作 etcd ，我们可以根据 dotnet-etcd 的介绍来进行一系列测试，本文主要介绍 .NET Core 基于 etcd 实现服务的配置管理。既然客户端代码有现成的，那是不是直接 NuGet 安装 dotnet-etcd 后，通过方法调用拿到某些 key 的值使用就好了？当然这么玩没有任何问题，但个人感觉这样在程序上看来有些松散，毕竟 .NET Core 有可扩展性的配置体系，最终都通过 ConfigurationBuilder 构造供使用。

基于上篇文章 .NET Core 自定义配置源 的介绍，接下来将使用 etcd 作为自定义配置源，所以为了接下来理解顺利，请 务必阅读 过  .NET Core 自定义配置源 。

实现目标

1. 可通过 Configuration 对象进行配置信息读取；

2. etcd 配置中心对相关配置进行变更时，能自动刷新配置；

前面提到了 etcd 是一个 Key/Value 存储系统，我们可以指定 完整 key  或 key 前缀 来获取配置信息，下面将基于 /namespance1/ 这个前缀进行获取并监听变更来演示效果。

etcd-manage

获取 etcd 配置数据源

定义接口 IConfigrationWatcher，含 FireChange 方法，这里定义的比较简单，只在配置发生变更时发出一个信号，所以是 void 类型，但如果要实现对特定 key 变更进行增量处理也是可以的。

public interface IConfigrationWatcher
{
  void FireChange();
}

定义接口 IConfigrationRepository，包含 GetConfig 和 Watch 两个方法。
GetConfig 实现根据指定的前缀从 ectd 获取配置，转换成 IDictionary<string, string> 返回。
Watch 则监听配置变更，当发生变更时，调用 IConfigrationWatcher 对象的 FireChange 方法。

public interface IConfigrationRepository : IDisposable
{
  IDictionary<string, string> GetConfig();

  void Watch(IConfigrationWatcher watcher);
}

完整实现代码：EtcdConfigurationRepository.cs，主要使用到 dotnet-etcd 中的 GetRange 和 WatchRange，WatchRange 的实现是基于 gRPC 的双向流模式，变更通知可以理解为是实时的。

实现 EtcdConfigurationProvider

EtcdConfigurationProvider 的实现和之前的介绍类似，区别在于这里将使用到父类 ConfigurationProvider 的 GetReloadToken 和 OnReload 方法，构造函数中通过 ChangeToken.OnChange 对 ReloadToken 进行状态变更监听。

IConfigrationWatcher 的  FireChange 触发 OnReload，OnReload 触发 ChangeToken 的状态变化，ChangeToken 的状态变化触发 Load 方法重新执行，Data 属性被重新赋值。

注：需不需要 Reload 可通过 reloadOnChange 参数自定义

public class EtcdConfigurationProvider : ConfigurationProvider, IConfigrationWatcher
{
  private readonly IConfigrationRepository _configRepository;

  public EtcdConfigurationProvider(IConfigrationRepository configRepository, bool reloadOnChange)
  {
    _configRepository = configRepository;

    if (reloadOnChange)
    {
      _configRepository.Watch(this);

      ChangeToken.OnChange(
        () => GetReloadToken(),
        () => Load()
      );
    }
  }

  public override void Load()
  {
    Data = _configRepository.GetConfig();
  }

  public void FireChange() => OnReload();
}

EtcdConfigurationSource 则返回 EtcdConfigurationProvider 对象即可，最后定义 IConfigurationBuilder 扩展方法 AddEtcd 供使用。完整代码请参考：Etcd.Configuration

测试效果

appsettings.json 增加 etcd 相关配置参数：

"etcd": {
  "connectionString": "http://localhost:2379",
  "prefixKeys": [
    "/namespace1/"
  ],
  "keyMode": 1   // json 格式 : 分隔
}

Program.cs 增加 AddEtcd

public static IHostBuilder CreateHostBuilder(string[] args) =>
  Host.CreateDefaultBuilder(args)
    .ConfigureWebHostDefaults(webBuilder =>
    {
      webBuilder.ConfigureAppConfiguration(builder =>
      {
        builder.AddEtcd(builder.Build().GetSection("etcd"), true);
      });
      webBuilder.UseStartup<Startup>();
    });

Startup.cs 的 Configuration 对象中 EtcdConfigurationProvider Data 数据如下：

etcd data

基于这样的数据格式，可以将其注入到 Namespace1Options 实体上，然后在程序中直接使用 Namespace1Options：

public class Namespace1Options
{
  public string Name { get; set; }

  public string Company { get; set; }
}

Startup.cs 的 ConfigureServices 方法中添加如下代码：

services.Configure<Namespace1Options>(Configuration.GetSection("/namespace1/"));

使用 Namespace1Options ：

public class WeatherForecastController : ControllerBase
{
  private readonly Namespace1Options _options;

  public WeatherForecastController(IOptionsSnapshot<Namespace1Options> options)
  {
    _options = options.Value;
  }

  [HttpGet]
  public ActionResult<IEnumerable<string>> Get()
  {
    return new string[] { _options.Name, _options.Company };
  }
}

etcd 中对 company 值就行修改，在不重启服务情况下，马上生效。

result

参考链接：

• .NET Core 自定义配置源

• dotnet-etcd

• etcd-manage

• Etcd.Configuration