.Net Core Configuration Etcd数据源

前言

    .Net Core为我们提供了一套强大的Configuration配置系统，使用简单扩展性强。通过这套配置系统我们可以将Json、Xml、Ini等数据源加载到程序中,也可以自己扩展其他形式的存储源。今天我们要做的就是通过自定义的方式为其扩展Etcd数据源操作。

何为Etdc

    在使用etcd之前我们先介绍一下Etcd，我相信很多同学都早有耳闻。Etcd是一款高可用、强一致的分布式KV存储系统，它内部采用raft协议作为一致性算法，本身也是基于GO语言开发的，最新版本为v3.4.9，具体版本下载地址可参阅官方GitHub地址。相信了解过K8S的同学对这个肯定不陌生，它是K8S的数据管理系统。官方地址为https://etcd.io/。
    在此之前，我相信大家已经了解过很多存储系统了,Etcd到底能实现了什么功能呢？其一用于配置中心和服务发现，再者也可以实现分布式锁和消息系统。它本身就是基于目录型存储,并且内部有一套强大的Watch机制可以监听针对节点和数据的操作变化，每次对节点的事务操作都会有对于的版本信息。

Etcd VS Zookeeper

通过上面的介绍是不是感觉和Zookeeper有点类似呢😂😂😂，网上有很多很多关于Etcd和Zookeeper的对比文章,大致如下可以得到以下结论

功能

Etcd

Zookeeper

分布式锁

有(采用节点版本号信息)

有(采用临时节点和顺序临时节点)

watcher

有

有

一致性算法

raft

zab

选举

有

有

元数据(metadata)存储

有

有

应用场景

Etcd

Zookeeper

发布与订阅（配置中心）

有(不限次Watch)

有(一次性触发的,需要重新注册Watch)

软负载均衡

有

有

命名服务(Naming Service)

有

有

服务发现

有(基于租约节点)

有(基于临时节点)

分布式通知/协调

有

有

集群管理与Master选举

有

有

分布式锁

有

有

分布式队列

有

有

说白了就是Zookeeper能干的活，Etcd也能干。那既然有了Zookeeper为啥还要选择Etcd,主要基于以下原因

• 更轻量级(Etcd基于GO语言开发,Zookeeper基于Java开发)、更易用(开箱即用)
• 高负载下的稳定读写
• 数据模型的多版本并发控制
• 稳定的watcher功能，通知订阅者监听值的变化(Zookeeper基于数据的监听是一次性的，每次监听完成还需重新注册)
• 客户端协议使用GRPC协议，支持语言更广泛

一言以蔽之,就是不仅实现了Zookeeper的功能，还在很多方面吊打Zookeeper😏😏😏，这么强大的东西忍不住都要试一试。

在.Net Core中使用Etcd

    在Nuget上可以搜索到很多.Net Core的Etcd客户端驱动程序，我使用了下载量最多的一个名字叫dotnet-etcd的驱动包，顺便找到了它在GayHub上,不好意思手滑打错了😱😱😱GitHub上的项目地址，大概学习了一下基本的使用方式。其实我们结合Configuration配置这一块，只需要两个功能。一个是Get获取数据，另一个是Watch节点变化(更新数据会用到)。个人认为,前期有目有边界的学习还是非常总要的。

Configuration扩展Etcd

前面我们讲到过自定义扩展Configuration是非常方便的，相信了解过Configuration相关源码的小伙伴们已经非常熟悉了，大致总结一下分为三步:

• 编写IConfigurationBuilder扩展方法,我们这里叫AddEtcd
• 编写实现IConfigurationSource的配置源信息类，我们这里叫EtcdConfigurationSource
• 编写继承自ConfigurationProvider的ConfigurationSource的配置数据提供类，我们这里叫EtcdConfigurationProvider

因为微软已经给我们提供了一部分便利,所以编写起来还是非常的简单的。好了，接下来我们开始编写具体的实现代码，重点的地方我会在代码中注释说明。
首先是定义扩展类EtcdConfigurationExtensions，这个类是针对IConfigurationBuilder的扩展方法，实现如下

1public static class EtcdConfigurationExtensions
2{
3    /// <summary>
4    /// AddEtcd扩展方法
5    /// </summary>
6    /// <param name="serverAddress">Etcd地址</param>
7    /// <param name="path">读取路径</param>
8    /// <returns></returns>
9    public static IConfigurationBuilder AddEtcd(this IConfigurationBuilder builder, string serverAddress,string path)
10    {
11        return AddEtcd(builder, serverAddress:serverAddress, path: path,reloadOnChange: false);
12    }
13
14    /// <summary>
15    /// AddEtcd扩展方法
16    /// </summary>
17    /// <param name="serverAddress">Etcd地址</param>
18    /// <param name="path">读取路径</param>
19    /// <param name="reloadOnChange">如果数据发送改变是否刷新</param>
20    /// <returns></returns>
21    public static IConfigurationBuilder AddEtcd(this IConfigurationBuilder builder, string serverAddress, string path, bool reloadOnChange)
22    {
23        return AddEtcd(builder,options => {
24            options.Address = serverAddress;
25            options.Path = path;
26            options.ReloadOnChange = reloadOnChange;
27        });
28    }
29
30    public static IConfigurationBuilder AddEtcd(this IConfigurationBuilder builder, Action<EtcdOptions> options)
31    {
32        EtcdOptions etcdOptions = new EtcdOptions();
33        options.Invoke(etcdOptions);
34        return builder.Add(new EtcdConfigurationSource { EtcdOptions = etcdOptions });
35    }
36}

这里我还定义了一个EtcdOptions的POCO,用于承载读取Etcd的配置属性

1public class EtcdOptions
2{
3    /// <summary>
4    /// Etcd地址
5    /// </summary>
6    public string Address { get; set; }
7
8    /// <summary>
9    /// Etcd访问用户名
10    /// </summary>
11    public string UserName { get; set; }
12
13    /// <summary>
14    /// Etcd访问密码
15    /// </summary>
16    public string PassWord { get; set; }
17
18    /// <summary>
19    /// Etcd读取路径
20    /// </summary>
21    public string Path { get; set; }
22
23    /// <summary>
24    /// 数据变更是否刷新读取
25    /// </summary>
26    public bool ReloadOnChange { get; set; }
27}

接下来我们定义EtcdConfigurationSource，这个类非常简单就是返回一个配置提供对象

1public class EtcdConfigurationSource : IConfigurationSource
2{
3    public EtcdOptions EtcdOptions { get; set; }
4
5    public IConfigurationProvider Build(IConfigurationBuilder builder)
6    {
7        return new EtcdConfigurationProvider(EtcdOptions);
8    }
9}

真正的读取操作都在EtcdConfigurationProvider里

1public class EtcdConfigurationProvider : ConfigurationProvider
2{
3    private readonly string _path;
4    private readonly bool _reloadOnChange;
5    private readonly EtcdClient _etcdClient;
6
7    public EtcdConfigurationProvider(EtcdOptions options)
8    {
9        //实例化EtcdClient
10        _etcdClient = new EtcdClient(options.Address,username: options.UserName,password: options.PassWord);
11        _path = options.Path;
12        _reloadOnChange = options.ReloadOnChange;
13    }
14
15    /// <summary>
16    /// 重写加载方法
17    /// </summary>
18    public override void Load()
19    {
20        //读取数据
21        LoadData();
22        //数据发生变化是否重新加载
23        if (_reloadOnChange)
24        {
25            ReloadData();
26        }
27    }
28
29    private void LoadData()
30    {
31        //读取Etcd里的数据
32        string result = _etcdClient.GetValAsync(_path).GetAwaiter().GetResult();
33        if (string.IsNullOrEmpty(result))
34        {
35            return;
36        }
37        //转换一下数据结构，这里我使用的是json格式
38        //读取的数据只要赋值到Data属性上即可,IConfiguration真正读取的数据就是存储到Data的字典数据
39        Data = ConvertData(result);
40    }
41
42    private IDictionary<string,string> ConvertData(string result)
43    {
44        byte[] array = Encoding.UTF8.GetBytes(result);
45        MemoryStream stream = new MemoryStream(array);
46        //JsonConfigurationFileParser是将json数据转换为Configuration可读取的结构(复制JsonConfiguration类库里的😄😄😄)
47        return JsonConfigurationFileParser.Parse(stream);
48    }
49
50    private void ReloadData()
51    {
52        WatchRequest request = new WatchRequest()
53        {
54            CreateRequest = new WatchCreateRequest()
55            {
56                //需要转换一个格式,因为etcd v3版本的接口都包含在grpc的定义中
57                Key = ByteString.CopyFromUtf8(_path)
58            }
59        };
60        //监听Etcd节点变化,获取变更数据，更新配置
61        _etcdClient.Watch(request, rsp =>
62        {
63            if (rsp.Events.Any())
64            {
65                var @event = rsp.Events[0];
66                //需要转换一个格式,因为etcd v3版本的接口都包含在grpc的定义中
67                Data = ConvertData(@event.Kv.Value.ToStringUtf8());
68                //需要调用ConfigurationProvider的OnReload方法触发ConfigurationReloadToken通知
69                //这样才能对使用Configuration的类发送数据变更通知
70                //比如IOptionsMonitor就是通过ConfigurationReloadToken通知变更数据的
71                OnReload();
72            }
73        });
74    }
75}

使用方式如下

builder.AddEtcd("http://127.0.0.1:2379", "service/mydemo", true);

顺便给大家推荐一个Etcd可视化管理工具ETCD Manager，以便更好的学习Etcd。
到这里，基本上就结束了，是不是非常简单。主要还是Configuration本身的设计思路比较清晰，所以实现起来也不费劲。

总结

    以上代码都已经上传了我的GitHub，该仓库还扩展了其他数据源的读取比如Consul、Properties文件、Yaml文件的读取，实现思路也都大致相似,有兴趣的同学可以自行查阅。由于主要是讲解实现思路,可能许多细节并未做处理还望见谅。如果有疑问或者更好的建议，欢迎评论区交流指导。