.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<WebHostBuilderContext, IConfigurationBuilder>) ((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<Startup>();
}

欣喜若狂有沒有,以後再也不用擔心appsettings.json文件太長而不利於維護啦。
如果這篇文章對你有幫助,請點個推薦。有啥建議或問題請告知,萬分感激!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章