ASP.NET Core - 配置系統之自定義配置提供程式

来源:https://www.cnblogs.com/wewant/archive/2023/03/13/17110770.html
-Advertisement-
Play Games

#4. 自定義配置提供程式 在 .NET Core 配置系統中封裝一個配置提供程式關鍵在於提供相應的 IconfigurationSource 實現和 IConfigurationProvider 介面實現,這兩個介面在上一章 ASP.NET Core - 配置系統之配置提供程式 中也有提到了。 I ...


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();

最後的控制台輸出結果如下:
image

以上就是 .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 - 配置系統之配置提供程式


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 在正式開始驅動開發之前,需要自行搭建驅動開發的必要環境,首先我們需要安裝`Visual Studio 2013`這款功能強大的程式開發工具,在課件內請雙擊`ISO`文件並運行內部的`vs_ultimate.exe`安裝包,`Visual Studio`的安裝非常的簡單,您只需要按照提示全部選擇預設參... ...
  • C++語言線上運行編譯,是一款可線上編程編輯器,在編輯器上輸入C++語言代碼,點擊運行,可線上編譯運行C++語言,C++語言代碼線上運行調試,C++語言線上編譯,可快速線上測試您的C++語言代碼,線上編譯C++語言代碼發現是否存在錯誤,如果代碼測試通過,將會輸出編譯後的結果。 該線上工具由IT寶庫提 ...
  • 當我們準備去殺死一個進程時,從程式設計的本身來考慮,我們應當要設計一定的保護方案來確保程式被非正常終止時,相應的計算結果也能夠被很好的保存下來。在Python中可以使用signal.signal函數來實現這樣的功能,但是如果要實現數據的保存功能,需要結合一個實際的類來實現。 ...
  • 本文介紹基於Python中ArcPy模塊,實現大量HDF格式柵格圖像文件批量轉換為TIFF格式的方法。 首先,來看看我們想要實現的需求。 在一個名為HDF的文件夾下,有五個子文件夾;每一個子文件夾中,都存儲了大量的.hdf格式的柵格遙感影像數據。 我們在其中任選一個子文件夾,來看看其中所含的文件。 ...
  • 文件上傳是一個老生常談的話題了,在文件相對比較小的情況下,可以直接把文件轉化為位元組流上傳到伺服器,但在文件比較大的情況下,用普通的方式進行上傳,這可不是一個好的辦法,畢竟很少有人會忍受,當文件上傳到一半中斷後,繼續上傳卻只能重頭開始上傳,這種讓人不爽的體驗。那有沒有比較好的上傳體驗呢,答案有的,就是 ...
  • 代碼編譯器是將一段源代碼(C#或VisualBasic)編譯成程式集,它的工作方式與 Emit 不一樣。從 .net standard 開始,代碼編譯器就採用了 Roslyn 來編譯源代碼,前幾篇文章里提到的 SourceGenerator 也正是基於此。 ...
  • PowerPoint是用於製作幻燈片(演示文稿)的應用軟體,每張幻燈片中都可以包含文字、圖形、圖形、表格、聲音和影像等多種信息。有時候我們發現在PPT裡面有一些精美的圖片,或者其他原因想要把PPT裡面的圖片保存下來。但如果PowerPoint文檔中包含大量圖片,一張張保存未免太費時間及精力。那有什麼... ...
  • 主要步驟: ChatGPT 的回答: 你可以嘗試使用 Visual Studio 創建一個類庫項目,然後將你寫的兩個類添加到該項目中,併進行編譯,最終生成 DLL 文件。具體步驟如下: 打開 Visual Studio,選擇 "文件" -> "新建" -> "項目"; 在 "新建項目" 視窗中,選擇 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...