.Net 配置系统-自定义配置提供者

在.NET Framework框架中，新建一个web项目，会默认创建一个web.config的配置文件。可以在里面配置数据库链接字符串，常用配置项等。

在项目中，可以通过如下所示的方式读取配置文件中的配置项。

string Conn=ConfigurationManager.ConnectionStrings["sqlConnectionString"].ConnectionString;

string filepath = ConfigurationManager.AppSettings["FilePath"];

这是框架提供的读取配置项的用法，也可以自己实现类似的功能，读取自定义的配置文件。

这样做有点造轮子的意思，虽然已经有现成的轮子，通过这样的一个实例可以更好理解框架实现该功能的过程。

项目添加的引用如下：

 

下面就来实现自定义配置提供者：

目标是自定义一个配置提供者，读取出上图中配置文件的配置项。 

web.config

<configuration>
	<connectionStrings>
		<add name="conn1" connectionString="fffff" providerName="pppp"/>
		<add name="conn2" connectionString="ddddd" providerName="ssss"/>
	</connectionStrings>

	<appSettings>
		<add key="AppConfig:name" value="yzk"/>
		<add key="AppConfig:age" value="20"/>
		<add key="AppConfig:proxy:address" value="yzk.com"/>
		<add key="AppConfig:proxy:port" value="80"/>

	</appSettings>
</configuration>

1.开发一个直接或间接实现IConfigurationProvider接口的类，XXXConfigurationProvider，一般继承自ConfigurationProvider。如果是从文件读取，可以继承自FileConfigurationProvider。重写Load方法，把“扁平化数据”设置到Data属性即可。

FxConfigProvider.cs

using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Xml;

namespace ConfigOptions
{
    class FxConfigProvider : FileConfigurationProvider
    {

        public FxConfigProvider(FxConfigSource src) : base(src)
        {
        }

        public override void Load(Stream stream)
        {
            var data = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
            XmlDocument xmlDoc = new XmlDocument();
            xmlDoc.Load(stream);

            #region 读取connectionStrings结点的数据
            {
                var csNodes = xmlDoc.SelectNodes("/configuration/connectionStrings/add");
                foreach (XmlNode xmlNode in csNodes.Cast<XmlNode>())
                {
                    string name = xmlNode.Attributes["name"].Value;
                    string connectionString = xmlNode.Attributes["connectionString"].Value;
                    string providerName = xmlNode.Attributes["providerName"].Value;

                    //[conn1:{connectionString:"fffff",providerName:"pppp"},
                    // conn2:{connectionString:"ddddd",providerName:"ssss"}
                    //]

                    data[$"{name}:connectionString"] = connectionString;
                    data[$"{name}:providerName"] = providerName;
                }
            }
            #endregion


            #region 读取appSettings结点的数据
            {
                var appNodes = xmlDoc.SelectNodes("/configuration/appSettings/add");
                foreach (XmlNode xmlNode in appNodes.Cast<XmlNode>())
                {
                    string key = xmlNode.Attributes["key"].Value;
                    string value = xmlNode.Attributes["value"].Value;

                    data[key] = value;
                }
            }
            #endregion

            this.Data = data;//把“扁平化数据”设置到Data属性
        }

    }
}

2.开发一个实现了IConfigurationSource接口的类XXXConfigSource。如果是从文件读取，可以继承自FileConfigurationSource。在Build方法中返回上面的ConfigurationProvider对象。

FxConfigSource.cs

using Microsoft.Extensions.Configuration;

namespace ConfigOptions
{
    /// <summary>
    /// 主要是提供参数
    /// </summary>
    class FxConfigSource : FileConfigurationSource
    {
        public override IConfigurationProvider Build(IConfigurationBuilder builder)
        {
            EnsureDefaults(builder);//处理path等默认值问题
            return new FxConfigProvider(this);
        }
    }
}

3.然后使用即可，ConfigurationBuilder.Add(new FxConfigSource())即可。为了简化使用，一般提供一个IConfigurationBuilder的扩展方法。

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;

namespace ConfigOptions
{
    class Program
    {
        static void Main(string[] args)
        {
            ServiceCollection services = new ServiceCollection();
            services.AddScoped<TestWebConfig>();//往DI容器中注册自定义类
            ConfigurationBuilder configurationBuilder = new ConfigurationBuilder();
            configurationBuilder.AddFxConfig("web.config");
            IConfigurationRoot root = configurationBuilder.Build();

            //将ConfigJson对象绑定到根节点上面
            services.AddOptions().Configure<WebConfig>(e => root.Bind(e));

            using (var sp = services.BuildServiceProvider())
            {
                var c = sp.GetRequiredService<TestWebConfig>();
                c.Test();
                Console.ReadKey();
            }
        }
    }
}

FxConfigExtensions.cs

using Microsoft.Extensions.Configuration;

namespace ConfigOptions
{
    /// <summary>
    /// 扩展方法
    /// </summary>
    static class FxConfigExtensions
    {
        public static IConfigurationBuilder AddFxConfig(this IConfigurationBuilder cb, string path = null)
        {
            cb.Add(new FxConfigSource() { Path = path });
            return cb;
        }
    }
}

最后写一个测试打印输出的类，用于打印配置文件中的配置项的值。

TestWebConfig.cs

using Microsoft.Extensions.Options;
using System;

namespace ConfigOptions
{
    class TestWebConfig
    {
        private IOptionsSnapshot<WebConfig> optWC;

        public TestWebConfig(IOptionsSnapshot<WebConfig> optWC)
        {
            this.optWC = optWC;
        }

        public void Test()
        {
            var wc = optWC.Value;
            Console.WriteLine(wc.Conn1.connectionString);
            Console.WriteLine(wc.appConfig.age);
            Console.WriteLine(wc.appConfig.proxy.address);
        }
    }
}

项目运行结果：