ASP.NET Core : 二十二. 多样性的配置方式(一)

简介: 大多数应用都离不开配置,本章将介绍ASP.NET Core中常见的几种配置方式及系统内部实现的机制。 说到配置,第一印象可能就是“.config”类型的xml文件或者“.ini”类型的ini文件,在ASP.NET Core 中,常用的配置文件类型为JSON。比如项目根目录中的appsettings.json和appsettings.Development.json两个文件。实际上,ASP.NET Core支持多种配置方式,除了采用JSON文件的方式外,还支持内存、命令行等方式。

一、文件方式

这是最常见的方式,ASP.NET Core支持多种格式的配置文件,例如常见的JSON、XML、INI等格式的文件。

首先看一下项目默认创建的配置文件appsettings.json,其内容默认如下:

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*"
}

这个文件会在系统启动的时候自动被加载(加载发生在Program文件的CreateWebHostBuilder方法中,下一节会详细说明),默认内容主要是对Log的配置。

举个例子,需要在配置文件中设置应用的主题,例如颜色风格等。向文件末尾添加如下内容:

 "Theme": {
    "Name": "Blue",
    "Color": "#0921DC"
  }

用通过这样的代码设置了系统的主题和对应的色值。那么这个值是如何被获取并使用的呢?以默认的HomeController为例,新建一个名为“GetConfiguration”的Action来演示Configuration值的获取。代码如下:

privatereadonlyIConfiguration _configuration;
publicHomeController(IConfiguration configuration)
{
    _configuration = configuration;
}
publicContentResult GetConfiguration()
{
    returnnewContentResult() { Content = $"Theme Name:{ _configuration["Theme:Name"] },Color:{_configuration["Theme:Color"]}"};
}

在构造方法中通过依赖注入的方式获取到了一个IConfiguration,并在Action中通过这个IConfiguration获取到了appsettings.json中设置的值。可以看出,在获取值的时候,是通过“:”符号来体现JSON的层级关系体现的。例如获取“Color”的值,对应的表达式为“_configuration["Theme:Color"]”。这是因为整个JSON会被处理为一个个的Key-Value的格式,本例的“Theme”的两个值会被分解为如下格式:

8.png

这里有两个说明,第一,“Key”不区分大小写,即写为“theme:color”也是等效的;第二,约定“Value”值是字符串格式。

除了上例中的获取方式,还可以通过GetValue方法获取。

_configuration.GetValue<string>("Theme:Color","#000000")

含义是将获取到的值转换为string类型,如果获取失败则返回默认值“#000000”。


本例演示了系统默认的appsettings.json文件中的内容被自动载入,那么如何将自定义的JSON文件中的内容应用到系统的配置中去呢?


新建一个名为“Theme.json”的文件,同样再预设一个红色主题,代码如下:

{
  "Theme": {
    "Name": "Red",
    "Color": "#FF4500"
  }
}

由于这个自定义的“Theme.json”不会被自动载入,需要手动将其添加到系统的配置中去,在讲应用系统的启动的时候说过,配置是在Program文件的CreateDefaultBuilder方法中被加载的,可以在其之后继续通过ConfigureAppConfiguration方法继续设置。例如如下代码:

publicstaticIWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((hostingContext,config)=> {
        config.SetBasePath(Directory.GetCurrentDirectory());
        varpath = Path.Combine(Directory.GetCurrentDirectory(), "Theme.json");
        config.AddJsonFile(path, optional: false, reloadOnChange: true);
    })
    .UseStartup<Startup>();
}

首先通过SetBasePath方法设置了基路径,然后通过AddJsonFile方法添加“Theme.json”文件,这个方法有3个参数,第一个是“Theme.json”所在的位置,第二个设置此文件是否可选,第三个设置当此文件被修改后,是否自动重新加载该文件。


再次访问home/GetConfiguration,返回的结果如下:

Theme Name:Red,Color:#FF4500

这是因为后添加的Theme.json文件中的Theme值覆盖了appsettings.json文件中的Theme值。这涉及到各种配置设置方式的优先级问题,在下一节会讲。


说完了将JSON格式的文件用作配置的例子,再看看如何采用INI格式的。新建一个名为Theme.ini的文件,为了不覆盖之前设置的Theme,本例将Theme改为了ThemeGreen。

[ThemeGreen]
Name=Green
Color=#76EE00

通过ConfigureAppConfiguration方法将这个INI文件添加到配置中去。

var pathIni = Path.Combine(Directory.GetCurrentDirectory(), "Theme.ini");
config.AddIniFile(pathIni, optional: false, reloadOnChange: true);

修改Action中读取配置的Key,将对应的将Theme改为ThemeGreen:

1.publicContentResult GetConfiguration()
{
    returnnewContentResult() { Content = $"Theme Name:{ _configuration["ThemeGreen:Name"] },Color:{_configuration.GetValue<string>("ThemeGreen:Color", "#000000")}"};
}

再次访问home/GetConfiguration,返回的结果如下:

Theme Name:Green,Color:#76EE00

上面介绍了JSON和INI两种格式的文件的应用,除了二者文件格式的不同以及被添加到配置时采用的方法不同(分别采用了AddJsonFile和AddIniFile方法),在其他环节二者的使用方式均是一样的。同理,对于XML格式的文件,有一个对应的AddXmlFile方法,其他环节和JSON、INI文件的应用也是一样的,此处就不再举例描述。


目录
相关文章
|
16天前
|
开发框架 .NET 开发者
简化 ASP.NET Core 依赖注入(DI)注册-Scrutor
Scrutor 是一个简化 ASP.NET Core 应用程序中依赖注入(DI)注册过程的开源库,支持自动扫描和注册服务。通过简单的配置,开发者可以轻松地从指定程序集中筛选、注册服务,并设置其生命周期,同时支持服务装饰等高级功能。适用于大型项目,提高代码的可维护性和简洁性。仓库地址:&lt;https://github.com/khellang/Scrutor&gt;
37 5
|
1月前
|
开发框架 .NET C#
在 ASP.NET Core 中创建 gRPC 客户端和服务器
本文介绍了如何使用 gRPC 框架搭建一个简单的“Hello World”示例。首先创建了一个名为 GrpcDemo 的解决方案,其中包含一个 gRPC 服务端项目 GrpcServer 和一个客户端项目 GrpcClient。服务端通过定义 `greeter.proto` 文件中的服务和消息类型,实现了一个简单的问候服务 `GreeterService`。客户端则通过 gRPC 客户端库连接到服务端并调用其 `SayHello` 方法,展示了 gRPC 在 C# 中的基本使用方法。
42 5
在 ASP.NET Core 中创建 gRPC 客户端和服务器
|
24天前
|
开发框架 缓存 .NET
GraphQL 与 ASP.NET Core 集成:从入门到精通
本文详细介绍了如何在ASP.NET Core中集成GraphQL,包括安装必要的NuGet包、创建GraphQL Schema、配置GraphQL服务等步骤。同时,文章还探讨了常见问题及其解决方法,如处理复杂查询、错误处理、性能优化和实现认证授权等,旨在帮助开发者构建灵活且高效的API。
26 3
|
2月前
|
开发框架 JavaScript 前端开发
一个适用于 ASP.NET Core 的轻量级插件框架
一个适用于 ASP.NET Core 的轻量级插件框架
|
前端开发 .NET Linux
|
前端开发 .NET Linux
【翻译】Asp.net Core介绍
ASP.NET Core is a significant redesign of ASP.NET. This topic introduces the new concepts in ASP.NET Core and explains how they help you develop modern web apps. Asp.net Core是重新设计过得新一代Asp.Net。
1190 0
|
3月前
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
51 7
|
3月前
|
存储 开发框架 前端开发
ASP.NET MVC 迅速集成 SignalR
ASP.NET MVC 迅速集成 SignalR
82 0
|
4月前
|
开发框架 前端开发 .NET
ASP.NET MVC WebApi 接口返回 JOSN 日期格式化 date format
ASP.NET MVC WebApi 接口返回 JOSN 日期格式化 date format
60 0
|
4月前
|
开发框架 前端开发 安全
ASP.NET MVC 如何使用 Form Authentication?
ASP.NET MVC 如何使用 Form Authentication?

相关实验场景

更多