1. 前言
在提倡微服務(wù)及 Serverless 越來越普及的當(dāng)下碧注，傳統(tǒng) .Net 應(yīng)用的配置模式往往依賴于一個(gè)名為 web.config 的 XML 文件，在可擴(kuò)展性和可讀性與時(shí)代脫節(jié)了茁影。當(dāng)然蚕涤，我不會(huì)慫恿一下子把所有應(yīng)用遷移到 .Net Core 上，本文將在盡量不引入 .Net Core 開發(fā)模式的前提下端逼，獲得最大的利益珊随。
在開始之前述寡，我們還是先說說 .Net Core 的配置模式有何優(yōu)勢(shì)以及最少的依賴柿隙。
1.1 .Net Core 配置模式的優(yōu)勢(shì)
- 支持多種格式，如 Json鲫凶、ini禀崖、Yaml、系統(tǒng)環(huán)境變量等
- 不再依賴于 web.config 螟炫，可同時(shí)使用多種配置格式
- 支持熱重載配置波附，修改配置可以不用重啟應(yīng)用
1.2 最少依賴
nuget install Microsoft.Extensions.Configuration
nuget install Microsoft.Extensions.Configuration.Binder
nuget install Castle.Windsor (其他 IOC 框架均可)
如果你安裝的是最新的包，可能會(huì)遇到 Microsoft.Extensions.Configuration 系列 Nuget 包無法安裝的問題昼钻，這主要取決當(dāng)前應(yīng)用的 .Net 版本掸屡，請(qǐng)參考下圖，安裝對(duì)應(yīng)的版本（目前不支持 .Net 4.5 以下的應(yīng)用）然评。
由于本人喜歡可讀性高的 Json 文件仅财，所以還安裝 Microsoft.Extensions.Configuration.Json 的 Nuget 包。
2. 示例教程
本文在 Abp 2.1.3 的基礎(chǔ)上實(shí)現(xiàn) .Net Core 的配置模式以及熱重載配置碗淌，更詳細(xì)的過程可參照我在 Github 上的 提交歷史 盏求。
2.1 加載配置
.Net Core 配置模式的核心是一個(gè)名為 IConfigurationRoot 的接口對(duì)象，需要在應(yīng)用入口中加載各種配置格式后創(chuàng)建一個(gè) IConfigurationRoot 的實(shí)例亿眠，在傳統(tǒng)的 .Net Web 應(yīng)用中是在 Global.asax.cs 中賦值碎罚。
// ConfigurationExtenion.AppConfiguration 為一個(gè)靜態(tài)的 IConfigurationRoot 實(shí)例。
ConfigurationExtenion.AppConfiguration = new ConfigurationBuilder()
.AddJsonFile("appsetting.json", optional: false, reloadOnChange: true)
.AddJsonFile("appsetting01.json", optional: true, reloadOnChange: false)
.Build();
簡(jiǎn)單地解釋一下纳像，我們需要(在根目錄中) 有一個(gè)名為 "appsetting.json" 的 Json 文件荆烈，被修改的同時(shí)會(huì)重載 ConfigurationExtenion.AppConfiguration 。與之相反的 "appsetting01.json" 則允許不存在爹耗，即使存在耙考，被修改時(shí)不會(huì)重載配置。
2.2 讀取配置節(jié)點(diǎn)
加載配置后潭兽，我們需要把配置讀取出來，在 IConfigurationRoot 中所有配置的信息都是存在于一個(gè)個(gè)節(jié)點(diǎn)中斗遏，我們可以根據(jù)節(jié)點(diǎn)名稱來獲取對(duì)應(yīng)的類型對(duì)象山卦。
/// <summary>
/// 獲取節(jié)點(diǎn)配置
/// </summary>
/// <typeparam name="TService"></typeparam>
/// <param name="config"></param>
/// <param name="sectionName"></param>
/// <returns></returns>
internal static TService GetSectionObject<TService>(IConfigurationRoot config, String sectionName)
{
var section = config.GetSection(sectionName);
if (section == null)
{
throw new ArgumentException($" {sectionName} 未綁定，無法獲取到配置節(jié)點(diǎn)信息诵次！");
}
return section.Get<TService>();
}
假設(shè)我們有一個(gè)這樣的 "appsetting.json" 文件:
{
"RedisConfiguration": {
"InstanceDbId": 14,
"InstanceRedisConnectionString": "127.0.0.1"
},
"MongoDbConfiguration": {
"ConnectionString": "mongodb://127.0.0.1:27017/?connectTimeoutMS=300000",
"DatatabaseName": "local"
}
}
如果我們要獲取 MongoDbConfiguration 下的 ConnectionString 的值账蓉，那么我們可以這樣獲取：
var connectionString= GetSectionObject<String>(ConfigurationExtenion.AppConfiguration,"MongoDbConfiguration:ConnectionString");
2.3 設(shè)計(jì)配置類
在傳統(tǒng)的 .Net 應(yīng)用程序中逾一，我們往往會(huì)使用一個(gè)靜態(tài)變量去存放配置信息铸本。而在有 IOC 的情況下，更好的方法是設(shè)計(jì)一個(gè)類來存放配置遵堵，如上面的 Json 文件我們可以設(shè)計(jì)如下兩個(gè)類(在 Visual Studio 選擇性黏貼 Json 會(huì)自動(dòng)生成對(duì)象):
public class RedisConfiguration
{
public int InstanceDbId { get; set; }
public string InstanceRedisConnectionString { get; set; }
}
public class MongodbConfiguration
{
public string ConnectionString { get; set; }
public string DatatabaseName { get; set; }
}
2.4 注冊(cè)配置
為了實(shí)現(xiàn)熱重載配置箱玷，而不是一層不變的值怨规，我們?cè)?IOC 中獲取配置類時(shí)，需要使用工廠方法獲取锡足。在 Windsor 中可以這么做：
/// <summary>
/// 注冊(cè)方法
/// </summary>
/// <typeparam name="TService"></typeparam>
/// <param name="ioc"></param>
/// <param name="factoryMethod"></param>
private static void Register<TService>(IIocManager ioc,
Func<TService> factoryMethod) where TService : class
{
ioc.IocContainer
.Register(
Component.For<TService>()
.UsingFactoryMethod(factoryMethod)
.LifestyleTransient() //這里的生命周期是瞬時(shí)的波丰，單例不可以嗎？
);
}
結(jié)合前面的獲取配置節(jié)點(diǎn)舶得，我們可以把兩個(gè)靜態(tài)方法組合起來創(chuàng)造一個(gè)新的靜態(tài)方法掰烟，更方便我們使用。
/// <summary>
/// 注冊(cè)配置
/// </summary>
/// <typeparam name="TService"></typeparam>
/// <param name="ioc"></param>
/// <param name="config"></param>
/// <param name="sectionName"></param>
internal static void InitConfigService<TService>(IIocManager ioc, IConfigurationRoot config, String sectionName) where TService : class
{
Register(ioc, () =>
{
var service = GetSectionObject<TService>(config, sectionName);
return service;
});
}
對(duì)于前面兩個(gè)配置類沐批，我們可以這樣注入：
ConfigurationExtenion.InitConfigService<RedisConfiguration>(IocManager,ConfigurationExtenion.AppConfiguration, "RedisConfiguration");
ConfigurationExtenion.InitConfigService<MongodbConfiguration>(IocManager, ConfigurationExtenion.AppConfiguration, "MongoDbConfiguration");
2.5 獲取配置
我在這里新增一個(gè)控制器方法獲取 RedisConfiguration 對(duì)象纫骑，該方法使用屬性注入獲取指定的配置類，并返回給頁面九孩。
public String GetRedisConfig()
{
var redisConfig = IocManager.Instance.Resolve<RedisConfiguration>();
return redisConfig.ToJsonString();
}
可以看到頁面顯示的與 Json 文件中結(jié)構(gòu)一模一：
2.6 熱重載配置
與 .Net Core 不一樣惧磺，在 .Net 4.X 的 Web 應(yīng)用中只是稍微修改下 Json 文件都會(huì)讓整個(gè)應(yīng)用重啟(修改 web.config 同樣會(huì)重啟)，所以我將 "appsetting.json" 重命名為 "appsetting.conf" 捻撑，在運(yùn)行時(shí)修改某些值磨隘，并重新訪問控制器，可以看到對(duì)應(yīng)的值變了顾患。
需要注意 IIS 的安全配置番捂，Json 或者 ini 也許能直接通過 HTTP 獲取江解！
3. 結(jié)語
通過簡(jiǎn)單的使用 .Net Core 配置模式设预，我們可以感受到其強(qiáng)大魅力，如果你對(duì) .Net Core 更多的了解犁河，以及感受兩者的對(duì)比鳖枕，可以對(duì)照我之前寫過的一篇 文章 。對(duì)于熱重載配置桨螺，.Net Core 中更多是使使用 IOptionsSnapshot 宾符，而為了盡量少地引入 .Net Core 的特性，在這里只是簡(jiǎn)單地用了 IOC 的特性灭翔。當(dāng)然魏烫，在不使用任何 IOC 的情況下（如果你害怕引入 IOC ），定義一個(gè) IConfigurationRoot 的全局靜態(tài)實(shí)例肝箱，也不失為一個(gè)折中的方案哄褒。
本文采用 知識(shí)共享署名-非商業(yè)性使用-相同方式共享 3.0 中國大陸許可協(xié)議
轉(zhuǎn)載請(qǐng)注明來源：張蘅水
