ABP vNext框架文档解读3-配置Part II

ccwgpt 2024-09-20 13:35 24 浏览 0 评论

环境变量

使用默认配置时，EnvironmentVariablesConfigurationProvider 会在读取 appsettings.json、appsettings.Environment.json 和用户机密之后，从环境变量键值对中加载配置。因此，从环境中读取的键值会替代从 appsettings.json、appsettings.Environment.json 和用户机密中读取的值。

: （冒号分隔符）：

所有平台上的环境变量分层键都不支持。

__（双下划线）：

受所有平台支持。例如，Bash 不支持 : 分隔符，但支持 __。
自动替换为 :

命令行

使用默认配置，CommandLineConfigurationProvider 会从以下配置源后的命令行参数键值对中加载配置：

appsettings.json 和 appsettings.Environment.json 文件。
开发环境中的应用机密。
环境变量。

默认情况下，在命令行上设置的配置值会替代通过所有其他配置提供程序设置的配置值。

分层配置数据

配置键和值

配置键：

不区分大小写。例如，ConnectionString 和 connectionstring 被视为等效键。
如果在多个配置提供程序中设置了某一键和值，则会使用最后添加的提供程序中的值。
分层键在配置 API 中，冒号分隔符 (:) 适用于所有平台。在环境变量中，冒号分隔符可能无法适用于所有平台。所有平台均支持采用双下划线 __，并且它会自动转换为冒号 :。在 Azure Key Vault 中，分层键使用 -- 作为分隔符。当机密加载到应用的配置中时，Azure Key Vault 配置提供程序会自动将 -- 替换为 :。
ConfigurationBinder 支持使用配置键中的数组索引将数组绑定到对象。

配置值：

为字符串。
NULL 值不能存储在配置中或绑定到对象。

配置提供程序

下表显示了 ASP.NET Core 应用可用的配置提供程序。

按照指定的配置提供程序的顺序读取配置源。代码中的配置提供程序应以特定顺序排列，从而满足应用所需的基础配置源的优先级。

配置提供程序的典型顺序为：

appsettings.json
appsettings.Environment.json
用户机密
使用环境变量配置提供程序通过环境变量提供。
使用命令行配置提供程序通过命令行参数提供。

通常的做法是将命令行配置提供程序添加到一系列提供程序的末尾，使命令行参数能够替代由其他提供程序设置的配置。

文件配置提供程序

FileConfigurationProvider 是从文件系统加载配置的基类。以下配置提供程序派生自 FileConfigurationProvider：

INI 配置提供程序
JSON 配置提供程序
XML 配置提供程序

INI 配置提供程序

IniConfigurationProvider 在运行时从 INI 文件键值对加载配置。

以下代码会清除所有配置提供程序并添加多个配置提供程序：

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

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.Sources.Clear();

                var env = hostingContext.HostingEnvironment;

                config.AddIniFile("MyIniConfig.ini", optional: true, reloadOnChange: true)
                      .AddIniFile(#34;MyIniConfig.{env.EnvironmentName}.ini",
                                     optional: true, reloadOnChange: true);

                config.AddEnvironmentVariables();

                if (args != null)
                {
                    config.AddCommandLine(args);
                }
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

在前面的代码中，MyIniConfig.ini 和 MyIniConfig.Environment.ini 文件中的设置会被以下提供程序中的设置替代：

环境变量配置提供程序
命令行配置提供程序。

MyIniConfig.ini 文件：

MyKey="MyIniConfig.ini Value"

[Position]
Title="My INI Config title"
Name="My INI Config name"

[Logging:LogLevel]
Default=Information
Microsoft=Warning

读取配置:

public class TestModel : PageModel
{
    // requires using Microsoft.Extensions.Configuration;
    private readonly IConfiguration Configuration;

    public TestModel(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public ContentResult OnGet()
    {
        var myKeyValue = Configuration["MyKey"];
        var title = Configuration["Position:Title"];
        var name = Configuration["Position:Name"];
        var defaultLogLevel = Configuration["Logging:LogLevel:Default"];


        return Content(#34;MyKey value: {myKeyValue} \n" +
                       #34;Title: {title} \n" +
                       #34;Name: {name} \n" +
                       #34;Default Log Level: {defaultLogLevel}");
    }
}

JSON 配置提供程序

JsonConfigurationProvider 从 JSON 文件键值对加载配置。

重载可以指定：

文件是否可选。
如果文件更改，是否重载配置。

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

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.AddJsonFile("MyConfig.json", 
                    optional: true, 
                    reloadOnChange: true);
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

前面的代码：

通过以下选项将 JSON 配置提供程序配置为加载 MyConfig.json 文件：optional: true：文件是可选的。reloadOnChange: true：保存更改后会重载文件。
读取 MyConfig.json 文件之前的默认配置提供程序。 MyConfig.json 文件中的设置会替代默认配置提供程序中的设置，包括环境变量配置提供程序和命令行配置提供程序。

通常，你不会希望自定义 JSON 文件替代在环境变量配置提供程序和命令行配置提供程序中设置的值。

以下代码会清除所有配置提供程序并添加多个配置提供程序：

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

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.Sources.Clear();

                var env = hostingContext.HostingEnvironment;

                config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                      .AddJsonFile(#34;appsettings.{env.EnvironmentName}.json", 
                                     optional: true, reloadOnChange: true);

                config.AddJsonFile("MyConfig.json", optional: true, reloadOnChange: true)
                      .AddJsonFile(#34;MyConfig.{env.EnvironmentName}.json",
                                     optional: true, reloadOnChange: true);

                config.AddEnvironmentVariables();

                if (args != null)
                {
                    config.AddCommandLine(args);
                }
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

在前面的代码中，MyConfig.json 和 MyConfig.Environment.json 文件中的设置：

会替代 appsettings.json 和 appsettings.Environment.json 文件中的设置。
会被环境变量配置提供程序和命令行配置提供程序中的设置所替代。

MyConfig.json 文件：

{
    "Position": {
        "Title": "“我的配置”标题",
        "Name": "My Config Smith"
    },
    "MyKey": "MyConfig.json Value",
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft": "Warning",
            "Microsoft.Hosting.Lifetime": "Information"
        }
    },
    "AllowedHosts": "*"
}

读取配置:

public class TestModel : PageModel
{
    // requires using Microsoft.Extensions.Configuration;
    private readonly IConfiguration Configuration;

    public TestModel(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public ContentResult OnGet()
    {
        var myKeyValue = Configuration["MyKey"];
        var title = Configuration["Position:Title"];
        var name = Configuration["Position:Name"];
        var defaultLogLevel = Configuration["Logging:LogLevel:Default"];


        return Content(#34;MyKey value: {myKeyValue} \n" +
                       #34;Title: {title} \n" +
                       #34;Name: {name} \n" +
                       #34;Default Log Level: {defaultLogLevel}");
    }
}

XML 配置提供程序

XmlConfigurationProvider 在运行时从 XML 文件键值对加载配置。

以下代码会清除所有配置提供程序并添加多个配置提供程序：

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

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.Sources.Clear();

                var env = hostingContext.HostingEnvironment;

                config.AddXmlFile("MyXMLFile.xml", optional: true, reloadOnChange: true)
                      .AddXmlFile(#34;MyXMLFile.{env.EnvironmentName}.xml",
                                     optional: true, reloadOnChange: true);

                config.AddEnvironmentVariables();

                if (args != null)
                {
                    config.AddCommandLine(args);
                }
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

在前面的代码中，MyXMLFile.xml 和 MyXMLFile.Environment.xml 文件中的设置会被以下提供程序中的设置替代：

环境变量配置提供程序
命令行配置提供程序。

MyXMLFile.xml 文件：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <MyKey>MyXMLFile Value</MyKey>
  <Position>
    <Title>Title from  MyXMLFile</Title>
    <Name>Name from MyXMLFile</Name>
  </Position>
  <Logging>
    <LogLevel>
      <Default>Information</Default>
      <Microsoft>Warning</Microsoft>
    </LogLevel>
  </Logging>
</configuration>

读取配置:

public class TestModel : PageModel
{
    // requires using Microsoft.Extensions.Configuration;
    private readonly IConfiguration Configuration;

    public TestModel(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public ContentResult OnGet()
    {
        var myKeyValue = Configuration["MyKey"];
        var title = Configuration["Position:Title"];
        var name = Configuration["Position:Name"];
        var defaultLogLevel = Configuration["Logging:LogLevel:Default"];


        return Content(#34;MyKey value: {myKeyValue} \n" +
                       #34;Title: {title} \n" +
                       #34;Name: {name} \n" +
                       #34;Default Log Level: {defaultLogLevel}");
    }
}

如果使用 name 属性来区分元素，则使用相同元素名称的重复元素可以正常工作：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <section name="section0">
    <key name="key0">value 00</key>
    <key name="key1">value 01</key>
  </section>
  <section name="section1">
    <key name="key0">value 10</key>
    <key name="key1">value 11</key>
  </section>
</configuration>

读取配置:

public class IndexModel : PageModel
{
    private readonly IConfiguration Configuration;

    public IndexModel(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public ContentResult OnGet()
    {
        var key00 = "section:section0:key:key0";
        var key01 = "section:section0:key:key1";
        var key10 = "section:section1:key:key0";
        var key11 = "section:section1:key:key1";

        var val00 = Configuration[key00];
        var val01 = Configuration[key01];
        var val10 = Configuration[key10];
        var val11 = Configuration[key11];

        return Content(#34;{key00} value: {val00} \n" +
                       #34;{key01} value: {val01} \n" +
                       #34;{key10} value: {val10} \n" +
                       #34;{key10} value: {val11} \n"
                       );
    }
}

属性可用于提供值：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <key attribute="value" />
  <section>
    <key attribute="value" />
  </section>
</configuration>

以前的配置文件使用 value 加载以下键：

key:attribute
section:key:attribute

Key-per-file 配置提供程序

KeyPerFileConfigurationProvider 使用目录的文件作为配置键值对。

键是文件名。
值包含文件的内容。
Key-per-file 配置提供程序用于 Docker 托管方案。

若要激活 Key-per-file 配置，请在 ConfigurationBuilder 的实例上调用 AddKeyPerFile 扩展方法。文件的 directoryPath 必须是绝对路径。

重载允许指定：

配置源的 Action<KeyPerFileConfigurationSource> 委托。
目录是否可选以及目录的路径。

双下划线字符 (__) 用作文件名中的配置键分隔符。例如，文件名 Logging__LogLevel__System 生成配置键 Logging:LogLevel:System。

构建主机时调用 ConfigureAppConfiguration 以指定应用的配置：

.ConfigureAppConfiguration((hostingContext, config) =>
{
    var path = Path.Combine(Directory.GetCurrentDirectory(), "path/to/files");
    config.AddKeyPerFile(directoryPath: path, optional: true);
})

内存配置提供程序

MemoryConfigurationProvider 使用内存中集合作为配置键值对。

以下代码将内存集合添加到配置系统中：

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

    public static IHostBuilder CreateHostBuilder(string[] args)
    {
        var Dict = new Dictionary<string, string>
        {
           {"MyKey", "Dictionary MyKey Value"},
           {"Position:Title", "Dictionary_Title"},
           {"Position:Name", "Dictionary_Name" },
           {"Logging:LogLevel:Default", "Warning"}
        };

        return Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.AddInMemoryCollection(Dict);
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
    }
}

读取配置:

public class TestModel : PageModel
{
    // requires using Microsoft.Extensions.Configuration;
    private readonly IConfiguration Configuration;

    public TestModel(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public ContentResult OnGet()
    {
        var myKeyValue = Configuration["MyKey"];
        var title = Configuration["Position:Title"];
        var name = Configuration["Position:Name"];
        var defaultLogLevel = Configuration["Logging:LogLevel:Default"];


        return Content(#34;MyKey value: {myKeyValue} \n" +
                       #34;Title: {title} \n" +
                       #34;Name: {name} \n" +
                       #34;Default Log Level: {defaultLogLevel}");
    }
}

abp框架

上一篇：开源项目分享-基于.Net5的快速开发框架Furion
下一篇：ABP vNext框架文档解读9-异常处理

ABP vNext框架文档解读3-配置Part II

环境变量

命令行

分层配置数据

配置提供程序

文件配置提供程序

INI 配置提供程序

JSON 配置提供程序

XML 配置提供程序

Key-per-file 配置提供程序

内存配置提供程序

相关推荐

取消回复欢迎你发表评论:

使用cheat engine修改unity游戏（cheat engine教程）

1分钟了解Tableau

钉钉打卡虚拟定位赶快点赞收藏吧!

(转载)Python爬虫框架Scrapy入门与实践

项目使用 Jfrog Artifactory 制品库

6米跨度柱子一般多大?框架结构的柱子应该设置多大?

SpringBoot的starter到底是什么?

重庆大学携手XSKY搭建智慧校园大数据&AI底座

超级硬核的钉钉模拟wifi，定位，远程打卡教程

.NET 多版本 WinForm 开源控件库 SunnyUI 技术解析与示例代码

ABP vNext框架文档解读3-配置Part II

环境变量

命令行

分层配置数据

配置提供程序

文件配置提供程序

INI 配置提供程序

JSON 配置提供程序

XML 配置提供程序

Key-per-file 配置提供程序

内存配置提供程序

相关推荐

取消回复欢迎 你 发表评论:

使用cheat engine修改unity游戏（cheat engine教程）

1分钟了解Tableau

钉钉打卡虚拟定位赶快点赞收藏吧!

(转载)Python爬虫框架Scrapy入门与实践

项目使用 Jfrog Artifactory 制品库

6米跨度柱子一般多大?框架结构的柱子应该设置多大?

SpringBoot的starter到底是什么?

重庆大学携手XSKY搭建智慧校园大数据&amp;AI底座

超级硬核的钉钉模拟wifi，定位，远程打卡教程

.NET 多版本 WinForm 开源控件库 SunnyUI 技术解析与示例代码

取消回复欢迎你发表评论:

重庆大学携手XSKY搭建智慧校园大数据&AI底座