.net core 自定义配置系统

本文主要是介绍.net core 自定义配置系统，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言

今天来简单写一个自定义的配置系统，能自己手写一些稍微底层的东西，对之后的使用和学习都有帮助。在.net core web api 项目中，默认有一个配置文件叫appsetting.json，可以在这个文件中定义一些配置项，需要使用的时候直接使用IConfiguration即可，那么今天咱们就来实现一下这个东西的内部逻辑。

实战准备

首先还是新建一个控制台项目。然后新建一个名为appsetting.json的配置文件。内容如下，这里我就写的很简单了，因为本篇文章主要是学习如何自定义配置系统，如果想要复杂那就可以在基础之上在完善。

{"Address": "127.0.0.1","Port": "80"
}

由于我们这个配置系统是默认读取 appsetting.json这个文件。所以主要依赖的是FileConfigurationProvider这个类。
首先我们新建一个LmConfigProvider类，这个类继承自FileConfigurationProvider，然后需要重写Load方法。

using Microsoft.Extensions.Configuration;
using Newtonsoft.Json.Linq;namespace 自定义配置系统
{public class LmConfigProvider:FileConfigurationProvider{public LmConfigProvider(LmConfigSource src):base(src){}public override void Load(Stream stream){var data = new Dictionary<string, string?>();var reader = new StreamReader(stream);var fileInfo =  reader.ReadToEnd();JObject jobject = (JObject)JToken.Parse(fileInfo);foreach (var item in jobject){data.Add(item.Key, item.Value.ToString());}this.Data = data;}}
}

Load方法，我的实现比较简单，默认传入的是一个Stream流，所以直接读取这个Json文件就可以,如果文件内容里有嵌套结构，则需要进行扁平化处理，比如A:B，A:C，如果有数组则还需要加上数组下标，比如，A:D:0,A:D:1,表示这样一种结构。

{"A":{"B":"hello","C":"world","D":["abc","def"]}
}

那么A:D:0=abc,A:D:1=def,想深入了解的同学可以继续研究。我这里就简单把JSON转成JObject对象，然后遍历Key和Value然后添加到字典中，最后给ConfigurationProvider的Data属性赋值。
然后添加一个类LmConfigSource。

using Microsoft.Extensions.Configuration;
namespace 自定义配置系统
{public class LmConfigSource : FileConfigurationSource{public override IConfigurationProvider Build(IConfigurationBuilder builder){//加载默认项EnsureDefaults(builder);return new LmConfigProvider(this);}}
}

这个类就比较简单，重写一下IConfigurationProvider方法，把我们的实现类LmConfigProvider直接返回就行。
然后我们的基本工作就算做完了，就添加了两个类。然后在主函数Main里添加如下代码。

var configBuilder = new ConfigurationBuilder();
configBuilder.Add(new LmConfigSource() { Path="appsetting.json" });
var config = configBuilder.Build();
string addr = config["Address"];
string port = config.GetSection("Port").Value;
Console.WriteLine($"Address={addr}");
Console.WriteLine($"Port={port}");

运行一下，就可以看到结果了。
在这里插入图片描述

到这里其实应该就可以结束了，但是呢，在实际使用过程中，是不会添加那么一大段读取配置文件的方法的，所以我们可以新建一个扩展方法来自动帮我们完成这些配置工作。
新增ConfigExtension类。实现如下。

using Microsoft.Extensions.Configuration;
namespace 自定义配置系统
{public static class ConfigExtension{public static IConfigurationRoot UseLmConfig(this IConfigurationBuilder builder){var configBuilder = new ConfigurationBuilder();configBuilder.Add(new LmConfigSource() { Path="appsetting.json" });return configBuilder.Build();}}
}

那么我们在使用过程中就可以省略成。

    var builder = new ConfigurationBuilder();builder.UseLmConfig();

如果有Startup类的话，在Configure方法下直接添加app.UseLmConfig();其实就可以了。那么我在控制台里使用依赖注入的方式来验证一下。还是在添加一个用来测试读取配置的类。然后注入IConfiguration 。

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;namespace 自定义配置系统
{public class TestController{private readonly IConfiguration config;public TestController(IConfiguration configuration) { config=configuration; }public void Test(){string addr = config["Address"];string port = config.GetSection("Port").Value;Console.WriteLine($"Address={addr}");Console.WriteLine($"Port={port}");}}
}

然后主函数添加如下代码。

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;namespace 自定义配置系统
{internal class Program{static void Main(string[] args){ServiceCollection services = new ServiceCollection();services.AddScoped<IConfiguration>(serviceProvider =>new ConfigurationBuilder().UseLmConfig());services.AddScoped<TestController>();services.AddScoped<LmConfigProvider>();services.AddScoped<LmConfigSource>();using (var sp = services.BuildServiceProvider()){var test = sp.GetRequiredService<TestController>();test.Test();}Console.ReadKey();}}
}