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

程序员文章站 2022-05-18 15:20:39

示例：ASP.NET MVC asp.net mvc已经内部实现了对配置appsettings.json文件的使用，builder默认支持热更新。使用示例：假设appsettings.json内容为： { "Logging": { "LogLevel": { "Default": "Warnin ......

示例：asp.net mvc

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

使用示例：

假设appsettings.json内容为：

    {
      "logging": {
        "loglevel": {
          "default": "warning"
        }
      },
      "allowedhosts": "*"
    }

新建一个跟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必须是公共的，不能是私有。

另外对于该模型，必须要有一个无参构造函数。

在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);
        }

在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>();
    }

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

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

示例：控制台

对于console项目，默认是没有这个dll的，需要自行从nuget安装

从nuget中安装：microsoft.aspnetcore.all （注意，末尾不是dll，而是all）

在项目中引入：microsoft.extensions.configuration; 并使用configurationbuilder来构建配置。

使用应用程序参数

在控制台项目属性中增加name和class参数：

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

使用：

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);

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

首先确保配置文件的属性：

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

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，则不会有此问题。

上一篇：康熙最爱亲姐妹！康熙一共娶过几对姐妹花？

下一篇： NetCore 下使用 DataTable 以及可视化工具

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

使用示例：

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

示例：控制台

使用应用程序参数

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

使用json文件

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

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

一个官方例子

faq

在.NET Core 3.0中的WPF中使用IOC图文教程