.net core 自定义配置系统

2024-09-05 04:04
文章标签 配置 系统 自定义 core net

本文主要是介绍.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对象,然后遍历KeyValue然后添加到字典中,最后给ConfigurationProviderData属性赋值。
然后添加一个类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();}}
}

注入IConfiguration的时候,需要加上我们的扩展方法,因为已经不是用原来的方法了。
可以看到依然读取出来了。

在这里插入图片描述

结语

通过自定义实现配置系统,可以了解到配置系统的原理,以后在使用第三方的配置系统比如ApolloNacos等,也会更加的得心应手。

Study hard and make progress every day.

欢迎关注下方微信公众号,一起学习,一起娱乐,一起进步,点击卡片可以查看公众号二维码哟。

这篇关于.net core 自定义配置系统的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1137891

相关文章

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

SQL Server配置管理器无法打开的四种解决方法

《SQLServer配置管理器无法打开的四种解决方法》本文总结了SQLServer配置管理器无法打开的四种解决方法,文中通过图文示例介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的... 目录方法一:桌面图标进入方法二:运行窗口进入检查版本号对照表php方法三:查找文件路径方法四:检查 S

Linux中SSH服务配置的全面指南

《Linux中SSH服务配置的全面指南》作为网络安全工程师,SSH(SecureShell)服务的安全配置是我们日常工作中不可忽视的重要环节,本文将从基础配置到高级安全加固,全面解析SSH服务的各项参... 目录概述基础配置详解端口与监听设置主机密钥配置认证机制强化禁用密码认证禁止root直接登录实现双因素

嵌入式数据库SQLite 3配置使用讲解

《嵌入式数据库SQLite3配置使用讲解》本文强调嵌入式项目中SQLite3数据库的重要性,因其零配置、轻量级、跨平台及事务处理特性,可保障数据溯源与责任明确,详细讲解安装配置、基础语法及SQLit... 目录0、惨痛教训1、SQLite3环境配置(1)、下载安装SQLite库(2)、解压下载的文件(3)、

解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘问题

《解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘问题》:本文主要介绍解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4... 目录未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘打开pom.XM

Java实现自定义table宽高的示例代码

《Java实现自定义table宽高的示例代码》在桌面应用、管理系统乃至报表工具中,表格(JTable)作为最常用的数据展示组件,不仅承载对数据的增删改查,还需要配合布局与视觉需求,而JavaSwing... 目录一、项目背景详细介绍二、项目需求详细介绍三、相关技术详细介绍四、实现思路详细介绍五、完整实现代码

一文详解Java Stream的sorted自定义排序

《一文详解JavaStream的sorted自定义排序》Javastream中的sorted方法是用于对流中的元素进行排序的方法,它可以接受一个comparator参数,用于指定排序规则,sorte... 目录一、sorted 操作的基础原理二、自定义排序的实现方式1. Comparator 接口的 Lam

Linux如何快速检查服务器的硬件配置和性能指标

《Linux如何快速检查服务器的硬件配置和性能指标》在运维和开发工作中,我们经常需要快速检查Linux服务器的硬件配置和性能指标,本文将以CentOS为例,介绍如何通过命令行快速获取这些关键信息,... 目录引言一、查询CPU核心数编程(几C?)1. 使用 nproc(最简单)2. 使用 lscpu(详细信

linux重启命令有哪些? 7个实用的Linux系统重启命令汇总

《linux重启命令有哪些?7个实用的Linux系统重启命令汇总》Linux系统提供了多种重启命令,常用的包括shutdown-r、reboot、init6等,不同命令适用于不同场景,本文将详细... 在管理和维护 linux 服务器时,完成系统更新、故障排查或日常维护后,重启系统往往是必不可少的步骤。本文

Nginx 重写与重定向配置方法

《Nginx重写与重定向配置方法》Nginx重写与重定向区别:重写修改路径(客户端无感知),重定向跳转新URL(客户端感知),try_files检查文件/目录存在性,return301直接返回永久重... 目录一.try_files指令二.return指令三.rewrite指令区分重写与重定向重写: 请求