在.NET CORE中使用配置文件：对 ConfigurationBuilder 的使用说明

最新推荐文章于 2024-05-08 22:22:20 发布
最新推荐文章于 2024-05-08 22:22:20 发布
阅读量4.2k 收藏 4
点赞数
分类专栏： NET Core跨平台+CoreCLR+C#
原文链接：https://blog.csdn.net/WuLex
版权

示例：ASP.NET MVC

asp.net mvc已经内部实现了对配置appsettings.json文件的使用，builder默认支持热更新。

使用示例：

假设appsettings.json内容为：

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*"
}
  1. 新建一个跟appsettings.json结构保持一致的类，如：
namespace webapp.Models
{
    public class AppsettingsModel
    {
        public Logging Logging { get; set; }

        public string AllowedHosts { get; set; }
    }

    public class Logging
    {
        public LogLevel LogLevel { get; set; }
    }

    public class LogLevel
    {
        public string Default { get; set; }
    }
}

PS：

  • 需要注意，用于IOptions或者IOptionsSnapshot中的模型的各个属性，其setter必须是公共的，不能是私有。
  • 另外对于该模型，必须要有一个无参构造函数。
  1. 在Startup.cs中进行依赖注入
public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });
    // 依赖注入
    services.Configure<AppsettingsModel>(Configuration);
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}
  1. 在controller中调用：
public class TestController : Controller
{
    private readonly AppsettingsModel _appsettingsModel;
    //若要使用热更新，则入参调整为 IOptionsSnapshot<T>
    public TestController(IOptions<AppsettingsModel> appsettingsModel)
    {
        _appsettingsModel = appsettingsModel.Value;
    }

    public IActionResult Index()
    {
        return View("Index", _appsettingsModel.Logging.LogLevel.Default);
    }
}

这里需要注意一点，DI时，如果是单例，则无法使用是IOptionsSnapshot，会报错。

如何覆写默认行为？如取消热更新支持，方法如下：

假设测试controller为

public class TestController : Controller
{
    private readonly AppsettingsModel _appsettingsModel;
    //使用的是：IOptionsSnapshot<T>
    public TestController(IOptionsSnapshot<AppsettingsModel> appsettingsModel)
    {
        _appsettingsModel = appsettingsModel.Value;
    }

    public IActionResult Index()
    {
        return View("Index", _appsettingsModel.Logging.LogLevel.Default);
    }
}

Program.cs

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((context, config) => //1.通过该方法来覆盖配置
            {
                //2.重新添加json配置文件
                config.AddJsonFile("appsettings.json", false, false); //3.最后一个参数就是是否热更新的布尔值
            })
            .UseStartup<Startup>();
}

在这里插入图片描述

  • 这个时候，人为将热更新给关闭了，此时更新json文件后，修改后的内容不会更新到系统中。

示例：控制台

对于console项目，默认是没有这个dll的，需要自行从nuget安装
从nuget中安装：Microsoft.AspNetCore.All （注意，末尾不是dll，而是all）
在项目中引入：Microsoft.Extensions.Configuration; 并使用ConfigurationBuilder来构建配置。

使用应用程序参数

在控制台项目属性中增加name和class参数：
在这里插入图片描述
使用：

class Program
{
    static void Main(string[] args)
    {
        var builder = new ConfigurationBuilder()
            .AddCommandLine(args);
        var configuration = builder.Build();

        Console.WriteLine($"name:{configuration["name"]}"); //name:CLS
        Console.WriteLine($"class:{configuration["class"]}");   //class:Class_A

        Console.Read();
    }
}

使用键值对枚举（这里以字典来说明）

    class Program
    {
                static void Main(string[] args)
                {
                    var dict = new Dictionary<string, string>
                    {
                        {"name","MC"},
                        {"class","CLASS_MC"}
                    };
                    var builder = new ConfigurationBuilder()
//                    .AddCommandLine(args)
                    .AddInMemoryCollection(dict);
        
                    var configuration = builder.Build();
        
                    Console.WriteLine($"name:{configuration["name"]}");//name:MC
                    Console.WriteLine($"class:{configuration["class"]}");  //class:CLASS_MC
        
                    Console.Read();
                }
    }

注意事项：

这里需要注意下，虽然 AddCommandLine 和 AddInMemoryCollection 可以同时调用，但不同的使用次序，效果是不一样的（后一个会覆盖前一个的内容—浅覆盖），如：

 /*
    假设 在项目属性中，定义的内容为：name=CLS，class=CLASS_CLS，grade="mygrade"
    在代码中，dict的内容为：name=MC，class=CLASS_MC
 */
//对于代码：
var builder = new ConfigurationBuilder()
                    .AddCommandLine(args)
                    .AddInMemoryCollection(dict);
                    var configuration = builder.Build();
        
                    Console.WriteLine($"name:{configuration["name"]}");//name:MC
                    Console.WriteLine($"class:{configuration["class"]}");  //class:CLASS_MC
                    Console.WriteLine($"grade:{configuration["grade"]}");  //grade:mygrade
                    
//对于代码：
var builder = new ConfigurationBuilder()                    
                    .AddInMemoryCollection(dict)
                    .AddCommandLine(args);
                    var configuration = builder.Build();
        
                    Console.WriteLine($"name:{configuration["name"]}");//name:CLS
                    Console.WriteLine($"class:{configuration["class"]}");  //class:CLASS_CLS
                    Console.WriteLine($"grade:{configuration["grade"]}");  //grade:mygrade

另外，需要注意，如果用dotnet命令来执行CommandLineSample.dll，那么“应用程序参数”需要直接跟在命令的后面，如：
另外如果AddInMemoryCollection和AddCommandLine同时使用，那么需要将AddCommandLine最后调用，否则一旦被覆盖了，再用dotnet来调用，会没有效果。

 dotnet   CommandLineSample.dll   name=111 class=222  grade="my grade"

使用JSON文件

  • 在项目根目录创建“jsconfig1.json”，同时修改该文件的属性：
    • 复制到输出目录：始终复制
    • 生成操作：内容

JSON文件内容：

{
      "Class": "Class A",
      "PersonInfo": {
            "name": "my name",
            "age": "12"
      },
      "Hobbies": [
            {
                  "Type": "Family",
                  "HobbyName": "Piano"
            },
            {
                  "Type": "Personal",
                  "HobbyName": "Singing"
            }
      ]
}

代码：

static void Main(string[] args)
{
    var builder = new ConfigurationBuilder()
        .AddJsonFile("jsconfig1.json");

    var configuration = builder.Build();

    Console.WriteLine($"name:{configuration["PersonInfo:name"]}");
    Console.WriteLine($"class:{configuration["class"]}");
    Console.WriteLine($"age:{configuration["PersonInfo:age"]}");
    //注意下调用参数时的格式："{参数Key}:{数组索引}:{子项参数Key}"
    Console.WriteLine($"FamilyHobby:{configuration["Hobbies:0:HobbyName"]}");
    Console.WriteLine($"PersonalHobby:{configuration["Hobbies:1:HobbyName"]}");

    Console.Read();
}

注册配置文件中的某一个段到一个class模型中

引用上面的json：

{
      "Class": "Class A",
      "PersonInfo": {
            "name": "my name",
            "age": "12"
      },
      "Hobbies": [
            {
                  "Type": "Family",
                  "HobbyName": "Piano"
            },
            {
                  "Type": "Personal",
                  "HobbyName": "Singing"
            }
      ]
}

如何在注册的时候希望将PersonInfo这个section单独注入到 PersonInfo.cs类中？（以mvc为例）

PersonInfo.cs

public class PersonInfo
{
    public string Name {get;set;}
    public int Age{get;set;}
}

Startup.cs

        public void ConfigureServices(IServiceCollection services)
        {
            services.Configure<CookiePolicyOptions>(options =>
            {
                options.CheckConsentNeeded = context => true;
                options.MinimumSameSitePolicy = SameSiteMode.None;
            });
            // 依赖注入
            services.Configure<PersonInfo>(Configuration.GetSection("PersonInfo"));

            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        }

在controller中使用：

public class TestController : Controller
{
    private readonly PersonInfo   _personInfo;
    public TestController(IOptions<PersonInfo> personInfo)
    {
        _personInfo = _personInfo.Value;
    }

    public IActionResult Index()
    {
        return View("Index", _personInfo.Name);
    }
}

在 startup.cs中使用

//jwt           
services.Configure<JwtSettings>(Configuration.GetSection("JwtSettings"));

var jwtSettings = new JwtSettings();
Configuration.Bind("JwtSettings", jwtSettings);
services.AddSanbenTechJwtService(jwtSettings.Issuer, jwtSettings.Audience);

示例：在单元测试中使用 配置文件

首先确保配置文件的属性：
在这里插入图片描述
nuget安装、引入必要的库：

Microsoft.Extensions.Configuration
Microsoft.Extensions.Configuration.Binder
Microsoft.Extensions.Configuration.Json

在构造函数中使用配置文件：

public UnitTest1()
{
    var builder = new ConfigurationBuilder()
        .AddJsonFile("appsettings.json");
    var configuration = builder.Build();
    var settings = configuration.GetSection("RedisSettings").Get<RedisSettings>();
    _mock.Setup(p => p.Value).Returns(settings);
}

一个官方例子

https://docs.microsoft.com/zh-cn/aspnet/core/security/app-secrets?view=aspnetcore-2.2&tabs=windows

{
  "Movies": {
    "ServiceApiKey": "12345",
    "ConnectionString": "Server=(localdb)\\mssqllocaldb;Database=Movie-1;Trusted_Connection=True;MultipleActiveResultSets=true"
  }
}

配置模型：

public class MovieSettings
{
    public string ConnectionString { get; set; }

    public string ServiceApiKey { get; set; }
}

//使用
var moviesConfig = Configuration.GetSection("Movies").Get<MovieSettings>();
_moviesApiKey = moviesConfig.ServiceApiKey;

FAQ

  • 在使用AddJsonFile的时候，被添加的json文件需要在项目所处根目录内，否则不会加载（路径默认是到项目文件夹，而非bin目录下）。打包发布后会自动从发布文件夹找对应的配置文件
  • 这里主要是为了应对新建了一个项目A，然后在这个项目A中添加了一个配置文件config.json，项目B引用这个项目A后，虽然最终编译之后会在bin文件夹内自动生成config.json，但是在调试模式下，默认的路径是在项目路径，而非bin下的文件夹路径，这会导致config.json在开发模式下（调试时）不会被加载。
    - 可以手动将改config.json文件复制一份到项目B根目录内。
    - 如果是用nuget发布项目A后，项目B再从nuget安装项目A，则不会有此问题。
.NET跨平台
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
.net core 6 开发随写
k195514239的博客
12-09 1032
.net core 开发随写
MicrosoftConfigurationBuilders:Microsoft.Configuration.Builders
05-06
配置构建器 配置生成器是.Net 4.7.1中引入的完整.Net Framework的新功能。 您可以在了解有关此概念的。 通过此项目，Microsoft提供了一组基本的配置生成器，这些配置生成器应使开发人员可以轻松地在其应用程序中利用此功能。 它们还旨在满足应用程序进入容器和云环境时的一些基本动态/非本地配置需求。 该自述文件已经很长了，因此这里是一个快速的目录表： V2更新： 第2版​​具有一些新功能： Azure应用程序配置支持-有一个新的生成器，用于从新的Azure应用程序配置服务中绘制值。 AppSettings中的ConfigBuilder参数-这是这些配置生成器中最需要的功能之一。 使用V2，现在可以从appSettings读取配置构建器的初始化参数。 在这里阅读更多有关它的信息。 延迟初始化-作为启用从appSettings提取配置参数的工作的一部分，这些键/值
.NET Core 2.0 Console(控制台)项目 Microsoft.Extensions.Logging NLog配置使用
最新发布
weixin_42098295的博客
05-08 829
NET Core 2.0 控制台应用程序中使用与 NLog 进行日志记录，涉及几个关键步骤：配置 NLog，设置日志提供者，以及在你的代码中使用日志。
.net core ConfigurationBuilder
dxm809的博客
10-10 452
namespace Microsoft.Extensions.Configuration { public class ConfigurationBuilder : IConfigurationBuilder { public IList<IConfigurationSource> Sources { get; } = new List<IConfigurationSource>(); p.
Configuration与Builder模式
weixin_33921089的博客
01-31 339
使用Hibernate的第一个步骤是要对其进行配置： Configuration cfg = new Configuration()    .addFile("Vertex.hbm.xml")    .addFile("Edge.hbm.xml"); net.sf.hibernate.cfg.Configuration的一个实例代表了应用程序中所有的Java类到关系数据库的映射的集合在Co...
.NET Core 配置Configuration杂谈
极客神殿
12-01 1027
前言 .NET Core 在配置文件的操作上相对于.NET Framework做了不少改变，今天来聊一聊。关于Configuration的Package都是以Microsoft.Extensions.Configuration开头的支持多种方式的配置，包括内存、Json文件、XML文件等等，今天我们主要用Json格式文件配置来演示。 开始 新建一个ConsoleApp（这里为了方便演示就用控制台程序来演示了，而不用ASP.NET Core），添加两个Package： Install-Package Micr
Builder模式与Configuration
yollywu的专栏
01-14 303
摘自:http://www.jdon.com/designpatterns/builder.htm Builder模式定义: 将一个复杂对象的构建与它的表示分离,使得同样的构建过程可以创建不同的表示. Builder模式是一步一步创建一个复杂的对象,它允许用户可以只通过指定复杂对象的类型和内容就可以构建它们.用户不知道内部的具体构建细节.Builder模式是非常类似抽象工厂模式,细微的区...
如何在ASP.NET Core类库项目中读取配置文件详解
10-19
在ASP.NET Core中，配置文件的管理是一个关键的方面，特别是在构建类库项目时，我们需要有效地读取和使用这些配置。在.NET Core之前，配置通常存储在web.config文件中，但现在，配置文件通常是JSON格式，如...
Asp.Net Core轻松学习系列之配置文件
10-17
在Asp.Net Core框架中，配置文件扮演着至关重要的角色，它们用于存储应用程序的各种设置，以便在运行时读取和使用。与传统的.NET Framework不同，.NET Core采用JSON格式的配置文件，使得配置更加灵活且易于理解和...
.net core读取json配置文件示例源码
04-24
在.NET Core中，读取JSON配置文件是常见的任务，尤其对于构建可配置的应用程序来说更是不可或缺。本示例源码展示了如何在.NET Core控制台应用程序中实现这一功能。JSON（JavaScript Object Notation）配置文件因其...
ASP.NET Core如何自定义配置源示例详解
10-15
在ASP.NET Core中，配置管理是一个关键部分，它允许开发者轻松地读取和使用应用程序的配置信息。本篇文章将深入探讨如何在ASP.NET Core中自定义配置源，以满足特定的配置需求。 首先，我们要理解ASP.NET Core的配置...
.NET Core开发之配置详解
08-27
本文将对.NET Core中的配置详解进行讲解，包括配置文件的存储、读取方式和ConfigurationManager的使用。 在传统的ASP.NET框架中，配置文件通常是web.config文件，该文件用于存储应用程序的配置参数。开发者可以在...
[享学Archaius] 六、Apache Commons Configuration2.x别样的Builder模式：ConfigurationBuilder
架构师：通透，才能写出好代码！
02-20 937
在文初已经知道：`Configuration`是最最最重要的接口，所以构建它的实例自然就非常重要。 在1.x时，绝大多数情况下均使用`new`的方式来创建`Configuration`实例，而作为“更时髦”的2.x版本，显然得尽量避免出现`new`关键字，那么怎么办？这就是本文要介绍的Builder模式。 `Builder`模式相信大家已经很熟悉了，虽然`ConfigurationBuilder`接口在1.x版本里也存在，但是一般情况下并不使用它。而2.x版本对它进行了全新的设计，并且提供了更多的实用子类
NET CORE Configuraion 使用详解
qq_32109957的博客
11-23 757
3、DOTNET_ 和 ASPNETCORE_ 前缀会由 ASP.NET Core 用于主机和应用配置，但不用于用户配置，详细介绍可以参考：https://learn.microsoft.com/zh-cn/aspnet/core/fundamentals/host/generic-host?注意：需要设置tsconfig.json文件的属性为【如果较新则复制】或【者始终复制】1、test_ 前缀的环境变量会被加载到程序，如果没有前缀会加载所有环境变量。结论：后添加的配置提供程序中的配置覆盖会之前的配置。
【自用】mybatis学习笔记-ConfigBuilder 解析配置文件（第三天）
qq_42765493的博客
04-25 788
底层逻辑 我之前敲了一遍简单实现spring的源码实现，受益匪浅，可以说完整的理解了一遍源码。 那么mybatis我也应该敲一遍实现过程，但是我时间太紧了，自己内耗的都够呛，很难说，再去静下心敲源码，先做到我自己最好吧，看看情况再去说 ...
.Net 配置系统入门
每天学习一点点
11-28 1301
.Net中的配置系统支持丰富的配置源,包括文件(json、xml、ini等)、注册表、环境变量、命令行、azure key vault等，还可以配置自定义配置源。可以跟踪配置的改变，可以按照优先级覆盖。 传统项目一般是从web.config文件中读取配置项的值，配置项一般是xml格式。如下图所示： 这种配置方式有一个弊端，当配置项比较复杂时，比如有多个层级，一层层嵌套，看起来非常不直观。这时候用json格式的配置就显得很方便。下面用代码示例展示json格式配置文件的基本用法(代码基于.NetCo
ConfigurationBuilder 读取文件
weixin_39578505的博客
08-12 1679
IConfigurationBuilder builder = new ConfigurationBuilder(); builder.SetBasePath(@"D:\c#\ConsoleApp29\ConsoleApp29");//设置路径 builder.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);//读取文件 var configura.
利用Build Configuration来配置多环境
西瓜的博客
05-06 1404
利用Build Configuration来配置多环境 1.下面第一个链接里 新建Scheme这个步骤可以省略 2.注意新建configuration记得pod install一下； 3.每个环境最好都要有debug和release环境 https://www.jianshu.com/p/83b6e781eb51 https://www.jianshu.com/p/b38052ee56af ===...
ASP.NET Core 的本地配置文件写入
06-07
ASP.NET Core 的本地配置文件通常是通过 JSON 格式存储的。要写入本地配置文件，可以使用 .NET Core 提供的 IConfiguration 接口和 ConfigurationBuilder 类。 以下是一个示例代码，演示如何将一个键值对写入本地配置文件： ```csharp using Microsoft.Extensions.Configuration; using System.IO; // 创建 ConfigurationBuilder 对象 var builder = new ConfigurationBuilder() .SetBasePath(Directory.GetCurrentDirectory()) .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true); // 读取配置文件 var configuration = builder.Build(); // 将一个键值对写入配置文件 configuration["MyKey"] = "MyValue"; // 保存配置文件 using (var stream = new FileStream("appsettings.json", FileMode.Create)) { configuration.Save(stream); } ``` 在上面的示例代码中，我们首先创建了一个 ConfigurationBuilder 对象，并指定了要读取的配置文件路径。然后，通过 Build 方法读取配置文件内容，将一个键值对写入配置文件，最后使用 Save 方法保存配置文件。 需要注意的是，如果要写入本地配置文件，必须拥有写入文件的权限。此外，如果配置文件不存在，也会抛出异常。因此，在实际使用中需要进行相应的异常处理。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值