ASP.NET Core
4. 自定義設定提供程式
在 .NET Core 設定系統中封裝一個設定提供程式關鍵在於提供相應的 IconfigurationSource 實現和 IConfigurationProvider 介面實現，這兩個介面在上一章 ASP.NET Core - 設定系統之設定提供程式 中也有提到了。
IConfigurationSource
IConfigurationSource負責建立IConfigurationProvider實現的範例。它的定義很簡單，就一個Build方法，返回IConfigurationProvider範例：
public interface IConfigurationSource
{
IConfigurationProvider Build(IConfigurationBuilder builder);
}
IConfigurationProvider
IConfigurationProvider 負責實現設定的設定、讀取、過載等功能，並以鍵值對形式提供設定。
public interface IConfigurationProvider
{
// 獲取指定父路徑下的直接子節點Key，然後 Concat(earlierKeys) 一同返回
IEnumerable<string> GetChildKeys(IEnumerable<string> earlierKeys, string parentPath);
// 當該設定提供程式支援更改追蹤（change tracking）時，會返回 change token
// 否則，返回 null
IChangeToken GetReloadToken();
// 載入設定
void Load();
// 設定 key:value
void Set(string key, string value);
// 嘗試獲取指定 key 的 value
bool TryGet(string key, out string value);
}
像工作中常用的設定中心使用者端，例如 nacos、consul，都是實現了對應的設定提供程式，從而將設定中心中的設定無縫地接入到 .NET Core 的設定系統中進行使用，和本地組態檔的使用沒有分別。
如果我們需要封裝自己的設定提供程式，推薦直接繼承抽象類 ConfigurationProvider，該類實現了 IConfigurationProvider 介面，繼承自該類只要實現Load方法即可，Load方法用於從設定來源載入解析設定資訊，將最終的鍵值對設定資訊儲存到Data中。這個過程中可參考一下其他已有的設定提供程式的原始碼，模仿著去寫自己的東西。
在我們日常的系統平臺中，總少不了資料字典這樣一個功能，用於維護平臺中一些業務設定，因為是隨業務動態擴充套件和變動的，很多時候不會寫在組態檔，而是維護在資料庫中。以下以這樣一個場景實現一個設定提供程式。
因為是以資料庫作為載體來儲存設定資訊，所以第一步就是定義實體類
public class DataDictioaryDO
{
public int Id { get; set
public int? ParentId { get; set
public string Key { get; set
public string Value { get; set; }
}
資料字典支援多級級聯，通過ParentId關聯上一級，ParentId為空的即為根節點，如存在下級節點則Value值可以為空，就算填寫了也無效，最終呈現出來的就是一個樹結構。
然後就是定義相應的資料庫存取上下問 DataDictionaryDbContext
public class DataDictionaryDbContext : DbContext
{
public DbSet<DataDictioaryDO> DataDictioaries { get; set; }
public DataDictionaryDbContext(DbContextOptions<DataDictionaryDbContext> options) : base(options)
{
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
modelBuilder.Entity<DataDictioaryDO>().HasKey(e => e.Id);
modelBuilder.Entity<DataDictioaryDO>().Property(e => e.Value).IsRequired(false);
}
}
通過 DbContextOptions 交由外部去設定具體的資料庫型別和連線字串。
之後建立 IConfigurationSource 實現類，主要就是建構函式中需要傳入資料庫設定委託，並且在 Build 範例化EFDataDictionaryConfigurationProvider 物件。
public class EFDataDictionaryConfigurationSource : IConfigurationSource
{
private readonly Action<DbContextOptionsBuilder> _action;
public EFDataDictionaryConfigurationSource(Action<DbContextOptionsBuilder> action)
{
_action= action;
}
public IConfigurationProvider Build(IConfigurationBuilder builder)
{
return new EFDataDictionaryConfigurationProvider(_action);
}
}
之後通過繼承 ConfigurationProvider 實現 EFDataDictionaryConfigurationProvider，主要邏輯就是從資料庫獲取對應的資料表，如果表中沒有資料則插入預設資料，再通過相應的解析器解析資料表資料生成一個 Dictionary<string, string> 物件。
public class EFDataDictionaryConfigurationProvider : ConfigurationProvider
{
Action<DbContextOptionsBuilder> OptionsAction { get; }
public EFDataDictionaryConfigurationProvider(Action<DbContextOptionsBuilder> action)
{
OptionsAction = action;
}
public override void Load()
{
var builder = new DbContextOptionsBuilder<DataDictionaryDbContext>();
OptionsAction(builde);
using var dbContext = new DataDictionaryDbContext(builder.Options);
if(dbContext == null)
{
throw new Exception("Null DB Context !");
}
dbContext.Database.EnsureCreated();
if (!dbContext.DataDictioaries.Any())
{
CreateAndSaveDefaultValues(dbContext);
}
Data = EFDataDictionaryParser.Parse(dbContext.DataDictioaries);
}
private void CreateAndSaveDefaultValues(DataDictionaryDbContext context)
{
var datas = new List<DataDictioaryDO>
{
new DataDictioaryDO
{
Id = 1,
Key = "Settings",
},
new DataDictioaryDO
{
Id = 2,
ParentId = 1,
Key = "Provider",
Value = nameof(EFDataDictionaryConfigurationProvider)
},
new DataDictioaryDO
{
Id = 3,
ParentId = 1,
Key = "Version",
Value = "v1.0.0"
}
};
context.DataDictioaries.AddRange(datas);
context.SaveChanges();
}
}
其中，解析器 EFDataDictionaryParser 的程式碼如下，主要就是通過遞迴的方式，通過樹形資料的 key 構建構建完整的 key，並將其存入 Dictionary<string,string>物件中。
internal class EFDataDictionaryParser
{
private readonly IDictionary<string, string> _data = new SortedDictionary<string, string>(StringComparer.OrdinalIgnoreCase);
private readonly Stack<string> _context = new();
private string _currentPath;
private EFDataDictionaryParser() { }
public static IDictionary<string, string> Parse(IEnumerable<DataDictioaryDO> datas) =>
new EFDataDictionaryParser().ParseDataDictionaryConfiguration(datas);
private IDictionary<string, string> ParseDataDictionaryConfiguration(IEnumerable<DataDictioaryDO> datas)
{
_data.Clear();
if(datas?.Any() != true)
{
return _data;
}
var roots = datas.Where(d => !d.ParentId.HasValue);
foreach (var root in roots)
{
EnterContext(root.Key);
VisitElement(datas, root);
ExitContext();
}
return _data;
}
private void VisitElement(IEnumerable<DataDictioaryDO> datas, DataDictioaryDO parent)
{
var children = datas.Where(d => d.ParentId == parent.Id);
if (children.Any())
{
foreach (var section in children)
{
EnterContext(section.Key);
VisitElement(datas, section);
ExitContext();
}
}
else
{
var key = _currentPath;
if (_data.ContainsKey(key))
throw new FormatException($"A duplicate key '{key}' was found.");
_data[key] = parent.Value;
}
}
private void EnterContext(string context)
{
_context.Push(context);
_currentPath = ConfigurationPath.Combine(_context.Reverse());
}
private void ExitContext()
{
_context.Pop();
_currentPath = ConfigurationPath.Combine(_context.Reverse());
}
}
之後為這個設定提供程式提供一個擴充套件方法，方便之後的使用，如下：
public static class EFDataDictionaryConfigurationExtensions
{
public static IConfigurationBuilder AddEFDataDictionaryConfiguration(this IConfigurationBuilder builder,
Action<DbContextOptionsBuilder> optionAction)
{
builder.Add(new EFDataDictionaryConfigurationSource(optionAction));
return builder;
}
}
之後在入口檔案中將我們的設定擴充套件程式新增到設定系統中，並指定使用記憶體資料庫進行測試
using ConfigurationSampleConsole.ConfigProvider;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using var host = Host.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((context, config) =>
{
// 清除原有的設定提供程式
config.Sources.Clear();
config.AddEFDataDictionaryConfiguration(builder =>
{
builder.UseInMemoryDatabase("DataDictionary");
});
})
.Build();
var configuration = host.Services.GetService<IConfiguration>();
Console.WriteLine($"Settings:Provider: {configuration.GetValue<string>("Settings:Provider")}");
Console.WriteLine($"Settings:Version: {configuration.GetValue<string>("Settings:version")}");
host.Run();
最後的控制檯輸出結果如下：
以上就是 .NET Core 框架下設定系統的一部分知識點，更加詳盡的介紹大家可以再看看官方檔案。設定系統很多時候是結合選項系統一起使用的，下一篇將介紹一下 .NET Core 框架下的選項系統。
參考文章：
ASP.NET Core 中的設定 | Microsoft Learn
設定 - .NET | Microsoft Learn
理解ASP.NET Core - 設定(Configuration)
ASP.NET Core 系列：
目錄：ASP.NET Core 系列總結
上一篇：ASP.NET Core - 設定系統之設定提供程式