.Net Core 配置框架

最新推荐文章于 2025-03-25 08:36:27 发布
转载 最新推荐文章于 2025-03-25 08:36:27 发布 · 1k 阅读 · 1 ·
CC 4.0 BY-SA版权
原文链接：https://blog.youkuaiyun.com/WuLex

本文详细介绍了.NetCore配置框架的使用方法，包括命令行、环境变量、文件等多种配置来源，并展示了如何实现配置对象绑定及自定义配置数据源。

.Net Core的配置框架有Microsoft.Extensions.Configuration和Microsoft.Extensions.Configuration.Abstractions两个核心包，新版Microsoft.AspNetCore.App包中默认包含了以上Nuget包，所以Asp.Net Core应用管理配置不需要再额外引用相关Nuget包。

.Net Core 配置内容都是以 key-value 形式存在的，支持从多种不同数据源读取配置。

1. 命令行和内存配置

.Net Core程序读取命令行配置需要引用Microsoft.Extensions.Configuration.CommandLineNuget包。

我们可以通过以下语法读取命令行和内存配置数据。

static void Main(string[] args)
{
    var settings = new Dictionary<string, string>
    {
        {"name", "Colin"},
        {"age", "18"}
    };
    // 短命令替换
    var mapper= new Dictionary<string, string>{{"-n","name"}};
    var config = new ConfigurationBuilder() //实例化配置对象工厂
        .AddInMemoryCollection(settings) //使用内存集合配置
        .AddCommandLine(args, mapper) //使用命令行配置
        .Build(); //获取配置根对象
    //获取配置
    Console.WriteLine($"name:{config["name"]} \t age:{config["age"]}");
}

使用命令行配置时可以通过以下三种方式传参。

  • 无前缀 key=value 格式
  • 双中线前缀 --key value 或 --key=value
  • 斜杠前缀 /key value 或 /key=value
    $$
    等号和空格分隔符不允许混用。命令替换常用于实现短命令效果，类似 dotnet -h 替换 dotnet --help
dotnet run cmddemo                        # 输出 name:Colin   age:18
dotnet run cmddemo name=Colin age=18    # 输出 name:Colin   age:18
dotnet run cmddemo -n Robin --age 20    # 输出 name:Robin   age:20

由于AddCommandLine()在AddInMemoryCollection()之后，所以当命令行有参数时会覆盖内存配置信息。

2. 环境变量配置

在Docker容器中部署应用程序时，会大量使用环境变量配置应用程序。
Linux中不支持使用":“作为配置分层键，我们可以使用”__"代替。此外，环境变量配置还支持前缀加载。

.Net Core程序读取环境变量配置需要引用Microsoft.Extensions.Configuration.EnvironmentVariablesNuget包。

{
  "profiles": {
    "ConfigurationDemo": {
      "commandName": "Project",
      "environmentVariables": {
        "title": "tm",
        "user__name": "Colin",
        "user__age": 18,
        "test_width": 32,
        "test_height": 32
      }
    }
  }
}

static void Main(string[] args)
{
    var configurationRoot = new ConfigurationBuilder().AddEnvironmentVariables().Build();
    var title = configurationRoot["title"];
    var userName = configurationRoot.GetSection("user")["name"]; //分层
    // 前缀过滤
    var configurationRootWithPrefix = new ConfigurationBuilder().AddEnvironmentVariables("test_").Build();
    var width = configurationRootWithPrefix["width"];
    var height = configurationRootWithPrefix["height"];
}

以上环境变量配置仅适用于Windows环境。

3. 文件配置

日常开发中最常使用的是文件配置，而其中当属Json文件配置使用最为广泛。使用多配置文件时并存在同Key值配置时，后面的配置会覆盖前面的配置。

程序读取配置文件根据不同文件格式需要引用如下Nuget包：

假定项目目录下有名为appsettings.json的配置文件，内容如下：

{
  "AppName": "配置测试",
  "Class": {
    "ClassName": "三年二班",
    "Master": {
      "Name": "Colin",
      "Age": 25
    },
    "Students": [
      {
        "Name": "Robin",
        "Age": 20
      },
      {
        "Name": "Sean",
        "Age": 23
      }
    ]
  }
}

下面为appsettings.ini配置文件：

School=Beijing University
Address=Beijing

static void Main(string[] args)
{
    var config = new ConfigurationBuilder()
        .AddJsonFile("appsettings.json")
        .AddIniFile("appsettings.ini")
        .Build();
        Console.WriteLine($"AppName:{config["AppName"]}");
        Console.WriteLine($"ClassName:{config["Class:ClassName"]}");
        Console.WriteLine($"Master:\r\nName:{config["Class:Master:Name"]}\tAge:{config["Class:Master:Age"]}");
        Console.WriteLine("Students:");
        Console.WriteLine($"Name:{config["Class:Students:0:Name"]}\tAge:{config["Class:Students:0:Age"]}");
        Console.WriteLine($"Name:{config["Class:Students:1:Name"]}\tAge:{config["Class:Students:1:Age"]}");
        Console.WriteLine($"School:{config["School"]}");
}

除了可以使用IConfiguration类型的索引器方式读取配置，还可以通过其GetSection(string key)方法读取配置。GetSection()方法返回类型为IConfigurationSection，可以链式编程方式读取多层配置。

var clsName = config.GetSection("Class").GetSection("ClassName").Value; //clsName="三年二班"

4. 配置对象绑定

前面提到的配置读取方式只能读取到配置项的字符串格式的内容，遇到较为复杂的配置我们更期望配置信息可以映射为C#当中的一个对象。

我们为前面使用的配置文件定义实体类内容如下:

public class Class
{
    public string ClassName { get; set; }
    public Master Master { get; set; }
    public IEnumerable<Student> Students { get; set; }
}
public abstract class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}
public class Master : Person{}
public class Student : Person{}

Microsoft.Extensions.Configuration.Binder为IConfiguration扩展了三个Bind()方法，其作用是尝试将给定的配置信息映射为一个对象。

4.1 .Net Core

var cls = new Class();
config.Bind("Class",cls); // 执行完成后配置文件内容将映射到cls对象中
// config.Bind("Class",cls,options=>options.BindNonPublicProperties=true); // 通过设置binderOptions可以支持绑定私有属性

4.2 Asp.Net Core

Asp.Net Core中默认包含了需要的Nuget包，在Startup.cs中直接使用Configuration.Bind()即可获得配置映射的Class对象，如需在其他位置使用此配置对象，需要手动将其注册到服务列表中。

public void ConfigureServices(IServiceCollection services)
{
    // other services ...
    var cls = new Class();
    Configuration.Bind("Class",cls);
    services.AddSingleton<Class>(cls); //服务注册
}

5. 自定义配置数据源

除了使用命令行、环境变量、文件等作为系统提供的配置源外，我们也可以自定义配置数据源，实现定制化配置方案。
自定义配置源只需要通过自定义类型实现IConfigurationSource接口，自定义Provider实IConfigurationProvider或集成其抽象实现类ConfigurationProvider即可。

class ColinConfigurationSource : IConfigurationSource
{
    public IConfigurationProvider Build(IConfigurationBuilder builder)
    {
        return new ColinConfigurationProvider();
    }
}
class ColinConfigurationProvider : ConfigurationProvider
{
    private Timer _timer;
    public ColinConfigurationProvider()
    {
        _timer = new Timer {Interval = 3000};
        _timer.Elapsed += (s, e) => Load(true);
        _timer.Start();
    }
    public override void Load() => Load(false);
    private void Load(bool reload)
    {
        //模拟配置动态更新
        Data["LastUpdatedTime"] = DateTime.Now.ToString();
        if (reload)
            OnReload();
    }
}
// 在系统配置命名空间下扩展 AddColinConfiguration 方法，方便使用且可防止自定义配置类型暴露
namespace Microsoft.Extensions.Configuration
{
    public static class ColinConfigurationExtension
    {
        public static IConfigurationBuilder AddColinConfiguration(this IConfigurationBuilder builder)
        {
            builder.Add(new ColinConfigurationSource());
            return builder;
        }
    }
}

自定义配置源完成后，可以通过以下方式使用。

static void Main(string[] args)
{
    var builder = new ConfigurationBuilder();
    builder.AddColinConfiguration(); //使用自定义配置源
    var configurationRoot = builder.Build();
    //Console.WriteLine(configurationRoot["LastUpdatedTime"]);
    ChangeToken.OnChange(
        () => configurationRoot.GetReloadToken(),
        () => Console.WriteLine(configurationRoot["LastUpdatedTime"]));
    Console.ReadKey();
}

以上代码已共享在Github: https://github.com/colin-chang/CustomConfiguration

上面案例中我们只是演示了通过赋值一个DateTime来模拟配置源变更，在实际开发中我们可以设置从Consule等配置中心远程读取配置，结合命令行和环境变量配置，就可以完成配置中心的远程方案，这意味着我们可以版本化的管理应用程序配置，这也为Docker容器化部署提供了完善的配置管理方案。

6. 配置管理工具类封装

在Asp.Net Core程序中我们可以方便的使用配置，但在其它.Net Core应用中DI并未默认被引入，我们可以考虑配置文件读取操作封装为一个工具类。考虑到配置文件热更新问题对象映射我们采用Configure<T>方式处理。

该帮助类已发布到Nuget

# Package Manager
Install-Package ColinChang.ConfigurationManager.Core 
# .NET CLI
dotnet add package ColinChang.ConfigurationManager.Core
c#配置提供者
qq_45800365的博客
08-20 696
Json 配置提供者：使用 Microsoft.Extensions.Configuration.Json 包可以从 JSON 文件中读取配置数据。这对于保存复杂的配置信息非常有用。请注意，要使用这些功能，您需要在项目中引用适当的 NuGet 包，如 Microsoft.Extensions.Configuration、Microsoft.Extensions.Configuration.Json 等。除了默认的配置提供者外，C# 配置系统还支持其他配置提供者，以便从不同的数据源中获取配置信息。
【后端】.NET Core API框架搭建（1）--配置Swagger界面和SqlSugar ORM框架
啥都不会的小码农的博客
10-28 1038
添加Swagger界面好查看调试API接口，添加SqlSugar ORM框架敏捷高效数据库互交
Net Core Configuration讲解
kusse的博客
10-27 1405
Net Core Configuration基础讲解
Microsoft.Extensions.Configuration 中检测到版本冲突
路漫漫 修远兮
11-02 692
2.YYY.YYYYY.YYYYY-> Microsoft.Extensions.Configuration (>= 3.0.1) 这个能不能降版本 到特定版本 Microsoft.Extensions.Configuration (>= 2.2.0 && < 2.3.0). 如果这个项目是底层帮助类项目被多个上层项目引用，显然这样搞风险很大。而 YYY.YYYYY.YYYYY 项目则需要 Microsoft.Extensions.Configuration 版本 3.0.1 或更高版本。
ASP.NET Core轻松入门Bind读取配置文件到C#实例
weixin_34261415的博客
12-12 234
首先新建一个ASP.NET Core空项目,命名为BindReader 然后 向项目中添加一个名为appsettings.json的json文件，为什么叫appsettings呢？ 打开Program.cs public class Program { public static void Main(string[...
.NET Core用数据库做配置中心加载Configuration
dotNET跨平台
03-02 1212
本文介绍了一个在.NET中用数据库做配置中心服务器的方式，介绍了读取配置的开源自定义ConfigurationProvider，并且讲解了主要实现原理。1、为什么用数据库做配置中心在开发...
精选资源
.net Core项目框架Demo
04-18
.NET Core项目框架Demo是一个用于演示如何构建和运行.NET Core应用程序的示例项目。.NET Core是微软开发的一个开源、跨平台的开发框架，可用于构建Web应用、云服务、桌面应用以及移动应用等。这个Demo旨在帮助开发者...
.net core后端框架 实战3-系统配置、自定义配置、强类型绑定
最新发布
weixin_55693845的博客
03-25 1980
当系统的默认配置无法满足特定需求时，我们可以通过新建自定义配置文件来扩展配置管理功能。使用AddJsonFile接口添加自定义配置文件，其优先级高于系统配置文件，通过优先级确保我们的自定义参数在需要时可以覆盖默认配置。//引入自定义配置文件通过分层体系（环境隔离）→ 扩展机制（自定义配置）→ 强类型化（Options模式）的三层架构，.NET配置系统实现了从开发到运维的全生命周期管理，通过系统分层配置，我们能够轻松应对不同环境的参数调整需求，实现配置的精细化管理。
精选资源
PLC通讯基础控件项目通过.NET Core3.1框架进行开发 主要用于工业控制方面
03-13
在本文中，我们将深入探讨如何使用.NET Core 3.1框架来开发PLC（可编程逻辑控制器）通讯基础控件，特别关注其在工业控制领域的应用。.NET Core是一个跨平台、高性能的开源框架，适合构建各种类型的现代化应用程序，...
精选资源
.net core api+layui基础框架系统
03-24
“CoreApi.zip”则包含.NET Core API项目的所有源代码，解压后，我们可以看到项目结构、控制器、模型、配置文件等，这些都是理解整个系统工作流程的关键。 总的来说，.NET Core API + Layui基础框架系统结合了强大...
asp.netcore 深入了解配置文件加载过程
ahilll的博客
11-16 464
前言     配置文件中程序运行中，担当着不可或缺的角色；通常情况下，使用 visual studio 进行创建项目过程中，项目配置文件会自动生成在项目根目录下，如 appsettings.json，或者是被大家广泛使用的 appsettings.{env.EnvironmentName}.json；配置文件 作为一个入口，可以让我们在不更新代码的情况，对程序进行干预和调整，那么对其加载过程的全面...
3、带你一步一步学习ASP.NET Core中的配置之Configuration
nidongla的博客
05-01 749
如果你是刚接触ASP.NET Core的学习的话，你会注意到：在ASP.NET Core项目中，看不到.NET Fraemwork时代中的web.config文件和app.config文件了。那么你肯定好奇，现在在ASP.NET Core应用程序中，是通过什么来配置我们的配置信息呢？ 下面就跟着我一起来学习了解吧，在ASP.NET Core中是如何配置我们的配置信息，如果读取配置信息的。 在ASP.NET Core 中是使用一个或者多个配置提供程序来配置我们的应用程序的。配置提...
.NET Core Configuration 配置项知识点一网打尽！
weixin_39842602的博客
06-04 1154
.NET Core Configuration 配置项知识点一网打尽！
使用Bind读取配置到C#的实例
Allec Cui的博客
03-28 1066
    在之前的一篇二级域名绑定的文章《.Net Core 二级域名绑定到指定的控制器》中，有一个小的地方是关于读取Json文件的配置信息的，当时是用了读取文件流的方式，一直以来觉得该方法太Low，昨天偶然学到一个新的东西-Bind，它可以直接读取配置到C#实例，也无需再读取文本内容，转成Json格式，再反序列化成我想要的实体了，下面稍微修改我原来的代码，用到我的项目中去。    首先修改SubD...
.Net core下的配置设置（一）——Configuration
weixin_30276935的博客
03-23 480
ASP.NET Core 中提供了一个Configuration包，用以应用配置基于配置提供程序建立的键值对。这里以json文件配置的方式，简单的介绍一下它的用法。 首先定义一个配置文件appsettings.json： {"key1":"value1","key2":-1,"subsection":{"key1":"valu...
.net core 5 入门（四）配置文件篇
a632374118的博客
03-18 613
.net core 5 入门配置文件篇1.增加配置文件解析类2.appsettings.json3.调用 配置文件篇 1.增加配置文件解析类 public class AppSetting { private static readonly object objLock = new object(); private static AppSetting instance = null; private IConfigurationRoot Con
.NET Core配置文件加载与DI注入配置数据
a963508700的博客
11-18 599
.NET Core配置文件 在以前.NET中配置文件都是以App.config / Web.config等XML格式的配置文件，而.NET Core中建议使用以JSON为格式的配置文件，因为使用起来更加方面灵活，而且可以使用.NET Core中的DI注入配置数据。 使用： 1 var config = new ConfigurationBuilder()...
.NET 5完全自配置服务
寒冰屋的专栏
01-22 403
在ASP.Core应用程序（不限于ASP.Core）中，当我们想使用DI容器中的构建时，我们需要创建服务，然后在Startup.cs的ConfigureServices方法中注册它们。我想简化它并在完全自注册服务中采用旧的M.E.F方法。 方法很简单： 使用[Service]或[SingeltonService]特性注释您的服务 调用ServiceLocator.LoadServices 获益？
利用Consul实现Asp.Net Core配置管理
ASP.NET Core是一个开源、跨平台的框架，用于构建现代的基于云的web应用程序。ASP.NET Core应用程序在运行时需要加载配置信息，这些信息可以来源于多种不同的地方，如本地配置文件、环境变量、命令行参数等。随着...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值