配置管理一、核心功能配置管理是 Furion.Pure 框架提供的统一配置系统支持多种配置源和强类型配置绑定。1.1 核心价值多配置源支持支持 JSON、XML、INI、环境变量等多种配置源强类型绑定配置自动绑定到强类型对象热更新支持配置文件热更新无需重启应用分层配置支持配置分层和覆盖依赖注入配置对象可通过 DI 容器注入二、配置源2.1 默认配置源框架默认加载以下配置文件文件优先级说明appsettings.json基础配置主配置文件appsettings.{Environment}.json环境覆盖特定环境配置secrets.json最高优先级机密配置开发环境2.2 环境变量框架自动加载环境变量并映射到配置# 环境变量格式 ASPNETCORE_MySetting__KeyValue # 对应配置 { MySetting: { Key: Value } }2.3 命令行参数支持通过命令行参数覆盖配置dotnet run--MySetting:KeyValue三、实现流程3.1 配置加载流程┌─────────────────────────────────────────────────────────────┐ │ 配置加载阶段 │ ├─────────────────────────────────────────────────────────────┤ │ 1. 创建 ConfigurationBuilder │ │ └── 添加 JSON 配置源 │ ├─────────────────────────────────────────────────────────────┤ │ 2. 添加环境变量配置源 │ │ └── 环境变量覆盖 JSON 配置 │ ├─────────────────────────────────────────────────────────────┤ │ 3. 添加命令行参数配置源 │ │ └── 命令行参数覆盖环境变量 │ ├─────────────────────────────────────────────────────────────┤ │ 4. 构建 IConfiguration │ │ └── 注册到 DI 容器 │ └─────────────────────────────────────────────────────────────┘3.2 配置绑定流程┌─────────────────────────────────────────────────────────────┐ │ 配置绑定阶段 │ ├─────────────────────────────────────────────────────────────┤ │ 1. 定义配置类 │ │ └── 继承 IConfigurableOptions │ ├─────────────────────────────────────────────────────────────┤ │ 2. 注册配置服务 │ │ └── services.AddConfigurableOptionsMyOptions() │ ├─────────────────────────────────────────────────────────────┤ │ 3. 配置绑定 │ │ └── 将 IConfiguration 绑定到配置类 │ ├─────────────────────────────────────────────────────────────┤ │ 4. 注入配置对象 │ │ └── 通过构造函数注入配置类实例 │ └─────────────────────────────────────────────────────────────┘四、使用示例4.1 定义配置类publicclassAppSettings:IConfigurableOptions{/// summary/// 应用名称/// /summarypublicstringAppName{get;set;}/// summary/// 应用版本/// /summarypublicstringAppVersion{get;set;}/// summary/// 数据库配置/// /summarypublicDatabaseSettingsDatabase{get;set;}}publicclassDatabaseSettings{publicstringConnectionString{get;set;}publicstringProvider{get;set;}}4.2 配置文件{AppSettings:{AppName:JNPF,AppVersion:3.0.0,Database:{ConnectionString:Serverlocalhost;DatabaseJNPF;Trusted_ConnectionTrue;,Provider:SqlServer}}}4.3 注册配置在Startup.cs中注册配置services.AddConfigurableOptionsAppSettings();4.4 注入配置publicclassUserService{privatereadonlyAppSettings_appSettings;publicUserService(AppSettingsappSettings){_appSettingsappSettings;}publicvoidProcess(){varconnectionString_appSettings.Database.ConnectionString;}}五、配置选项5.1 IConfigurableOptions 接口publicinterfaceIConfigurableOptions{/// summary/// 配置键/// /summarystringSectionKey{get;}/// summary/// 验证配置/// /summaryvoidValidate();}5.2 配置特性使用[OptionsBuilder]特性自定义配置[OptionsBuilder(ConfigurationKeyMySettings,ValidateOnStarttrue)]publicclassMySettings:IConfigurableOptions{publicstringKey{get;set;}}5.3 配置验证实现配置验证逻辑publicclassAppSettings:IConfigurableOptions{publicstringAppName{get;set;}publicvoidValidate(){if(string.IsNullOrEmpty(AppName)){thrownewException(AppName 不能为空);}}}六、高级特性6.1 热更新框架支持配置文件热更新services.AddConfigurableOptionsAppSettings(options{options.EnableHotReloadtrue;});配置更新后自动重新绑定到配置对象。6.2 配置分层支持配置分层和覆盖// appsettings.json{AppSettings:{AppName:JNPF}}// appsettings.Development.json{AppSettings:{AppName:JNPF (Dev)}}6.3 配置监听监听配置变化publicclassConfigController{privatereadonlyIOptionsMonitorAppSettings_optionsMonitor;publicConfigController(IOptionsMonitorAppSettingsoptionsMonitor){_optionsMonitoroptionsMonitor;// 监听配置变化_optionsMonitor.OnChange(settings{// 配置发生变化});}}6.4 自定义配置源实现自定义配置源publicclassCustomConfigurationSource:IConfigurationSource{publicIConfigurationProviderBuild(IConfigurationBuilderbuilder){returnnewCustomConfigurationProvider();}}publicclassCustomConfigurationProvider:ConfigurationProvider{publicoverridevoidLoad(){// 加载配置Data[MyKey]MyValue;}}注册自定义配置源varbuildernewConfigurationBuilder();builder.Add(newCustomConfigurationSource());6.5 配置加密支持配置加密存储{AppSettings:{Database:{ConnectionString:EncryptedValue}}}通过IConfigurationProvider解密配置值。七、核心文件文件说明ConfigurableOptionsServiceCollectionExtensions.cs配置选项服务扩展方法IConfigurableOptions.cs可配置选项接口OptionsBuilderAttribute.cs选项构建器特性AppSettingsOptions.cs应用配置选项IConfigurationExtensions.cs配置扩展方法IConfigurationBuilderExtensions.cs配置构建器扩展方法八、总结配置管理通过统一的配置系统实现了灵活的配置管理核心设计思想多配置源支持支持 JSON、环境变量、命令行参数等多种配置源强类型绑定配置自动绑定到强类型对象提供类型安全热更新支持配置文件热更新无需重启应用分层配置支持配置分层和覆盖便于环境区分依赖注入配置对象可通过 DI 容器注入便于使用这种设计使得配置管理更加灵活和便捷提高了应用的可维护性和可配置性。
配置管理一、核心功能配置管理是 Furion.Pure 框架提供的统一配置系统支持多种配置源和强类型配置绑定。1.1 核心价值多配置源支持支持 JSON、XML、INI、环境变量等多种配置源强类型绑定配置自动绑定到强类型对象热更新支持配置文件热更新无需重启应用分层配置支持配置分层和覆盖依赖注入配置对象可通过 DI 容器注入二、配置源2.1 默认配置源框架默认加载以下配置文件文件优先级说明appsettings.json基础配置主配置文件appsettings.{Environment}.json环境覆盖特定环境配置secrets.json最高优先级机密配置开发环境2.2 环境变量框架自动加载环境变量并映射到配置# 环境变量格式 ASPNETCORE_MySetting__KeyValue # 对应配置 { MySetting: { Key: Value } }2.3 命令行参数支持通过命令行参数覆盖配置dotnet run--MySetting:KeyValue三、实现流程3.1 配置加载流程┌─────────────────────────────────────────────────────────────┐ │ 配置加载阶段 │ ├─────────────────────────────────────────────────────────────┤ │ 1. 创建 ConfigurationBuilder │ │ └── 添加 JSON 配置源 │ ├─────────────────────────────────────────────────────────────┤ │ 2. 添加环境变量配置源 │ │ └── 环境变量覆盖 JSON 配置 │ ├─────────────────────────────────────────────────────────────┤ │ 3. 添加命令行参数配置源 │ │ └── 命令行参数覆盖环境变量 │ ├─────────────────────────────────────────────────────────────┤ │ 4. 构建 IConfiguration │ │ └── 注册到 DI 容器 │ └─────────────────────────────────────────────────────────────┘3.2 配置绑定流程┌─────────────────────────────────────────────────────────────┐ │ 配置绑定阶段 │ ├─────────────────────────────────────────────────────────────┤ │ 1. 定义配置类 │ │ └── 继承 IConfigurableOptions │ ├─────────────────────────────────────────────────────────────┤ │ 2. 注册配置服务 │ │ └── services.AddConfigurableOptionsMyOptions() │ ├─────────────────────────────────────────────────────────────┤ │ 3. 配置绑定 │ │ └── 将 IConfiguration 绑定到配置类 │ ├─────────────────────────────────────────────────────────────┤ │ 4. 注入配置对象 │ │ └── 通过构造函数注入配置类实例 │ └─────────────────────────────────────────────────────────────┘四、使用示例4.1 定义配置类publicclassAppSettings:IConfigurableOptions{/// summary/// 应用名称/// /summarypublicstringAppName{get;set;}/// summary/// 应用版本/// /summarypublicstringAppVersion{get;set;}/// summary/// 数据库配置/// /summarypublicDatabaseSettingsDatabase{get;set;}}publicclassDatabaseSettings{publicstringConnectionString{get;set;}publicstringProvider{get;set;}}4.2 配置文件{AppSettings:{AppName:JNPF,AppVersion:3.0.0,Database:{ConnectionString:Serverlocalhost;DatabaseJNPF;Trusted_ConnectionTrue;,Provider:SqlServer}}}4.3 注册配置在Startup.cs中注册配置services.AddConfigurableOptionsAppSettings();4.4 注入配置publicclassUserService{privatereadonlyAppSettings_appSettings;publicUserService(AppSettingsappSettings){_appSettingsappSettings;}publicvoidProcess(){varconnectionString_appSettings.Database.ConnectionString;}}五、配置选项5.1 IConfigurableOptions 接口publicinterfaceIConfigurableOptions{/// summary/// 配置键/// /summarystringSectionKey{get;}/// summary/// 验证配置/// /summaryvoidValidate();}5.2 配置特性使用[OptionsBuilder]特性自定义配置[OptionsBuilder(ConfigurationKeyMySettings,ValidateOnStarttrue)]publicclassMySettings:IConfigurableOptions{publicstringKey{get;set;}}5.3 配置验证实现配置验证逻辑publicclassAppSettings:IConfigurableOptions{publicstringAppName{get;set;}publicvoidValidate(){if(string.IsNullOrEmpty(AppName)){thrownewException(AppName 不能为空);}}}六、高级特性6.1 热更新框架支持配置文件热更新services.AddConfigurableOptionsAppSettings(options{options.EnableHotReloadtrue;});配置更新后自动重新绑定到配置对象。6.2 配置分层支持配置分层和覆盖// appsettings.json{AppSettings:{AppName:JNPF}}// appsettings.Development.json{AppSettings:{AppName:JNPF (Dev)}}6.3 配置监听监听配置变化publicclassConfigController{privatereadonlyIOptionsMonitorAppSettings_optionsMonitor;publicConfigController(IOptionsMonitorAppSettingsoptionsMonitor){_optionsMonitoroptionsMonitor;// 监听配置变化_optionsMonitor.OnChange(settings{// 配置发生变化});}}6.4 自定义配置源实现自定义配置源publicclassCustomConfigurationSource:IConfigurationSource{publicIConfigurationProviderBuild(IConfigurationBuilderbuilder){returnnewCustomConfigurationProvider();}}publicclassCustomConfigurationProvider:ConfigurationProvider{publicoverridevoidLoad(){// 加载配置Data[MyKey]MyValue;}}注册自定义配置源varbuildernewConfigurationBuilder();builder.Add(newCustomConfigurationSource());6.5 配置加密支持配置加密存储{AppSettings:{Database:{ConnectionString:EncryptedValue}}}通过IConfigurationProvider解密配置值。七、核心文件文件说明ConfigurableOptionsServiceCollectionExtensions.cs配置选项服务扩展方法IConfigurableOptions.cs可配置选项接口OptionsBuilderAttribute.cs选项构建器特性AppSettingsOptions.cs应用配置选项IConfigurationExtensions.cs配置扩展方法IConfigurationBuilderExtensions.cs配置构建器扩展方法八、总结配置管理通过统一的配置系统实现了灵活的配置管理核心设计思想多配置源支持支持 JSON、环境变量、命令行参数等多种配置源强类型绑定配置自动绑定到强类型对象提供类型安全热更新支持配置文件热更新无需重启应用分层配置支持配置分层和覆盖便于环境区分依赖注入配置对象可通过 DI 容器注入便于使用这种设计使得配置管理更加灵活和便捷提高了应用的可维护性和可配置性。
