自己造轮子是一件苦差事。 现在，您可以专注于业务开发，仅需集成 ⭐️Furion⭐️ 即可。
Skip to main content

4.1 配置

温馨提示

推荐使用 《4.2 选项》代替本章节功能。（为什么）？

自定义配置特别注意

如：xxxx.json，必须在 VS Studio 中右键属性设置 复制输出目录为如果较新则复制，生成操作为：内容。

如果 .json 文件配置在多个项目层，也必须保证命名唯一，不然编译后出现相互覆盖的情况。

4.1.1 什么是配置​

简单来说，配置将系统应用可动态调配的选项放在统一地方管理，通过不同的配置让系统做出动态调整。

在 ASP.NET Core 应用程序启动时默认加载 启动项目 下的 appsettings.json 作为应用配置。同时还支持不同的运行环境加载对应的配置文件，如：

  • Development：加载 appsettings.Development.json
  • Staging：加载 appsettings.Staging.json
  • {Environment}：appsettings.{Environment}.json

4.1.2 配置的使用​

假设我们需要在系统运行时获取系统名称、版本号及版权信息，这些信息可能随时变化而且需要在多个地方使用。这时就需要将这些信息配置起来。具体步骤如下：

4.1.2.1 配置 appsettings.json 信息​

{
  "AppInfo": {
    "Name": "Furion",
    "Version": "1.0.0",
    "Company": "Baiqian"
  }
}
特别注意

appsettings.json 复制输出目录为如果较新则复制，生成操作为：内容。

另外，某些 linux 系统不支持读取带 注释 的 json 文件，直接读取将会报错。需要将 json 内的注释全部 删除 才能正常读取。

4.1.2.2 读取 appsettings.json 信息​

在 Furion 框架中，提供了两种读取方式：

  • 依赖注入 IConfiguration 对象读取
  • 通过 App.Configuration[path] 读取
using Microsoft.AspNetCore.Mvc;

namespace Furion.Web.Entry.Controllers
{
    [Route("api/[controller]")]
    public class DefaultController : ControllerBase
    {
        [HttpGet]
        public string Get()
        {
            return $@"名称：{App.Configuration["AppInfo:Name"]}，
                      版本：{App.Configuration["AppInfo:Version"]}，
                      公司：{App.Configuration["AppInfo:Company"]}";
        }
    }
}
依赖注入的方式

通过依赖注入注入实例有几种方式：

  • 构造函数注入方式
private readonly IConfiguration _configuration;
public DefaultController(IConfiguration configuration)
{
    _configuration = configuration;
}
  • 参数注入方式 [FromServices]
public string Get([FromServices] IConfiguration configuration)
{
}
  • 属性注入方式
public IConfiguration Configuration { get; set; }

想了解更多关于《ASP.NET Core - 依赖注入》 知识

4.1.2.3 如何选择读取方式​

  • 在可依赖注入类中，依赖注入 IConfiguration 读取
  • 在静态类/非依赖注入类中，选择 App.Configuration[path] 读取

4.1.3 路径符 查找节点​

在 ASP.NET Core 中，配置采用 : 分隔符来读取分层配置数据。如上述例子中的 AppInfo:Name。如有更多层级数据则只需要通过 : 进入下一层节点即可。

假设我们有以下配置信息：

{
  "AppInfo": {
    "Name": "Furion",
    "Version": "1.0.0",
    "Company": {
      "Name": "Baiqian",
      "Address": {
        "City": "中国",
        "Province": "广东省",
        "Detail": "中山市东区紫马公园西门"
      }
    }
  }
}
var companyName = App.Configuration["AppInfo:Name"]; // => Furion

4.1.3.1 查找数组节点​

有些时候我们需要或者数组特定的某些，可以通过 App.Configuration["array:0"] 获取，0 是索引数字。

4.1.4 自定义配置文件​

XML 配置说明

Furion v2.8.0 版本移除了 .xml 文件自动扫描配置了，改为手动添加配置。

大多情况下，我们的配置只需要在 appsettings.json 中配置即可，但一些特殊情况下，我们希望某些组件或功能拥有独立的配置，这个时候就需要用到自定义配置，Furion 目前支持 .json 和 .xml 两种方式配置，如：

Furion.Web.Entry/emailsetting.json
{
  "outlook": {
    "smtp": {
      "server": "smtp.office365.com",
      "port": "587",
      "ssl": "STARTTLS"
    },
    "pop": {
      "server": "outlook.office365.com",
      "port": "995",
      "ssl": "TLS"
    }
  }
}
<?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>
xml 配置事项

如果采用 xml 配置，那么文件名必须以 .config.xml 结尾（不区分大小写）。

特别说明

Furion 框架会在启动时自动扫描每一个项目层根目录下的 *.json 文件加入配置中，所以无需手工配置。

新增 *.json 文件的属性 复制到输出目录 设置为始终复制或较新复制，否则不会载入。另外配置文件不能出现重名，也就是保证整个项目中配置文件名字唯一。比如不能在非 Web 其他层定义 appsettings.json 文件。

在 v2.16.7+ 版本版本之后，支持自定义配置扫描目录：

{
  "ConfigurationScanDirectories": ["目录1名称", "目录1名称/子目录名称"]
}

同时 Furion 提供了非常灵活的方式支持自定义配置文件读取，如：

4.1.4.1 读取 emailsetting.json 配置​

读取自定义配置文件和读取 appsettings.json 一致，系统会自动从多个配置文件中读取输入，如：

var smtpServer = App.Configuration["outlook:smtp:server"]; // => smtp.office365.com

4.1.4.2 排除特定配置文件​

有些时候，我们不需要 .json 或 .xml 自动载入配置中，我们只需要在启动层 appsettings.json 中添加 IgnoreConfigurationFiles 节点即可：

{
  "IgnoreConfigurationFiles": ["runtime.json"]
}

4.1.5 不同环境读取​

在实际应用开发中，我们可能会根据不同的环境加载不同的配置文件，如 数据库连接字符串。

这时我们只需要遵循特定命名规范 {name}.{Environment}.json 即可。如：

  • appsettings.Development.json
  • appsettings.Staging.json
  • appsettings.Production.json
  • emailsetting.Development.json
  • emailsetting.Staging.json
  • emailsetting.Production.json

这时，ASP.NET Core 会在应用启动时自动加载不同环境的配置文件。

4.1.6 配置更改通知（热更新）​

在 .NET Core 应用程序中，配置支持更改通知，也就是热更新操作。一旦监听到 appsetting.json 或自定义配置文件发生变动，就会触发 OnChange 方法。代码如下：

var appInfoConfiguration = App.Configuration.GetSection("AppInfo");
ChangeToken.OnChange(() => App.Configuration.GetReloadToken(), () =>
{
  var name = appInfoConfiguration["Name"];  // 实时的最新值
  var version = appInfoConfiguration["Version"];  // 实时的最新值
});
监听对象

如果监听全局配置文件传入 App.Configuration.GetReloadToken()，如果只需要监听特定节点，传入 App.Configuration.GetSection("AppInfo")

4.1.7 手动添加配置文件​

有些时候，我们的配置文件没有放在项目的根目录下，这时候我们需要手动载入自定义配置文件，只需要在 Program.cs 中加载即可：

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>();
            });
}
补充说明
  • 获取项目目录：AppContext.BaseDirectory
  • 获取网站根目录：Directory.GetCurrentDirectory()

4.1.8 配置的优缺点​

  • 优点

    • 能够在系统运行时快速读取
    • 无需额外配置

  • 缺点

    • 存在重复读取
    • 通过硬编码字符串读取，容易出错
    • 不能设置默认值
    • 不能在运行环境中动态配置
    • 不能验证配置有效性
    • 不支持更改通知

4.1.9 配置使用场景​

如果只需要一次性读取配置信息，则使用配置，否则应该使用 《4.2 选项》代替。

4.1.10 实现配置中心​

ASP.NET Core 除了通过配置文件读取配置信息外，还支持自定义 配置提供程序，通过 配置提供程序 可以实现配置中心，比如通过数据库提供配置。

具体实现查看微软官方文档：https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/configuration/?view=aspnetcore-5.0#custom-configuration-provider

采用该方式后，如果数据发生改变可调用 App.Configuration.Reload() 刷新即可。

4.1.11 重载配置​

Furion 会在应用启动的时候对 IConfiguration 进行静态缓存，如果使用了 App.Configuration 静态属性且配置数据已发生变更，则调用以下方法刷新即可：

App.Configuration.Reload();

4.1.12 反馈与建议​

与我们交流

给 Furion 提 Issue。

了解更多

想了解更多 配置 知识可查阅 ASP.NET Core - 配置 章节。