.Net Core小技巧系列——分类化配置文件

本文章内容基于 .net core2.2写就,低版本未测试不保证实现方式相同,请知晓。

.Net Core配置文件从web.config变成了appsettings.json。一般的数据库链接字符串或加密密钥等信息都将存放在此文件。
随着项目的扩大,配置越来越大。appsettings.json里面的信息错综复杂不利于管理(使用配置表的略过),于是就想着对其进行分类管理。.Net Core不支持.Net的web.config读取其它xml文件(我没找到类似的功能)。那该怎么解决呢:

经过分析发现Program.cs文件中CreateWebHostBuilder中的CreateDefaultBuilder方法内有读取appsettings.json的代码,下面仅贴出了读取配置文件相关的,完整可自己看源码:

.ConfigureAppConfiguration((Action) ((hostingContext, config) =>
{
  IHostingEnvironment hostingEnvironment = hostingContext.HostingEnvironment;
  config.AddJsonFile("appsettings.json", true, true).AddJsonFile("appsettings." + hostingEnvironment.EnvironmentName + ".json", true, true);
  if (hostingEnvironment.IsDevelopment())
  {
    Assembly assembly = Assembly.Load(new AssemblyName(hostingEnvironment.ApplicationName));
    if (assembly != (Assembly) null)
      config.AddUserSecrets(assembly, true);
  }
  config.AddEnvironmentVariables();
  if (args == null)
    return;
  config.AddCommandLine(args);
}))

知道怎么实现的我们就可以模仿一下啦?,自己创建一个IConfigurationBuilder子类ConfigurationBuilder并添加json文件后Build,这样就可以Configuration读取到非appsettings.json的配置了,与写在appsettings.json效果是一样的:

public readonly IConfiguration Configuration;
public Startup(IHostingEnvironment env, IConfiguration configuration)
{
	var builder = new Microsoft.Extensions.Configuration.ConfigurationBuilder()
	    .SetBasePath(env.ContentRootPath)
	    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
	    .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
	    // 添加自定义的json文件
	    .AddJsonFile("自定义json名称.json", optional: false)
	    .AddEnvironmentVariables();	
	Configuration = builder.Build();
}

本以为完成了很高兴,冷静下来发现这仅仅是给Startup类的Configuration增加了这个配置文件,那其它类咋办,总不能每一个都这样写一遍吧?。我相信微软不会这么坑的,后来终于找到了。

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
        	//这里的配置与上面源码的参数一样有没有,在这里只需追加自定义json文件即可。自带的appsettings.json也不用追加了
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.AddJsonFile("自定义json名称.json", true);
            })
            .UseStartup();
}

欣喜若狂有没有,以后再也不用担心appsettings.json文件太长而不利于维护啦。
如果这篇文章对你有帮助,请点个推荐。有啥建议或问题请告知,万分感激!

你可能感兴趣的:(.NET,Core)