4.2 多级可换源的配置（上）

总所周知，配置信息是应用程序可变化的设置信息，存放于配置文件中，开发人员可以使用配置文件来更改应用的设置。.net core提供了多种配置方式，例如json文件配置，注册表配置、环境配置，xml文件配置等。其中大家常用的是一个json配置文件方式，即每个应用都有一个appsettings.json配置文件，存放所有的配置信息。

这里，我还有个需要说明的地方，就是当前系统的配置过于庞大了，我建议尽量采用约定方式，就是约定优于配置。例如所有的MVC Controller都以Controller为结尾就是一种约定优于配置的例子。

但这种配置方式存在重复配置问题。例如有三个应用项目访问某数据库，该数据库的数据库连接串将在这三个应用项目的配置文件中分别存放，当数据库的服务器地址、用户、口令等变化时，均需要在这三个项目中修改，随着系统的增多，极易造成漏改的情况。同样的，在云环境下，应用项目可以部署动态分配、扩展的计算资源中（多台虚拟服务器），修改一个配置项就需要同时修改各个服务器中的配置文件，也一样的容易造成漏改的情况。

为了解决这个问题，我们采用了多级配置文件方式，将公用部分配置信息提取出来，存放到一个独立的公共配置文件中，这三个项目均访问公共配置文件以获取数据库连接串。公共配置文件方式可以解决目前存在的问题。然而，在实际运行过程中又发现了新的问题，就是运行过程中发现了程序异常，技术人员经常需要查看配置信息，或者需要修改配置，而客户安全要求比较高（对于客户技术人员的能力就不吐槽了），根本不允许直接访问服务器，排查问题非常困难。

因此，我们最终采用数据库方式存放配置信息。在数据库中增加一个配置信息表，统一存放公共的配置信息，并增加相应的管理界面进行维护。各系统均从同一数据库中获取公共配置信息，完美的解决了重复性配置问题。

首先是公用的配置基类：

    public abstract class ConfigInfo
    {
        public abstract string SectionName { get; }

        public abstract void RegisterOptions(IServiceCollection services, IConfigurationRoot root);
    }

SectionName是配置的名称，RegisterOptions的做法是把配置信息（请参考Options模式）注册到DI中，.net core的缺省注册容器就是IServiceCollection。所有的配置类，例如缓存配置、数据库配置、日志配置等都必须继承该类。例如缓存配置实现类如下：

    public sealed class CachingConfigInfo : ConfigInfo
    {
        /// <summary>
        /// 缓存滑动窗口时间（分钟）
        /// </summary>
        public int DefaultSlidingTime { get; set; }

        /// <summary>
        /// 类型
        /// </summary>
        public string Type { get; set; }

        /// <summary>
        /// 参数
        /// </summary>
        public List<CacheServer> Servers { get; set; }

        public override string SectionName
        {
            get
            {
                return "MicroStrutLibrary:Caching";
            }
        }

        public override void RegisterOptions(IServiceCollection services, IConfigurationRoot root)
        {
            services.Configure<CachingConfigInfo>(root.GetSection(SectionName));
        }
    }

 

其次，配置源基类。配置源是指公共配置（例如缓存、数据库、日志等）存放的位置，例如数据库或者Json文件等。在每个应用项目的appsettings.json中建立一个配置节，存放当前公共配置存放的位置。例如数据库方式和Json文件方式的配置源在appsettings.json文件中的写法如下：

"ConfigurationSource": {
      "StorageMode": "JsonFile",
      "Parameter": "D:\\Programs\\OSChina\\MicroStrutLibrary\\Client\\MicroStrutLibrary.Client.SampleWebApp\\applibrary.json"
}

----------
"ConfigurationSource": {
      "StorageMode": "Database",
      "Parameter": "Data Source=XXXXXX;Initial Catalog=MicroStrutLibrary;User Id=OperUser;Password=XXXX;MultipleActiveResultSets=true;Persist Security Info=true"
}

配置源基类的代码如下：

    public abstract class ConfigSource
    {
        private const string SourceSectionName = "MicroStrutLibrary:ConfigurationSource";
        private const string DefaultStorageMode = "JsonFile";
        private const string DefaultParameter = "appsettings.json";

        protected string _Parameter;

        public static ConfigSource GetConfigSource()
        {
            IConfiguration configuration = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json")
                .Build();

            IConfigurationSection section = configuration.GetSection(SourceSectionName);

            string storageMode = section["StorageMode"] ?? DefaultStorageMode;
            string parameter = section["Parameter"] ?? DefaultParameter;

            TypeNameHelperInfo info = TypeNameHelper.GetTypeNameHelperInfo<ConfigSource>(storageMode);

            return ReflectionHelper.CreateInstance(info.Type, new object[] { parameter }) as ConfigSource;
        }

        public ConfigSource(string parameter)
        {
            this._Parameter = parameter;
        }

        public abstract IConfigurationRoot GetConfigurationRoot();
    }

静态方法GetConfigSource，从应用的本地配置文件appsettings.json中获取配置源设置，然后创建数据库或者Json文件等数据源。TypeNameHelper的内容，请参照“反射工具”。

抽象方法GetConfigurationRoot需要每个具体子类实现，主要作用是从配置源中获取所有配置信息，生成配置信息的IConfiguraionRoot对象。

下面是Json配置源的具体实现：

    [TypeName("JsonFile", "Json配置文件")]
    public class JsonConfigSource : ConfigSource
    {
        public JsonConfigSource(string parameter) : base(parameter)
        {
        }

        public override IConfigurationRoot GetConfigurationRoot()
        {
            //JsonConfigurationSource source = new JsonConfigurationSource();
            //source.Path = _Parameter;

            //ConfigurationBuilder builder = new ConfigurationBuilder();
            //builder.Add(source);

            ConfigurationBuilder builder = new ConfigurationBuilder();
            builder.AddJsonFile(_Parameter);

            return builder.Build();
        }
    }

Json方式配置源的大体写法：

{
  "MicroStrutLibrary": {
    "Caching": {
      "DefaultSlidingTime": 20,
      "Type": "MicroStrutLibrary.Infrastructure.Core.Caching.DefaultCacheHandler, MicroStrutLibrary.Infrastructure.Core"
    },
    "Database": {
      "ConnectionStrings": [
        {
          "Name": "MicroStrutLibrary",
          "ConnectionString": "Data Source=XXXX;Initial Catalog=MicroStrutLibrary;User Id=OperUser;Password=XXXX;MultipleActiveResultSets=true;Persist Security Info=true",
          "ProviderName": "System.Data.SqlClient"
        }
      ],
      "Providers": [
        {
          "Name": "System.Data.SqlClient",
          "Type": "MicroStrutLibrary.Infrastructure.Core.Data.Entity.SqlServerDbContextOptionsBuilderProvider, MicroStrutLibrary.Infrastructure.Core.Data.Entity"
        }
      ]
    }
  }
}

最后，在Startup.cs的ConfigureServices中增加类似services.AddConfiguration()的语句，注册配置源的方式。AddConfiguration是一个扩展的方法，具体实现如下：

        public static IServiceCollection AddConfiguration(this IServiceCollection services)
        {
            if (services == null)
            {
                throw new ArgumentNullException(nameof(services));
            }

            ConfigSource configSource = ConfigSource.GetConfigSource();

            IConfigurationRoot root = configSource.GetConfigurationRoot();

            IEnumerable<Type> list = ReflectionHelper.GetSubTypes<ConfigInfo>();
            foreach (Type type in list)
            {
                ConfigInfo configInfo = Activator.CreateInstance(type) as ConfigInfo;

                configInfo.RegisterOptions(services, root);
            }

            return services;
        }

大体流程是，获取配置源信息，然后从配置源中获取ConfigurationRoot，获取所有的ConfigInfo的子类，创建并注册到DI容器中。GetSubTypes内容，请参照“反射工具”

 

面向云的.net core开发框架目录