自定义Configuration配置源

久居深海

实现自定义配置源至少需要添加如下成员：

• 实现IConfigurationSource接口的配置源；
  
• 实现IConfigurationProvider接口或虚基类ConfigurationProvider的配置提供程序；
  
• 添加配置源的IConfigurationBuilder扩展方法；
  

如自定义一个TXT文本文件配置源：
添加配置源

配置源负责创建配置提供程序，以及监听文件修改。监听文件修改可以使用FileSystemWatcher，通过监听Changed事件监听配置文件的修改。使用ConfigurationReloadToken作为IChangeToken，当监听到文件修改时调用取消令牌的取消操作，进而通知订阅者文件已更改。

1. public class TxtConfigurationSource : IConfigurationSource, IDisposable
2. {
3.     private FileSystemWatcher? _fileWatcher;
4.     private ConfigurationReloadToken _reloadToken;
6.     public TxtConfigurationSource(string path, bool reloadOnChange = true)
7.     {
8.         FilePath = path;
9.         ReloadOnChange = reloadOnChange;
10.         _fileWatcher = new FileSystemWatcher(Directory.GetCurrentDirectory());
11.         _fileWatcher.Filter = "*.txt";
12.         _fileWatcher.EnableRaisingEvents = true;
13.         _fileWatcher.Changed += _fileWatcher_Changed;
15.         _reloadToken = new ConfigurationReloadToken();
16.     }
18.     private void _fileWatcher_Changed(object sender, FileSystemEventArgs e)
19.     {
20.         if (e.FullPath != FilePath)
21.             return;
22.         
23.         if (_reloadToken.HasChanged)
24.             return;
26.         // 触发事件
27.         ConfigurationReloadToken previousToken = Interlocked.Exchange(ref _reloadToken,
28.             new ConfigurationReloadToken());
29.         previousToken.OnReload();
30.     }
32.     public bool ReloadOnChange { get; set; }
34.     public string FilePath { get; set; }
36.     public IConfigurationProvider Build(IConfigurationBuilder builder)
37.     {
38.         return new TxtConfigurationProvider(this);
39.     }
41.     public IChangeToken GetChangeToken() => _reloadToken;
43.     public void Dispose() => Dispose(true);
45.     protected virtual void Dispose(bool disposing)
46.     {
47.         _fileWatcher?.Dispose();
48.     }
49. }

复制代码

添加配置提供程序

配置提供程序负责加载配置文件，并订阅配置源中的配置修改事件。通过ChangeToken.OnChange()方法进行事件订阅，当监听到文件改变时，重新加载文件：

1. public class TxtConfigurationProvider : ConfigurationProvider, IDisposable
2. {
3.     private readonly IDisposable _changeTokenRegistration;
5.     public TxtConfigurationProvider(TxtConfigurationSource source)
6.         :base()
7.     {
8.         Source = source ?? throw new ArgumentNullException(nameof(source));
10.         if (Source.ReloadOnChange)
11.         {
12.             _changeTokenRegistration = ChangeToken.OnChange(
13.                 () => Source.GetChangeToken(),
14.                 () =>
15.                 {
16.                     Thread.Sleep(300);
17.                     Load();
18.                 });
19.         }
20.     }
22.     public TxtConfigurationSource Source { get; }
24.     public override void Load()
25.     {
26.         if (!File.Exists(Source.FilePath))
27.             return;
28.         else
29.         {
30.             Data = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
31.             var lines = File.ReadAllLines(Source.FilePath);
32.             foreach (var line in lines)
33.             {
34.                 var array = line.Replace("：", ":").Split(':');
35.                 if (array.Length < 2)
36.                     continue;
38.                 Data.Add(line.Substring(0, line.LastIndexOf(':')), array.Last());
39.             }
40.         }
42.         OnReload();
43.     }
45.     public void Dispose() => Dispose(true);
47.     protected virtual void Dispose(bool disposing)
48.     {
49.         _changeTokenRegistration?.Dispose();
50.     }
51. }

复制代码

添加配置源扩展方法

添加IConfigurationBuilder扩展方法，方便将自定义配置源添加到IConfigurationBuilder中：

1. public static IConfigurationBuilder AddTxtFile(this IConfigurationBuilder builder,
2.     string path, bool reloadOnChange)
3. {
4.     if (builder == null)
5.         throw new ArgumentNullException(nameof(builder));
6.     if (string.IsNullOrEmpty(path))
7.         throw new ArgumentException($"文件不能为空：{nameof(path)}");
9.     return builder.Add(new TxtConfigurationSource(path, reloadOnChange));
10. }

复制代码

使用

首先通过扩展方法添加配置源，调用IConfigurationBuilder.Build()方法后即可通过IConfiguration获取配置项。通过ChangeToken.OnChange()方法订阅配置修改事件。

1. using ConfigurationTest;
2. using Microsoft.Extensions.Configuration;
3. using Microsoft.Extensions.Primitives;
5. IConfigurationBuilder configurationBuilder = new ConfigurationBuilder()
6.     .AddTxtFile(Path.Combine(Directory.GetCurrentDirectory(), "config.txt"), reloadOnChange: true);
8. // 通过IConfiguration直接读取指定配置
9. IConfiguration configuration = configurationBuilder.Build();
10. Console.WriteLine($"FileProvider:Source:{configuration.GetSection("FileProvider:Source").Value}");
11. Console.WriteLine($"Provider:{configuration["FileProvider:Provider"]}");
12. Console.WriteLine();
14. // 通过绑定选项获取配置
15. FileProviderOptions fileProviderOptions = new FileProviderOptions();
16. configuration.GetSection("FileProvider").Bind(fileProviderOptions);
17. Console.WriteLine($"FileProvider.Source = {fileProviderOptions.Source}");
18. Console.WriteLine($"FileProvider.Provider = {fileProviderOptions.Provider}");
19. Console.WriteLine();
21. // 监听配置修改
22. var disable = ChangeToken.OnChange(() => configuration.GetReloadToken(),
23.                                    () =>
24.                                    {
25.                                        foreach (var section in configuration.GetChildren())
26.                                        {
27.                                            PrintAllConfig(section);
28.                                        }
29.                                        
30.                                        Console.WriteLine();
31.                                        Console.WriteLine("按“q”退出");
32.                                    });
34. Console.WriteLine("按“q”退出");
35. while (Console.ReadLine() != "q")
36. {
37. }
39. disable.Dispose();
41. void PrintAllConfig(IConfigurationSection config)
42. {
43.     var sections = config.GetChildren();
44.     if(sections == null || sections.Count() == 0)
45.         Console.WriteLine($"{config.Key} : {config.Value}");
46.     else
47.     {
48.         foreach (var section in sections)
49.         {
50.             PrintAllConfig(section);
51.         }
52.     }
53. }
55. class FileProviderOptions
56. {
57.     public string Source { get; set; }
58.     public string Provider { get; set; }
59. }

复制代码

1. // config.txt
2. FileProvider:Source:TxtSource
3. FileProvider:Provider:TxtProvider

复制代码

来源:https://www.cnblogs.com/louzixl/archive/2023/12/02/17871159.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！