Asp.NET Core WebApi 配置文件详细说明

在 ASP.NET Core Web API 中，配置文件（如 appsettings.json）是管理应用程序设置的核心部分。ASP.NET Core 提供了一套灵活的配置系统，允许开发者从多种来源加载配置数据，并根据需要使用这些配置。

以下是关于如何在 ASP.NET Core Web API 中获取和使用配置文件的详细说明：

1. 配置文件的基本结构

默认情况下，ASP.NET Core 使用 appsettings.json 文件作为主要的配置文件。以下是一个典型的 appsettings.json 文件示例：

• Logging：定义日志记录级别。
• AllowedHosts：指定允许访问的主机。
• Jwt：JWT 鉴权相关的配置（密钥、签发者、受众等）。
• Database：数据库连接字符串。

2. 配置文件的加载与绑定

ASP.NET Core 使用 IConfiguration 接口来加载和访问配置数据。以下是配置文件的加载和使用的步骤：

(1) 加载配置文件

在 Program.cs 或 Startup.cs 中，ASP.NET Core 默认会加载 appsettings.json 和环境特定的配置文件（如 appsettings.Development.json）。例如：

WebApplication.CreateBuilder 会自动加载以下内容：

• appsettings.json
• 环境特定的配置文件（如 appsettings.{Environment}.json）
• 环境变量
• 命令行参数

(2) 使用 IConfiguration 获取配置值

builder.Configuration 是一个 IConfiguration 实例，可以通过它直接访问配置值。例如：

(3) 绑定到强类型对象

为了更方便地使用配置，可以将配置绑定到一个强类型的类。例如：

然后通过 GetSection 方法绑定到这些类：

3. 注册配置到依赖注入容器

如果需要在多个地方使用配置，可以将配置注册到依赖注入容器中。例如：

然后在需要的地方通过构造函数注入 IOptions<T> 来使用配置：

4. 环境特定的配置文件

ASP.NET Core 支持基于环境的配置文件。例如：

• 开发环境：appsettings.Development.json
• 生产环境：appsettings.Production.json

这些文件会覆盖 appsettings.json 中的相同配置项。环境由 ASPNETCORE_ENVIRONMENT 环境变量决定。

例如，appsettings.Development.json 可能包含开发环境特定的配置：

可以通过以下方式检查当前环境：

5. 其他配置源

除了 appsettings.json，ASP.NET Core 还支持从其他来源加载配置，包括：

(1) 环境变量

可以通过环境变量覆盖配置值。例如：

(2) 命令行参数

启动应用时通过命令行传递参数。例如：

(3) 用户机密（Secret Manager）

在开发环境中，可以使用 Secret Manager 工具存储敏感信息，避免将它们提交到版本控制系统中。运行以下命令添加用户机密：