Appsettings基础配置

一、速通一图流

二、配置总结

1. 配置文件的管理

配置在 ASP.NET Core 和 Furion 框架中扮演着关键角色，用于集中管理应用程序的动态设置，使系统能够在不同环境下灵活调整。

1.1 json 文件配置注意事项

• 复制属性设置：必须将 .json 文件设置为“如果较新则复制”并将生成操作设置为“内容”，以确保这些文件在项目构建后能够正确复制到输出目录。

• 命名唯一性：在多个项目层中使用 .json 文件时，确保文件名唯一，以避免编译后文件互相覆盖的情况。

• 编码问题：默认情况下，.json 文件可能不是 UTF-8 编码，这会导致中文出现乱码。为避免此问题，确保 .json 文件保存为 UTF-8 编码。

2. 什么是配置

配置用于将系统的动态选项集中管理。ASP.NET Core 默认加载启动项目中的 appsettings.json，并根据环境加载对应的配置文件（如 appsettings.Development.json）。

3. 配置的使用

1. 在 appsettings.json 中配置信息

• 例如，定义应用的名称、版本和公司信息，通过 JSON 结构化数据将这些信息保存，方便应用程序的不同部分读取和使用。

{
  "AppInfo": {
    "Name": "Furion",
    "Version": "1.0.0",
    "Company": "Baiqian"
  }
}

2. 读取配置

• 使用 IConfiguration 依赖注入：通过依赖注入的方式在类中读取配置数据，例如在控制器的构造函数中注入 IConfiguration。

• 使用静态类 App.Configuration 直接读取：适用于静态类或非依赖注入的类，通过 App.Configuration["path"] 读取配置数据。

public string Get()
{
    return $@"名称：{App.Configuration["AppInfo:Name"]}，
              版本：{App.Configuration["AppInfo:Version"]}，
              公司：{App.Configuration["AppInfo:Company"]}";
}

4. 读取配置并转换类型

转换为特定类型：可以将配置数据转换为对象、数组、字典等类型，方便后续处理。

var data = Configuration.GetSection("配置节点").Get<类型>();  // 通过获取配置节并转换为指定类型
var data = App.GetConfig<类型>("配置节点");  // 通过静态方法获取并转换为指定类型

5. 自定义配置文件

支持 .json 和 .xml 格式：

• Furion 框架在启动时自动扫描每个项目根目录下的 .json 文件，并将其加载为配置数据。

• 文件名必须唯一，且新增的文件需设置为“始终复制”或“较新复制”。

读取自定义配置：

• 读取方式与 appsettings.json 一致，通过 App.Configuration["path"] 或 IConfiguration 读取。

6. 环境特定的配置

根据不同的环境（如开发、生产）加载不同的配置文件。只需遵循 {name}.{Environment}.json 的命名规范，ASP.NET Core 会自动在启动时加载对应的环境配置。

appsettings.Development.json
appsettings.Production.json

7. 配置更改通知（热更新）

配置支持热更新：当配置文件发生变化时，应用程序可以实时感知并作出响应。例如，通过监听 OnChange 事件，当 appsettings.json 文件内容变动时，应用程序会自动更新相关配置。

ChangeToken.OnChange(() => App.Configuration.GetReloadToken(), () =>
{
    var name = appInfoConfiguration["Name"];
    var version = appInfoConfiguration["Version"];
});

8. 手动添加配置文件

手动加载配置文件：在某些情况下，配置文件可能不在项目根目录下，可以通过以下方式手动加载：

• 在 appsettings.json 中指定扫描目录。

• 在 .NET 5 或 .NET 6 的 Program.cs 中配置手动加载。

builder.Configuration.AddJsonFile("MyConfig.json", optional: true, reloadOnChange: true);  // 手动加载自定义配置文件

9. 配置的优缺点

• 优点：

  • 快速读取配置。

  • 无需额外配置，默认支持。

• 缺点：

  • 存在重复读取的问题。

  • 使用硬编码字符串读取配置容易出错。

  • 无法设置默认值和动态配置运行时的参数。

10. 配置使用场景

配置适用于一次性读取信息的场景。如果需要多次或持续读取，并根据场景做出反应，建议使用 Options 模式来代替配置。

11. 实现配置中心

ASP.NET Core 支持自定义配置提供程序，可以将数据库或其他外部服务作为配置源，实现配置中心。例如，使用 Nacos 或 AgileConfig 集成配置中心。
具体实现查看微软官方文档

12. 重载配置

当配置发生变化时，可以调用 App.Configuration.Reload() 手动刷新配置，以确保 App.Configuration 中的数据是最新的。

App.Configuration.Reload();