.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

相关文章

Spring Boot Maven 插件如何构建可执行 JAR 的核心配置

《SpringBootMaven插件如何构建可执行JAR的核心配置》SpringBoot核心Maven插件,用于生成可执行JAR/WAR,内置服务器简化部署,支持热部署、多环境配置及依赖管理... 目录前言一、插件的核心功能与目标1.1 插件的定位1.2 插件的 Goals(目标)1.3 插件定位1.4 核

RabbitMQ消息总线方式刷新配置服务全过程

《RabbitMQ消息总线方式刷新配置服务全过程》SpringCloudBus通过消息总线与MQ实现微服务配置统一刷新,结合GitWebhooks自动触发更新,避免手动重启,提升效率与可靠性,适用于配... 目录前言介绍环境准备代码示例测试验证总结前言介绍在微服务架构中,为了更方便的向微服务实例广播消息,

使用Python构建一个高效的日志处理系统

《使用Python构建一个高效的日志处理系统》这篇文章主要为大家详细讲解了如何使用Python开发一个专业的日志分析工具,能够自动化处理、分析和可视化各类日志文件,大幅提升运维效率,需要的可以了解下... 目录环境准备工具功能概述完整代码实现代码深度解析1. 类设计与初始化2. 日志解析核心逻辑3. 文件处

nginx 负载均衡配置及如何解决重复登录问题

《nginx负载均衡配置及如何解决重复登录问题》文章详解Nginx源码安装与Docker部署,介绍四层/七层代理区别及负载均衡策略,通过ip_hash解决重复登录问题,对nginx负载均衡配置及如何... 目录一:源码安装:1.配置编译参数2.编译3.编译安装 二,四层代理和七层代理区别1.二者混合使用举例

Java JDK1.8 安装和环境配置教程详解

《JavaJDK1.8安装和环境配置教程详解》文章简要介绍了JDK1.8的安装流程,包括官网下载对应系统版本、安装时选择非系统盘路径、配置JAVA_HOME、CLASSPATH和Path环境变量,... 目录1.下载JDK2.安装JDK3.配置环境变量4.检验JDK官网下载地址:Java Downloads

Linux下进程的CPU配置与线程绑定过程

《Linux下进程的CPU配置与线程绑定过程》本文介绍Linux系统中基于进程和线程的CPU配置方法,通过taskset命令和pthread库调整亲和力,将进程/线程绑定到特定CPU核心以优化资源分配... 目录1 基于进程的CPU配置1.1 对CPU亲和力的配置1.2 绑定进程到指定CPU核上运行2 基于

golang程序打包成脚本部署到Linux系统方式

《golang程序打包成脚本部署到Linux系统方式》Golang程序通过本地编译(设置GOOS为linux生成无后缀二进制文件),上传至Linux服务器后赋权执行,使用nohup命令实现后台运行,完... 目录本地编译golang程序上传Golang二进制文件到linux服务器总结本地编译Golang程序

Spring Boot spring-boot-maven-plugin 参数配置详解(最新推荐)

《SpringBootspring-boot-maven-plugin参数配置详解(最新推荐)》文章介绍了SpringBootMaven插件的5个核心目标(repackage、run、start... 目录一 spring-boot-maven-plugin 插件的5个Goals二 应用场景1 重新打包应用

SpringBoot+EasyExcel实现自定义复杂样式导入导出

《SpringBoot+EasyExcel实现自定义复杂样式导入导出》这篇文章主要为大家详细介绍了SpringBoot如何结果EasyExcel实现自定义复杂样式导入导出功能,文中的示例代码讲解详细,... 目录安装处理自定义导出复杂场景1、列不固定,动态列2、动态下拉3、自定义锁定行/列,添加密码4、合并

Java中读取YAML文件配置信息常见问题及解决方法

《Java中读取YAML文件配置信息常见问题及解决方法》:本文主要介绍Java中读取YAML文件配置信息常见问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录1 使用Spring Boot的@ConfigurationProperties2. 使用@Valu