在 ASP.NET Core 中修改配置文件后自动加载新的配置
在 ASP.NET Core 中修改配置文件后自动加载新的配置
在 ASP.NET Core 默认的应用程序模板中, 配置文件的处理如下面的代码所示:
config.AddJsonFile(
path: "appsettings.json",
optional: true,
reloadOnChange: true
);
config.AddJsonFile(
path: $"appsettings.{env.EnvironmentName}.json",
optional: true,
reloadOnChange: true
);
appsettings.json
和 appsettings.{env.EnvironmentName}.json
两个配置文件都是可选的, 并且支持当文件被修改时能够重新加载。
可以在 ASP.NET Core 应用中利用这个特性, 实现修改配置文件之后, 不需要重启应用, 自动加载修改过的配置文件, 从而减少系统停机的时间。 实现的步骤如下:
使用配置 API 进行注入
假设要在程序中注入这样一个配置类型:
public class WeatherOption {
public string City { get; set; }
public int RefreshInterval { get; set; }
}
在 appsettings.json
中添加的配置如下:
{
"weather": {
"city": "GuangZhou",
"refreshInterval": 120
}
}
在 Startup.cs
的 ConfigureServices
方法中使用配置 API 进行注入, 代码如下:
public void ConfigureServices(IServiceCollection services) {
services.Configure<WeatherOption>(Configuration.GetSection("weather"));
services.AddControllers();
}
这个步骤很关键, 通过这个配置 API 可以把注入内容和配置所在的节点关联起来。 如果有兴趣了解底层实现的话, 可以继续查看这个 OptionsConfigurationServiceCollectionExtensions.cs 。
通过这种方式注册的内容, 都是支持当配置文件被修改时, 自动重新加载的。
在控制器 (Controller) 中加载修改过后的配置
控制器 (Controller) 在 ASP.NET Core 应用的依赖注入容器中注册的生命周期是 Scoped
, 即每次请求都会创建新的控制器实例。 这样只需要在控制器的构造函数中注入 IOptionsSnapshot<TOption>
参数即可, 代码如下:
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase {
private WeatherOption option;
public WeatherForecastController(
IOptionsSnapshot<WeatherOption> options
) {
this.option = options.Value;
}
// GET /weatherforcase/options
[HttpGet("options")]
public ActionResult<WeatherOption> GetOption() {
return options;
}
}
当然, 如果不希望在控制器中使用这个 IOptionsSnapshot
接口类型(会带来一些对现有代码重构和修改, 还是有一定的风险的), 可以在 ConfigureServices
中添加对 WeatherOption
的注入, 代码如下:
public void ConfigureServices(IServiceCollection services) {
services.Configure<WeatherOption>(Configuration.GetSection("weather"));
// 添加对 WeatherOption 的注入, 生命周期为 Scoped , 这样每次请求都可以获取新的配置值。
services.AddScoped(serviceProvider => {
var snapshot = serviceProvider.GetService<IOptionsSnapshot<WeatherOption>>();
return snapshot.Value;
});
services.AddControllers();
}
这样在控制器中就不需要注入 IOptionsSnapshot<T>
类型了, 最终控制器的代码如下:
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase {
private WeatherOption option;
public WeatherForecastController(
WeatherOption option
) {
this.option = option;
}
// GET /weatherforcase/options
[HttpGet("options")]
public ActionResult<WeatherOption> GetOption() {
return options;
}
}
这样控制器就无需修改任何代码即可加载修改过后的新配置。
在中间件 (Middleware) 中加载修改过后的配置
中间件 (Middleware) 在 ASP.NET Core 应用的依赖注入容器中注册的生命周期是 Singleton
, 即单例的, 只有在当应用启动时, 根据中间件创建处理连时创建一次全局实例, 所以只能通过注入 IOptionsMonitor<T>
来监听配置文件的修改情况, 示例代码如下:
public class TestMiddleware {
private RequestDelegate next;
private WeatherOption option;
public TestMiddleware(
RequestDelegate next,
IOptionsMonitor<WeatherOption> monitor
) {
this.next = next;
option = monitor.CurrentValue;
// moni config change
monitor.OnChange(newValue => {
option = newValue;
});
}
public async Task Invoke(HttpContext context) {
await context.Response.WriteAsync(JsonSerializer.Serialize(option));
}
}
当然, 在中间件的 Task Invoke(HttpContext context)
方法中, 直接获取 IOptionsSnapshot<T>
也是可以的, 代码如下:
public async Task Invoke(HttpContext context) {
var snapshot = context.RequestServices.GetService<IOptionsSnapshot<WeatherOption>>();
await context.Response.WriteAsync(JsonSerializer.Serialize(snapshot.Value));
}
但是这么做的话, 似乎就偏离了依赖注入的原则了, 因此不推荐这种做法。
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- 不可错过的电商系统干货
- TypeScript 类型系统
- 图解 Java 线程生命周期
- sql 基础命令
- python自学成才之路 列表,元组,集合详细用法
- 备战秋招-面经篇-[二十一]
- 高性能 Java 应用层网关设计实践
- redis实战第十五篇 redis cluster的批处理中ask重定向解决方案
- 干货 | Elasticsearch 运维实战常用命令清单
- 备战秋招-面经篇-[二十二]
- 快速上手Spring-Data-Redis
- Lua 5.1 参考手册
- 图文详解k8s自动化持续集成之GitLab CI/CD
- Harbor v2.0 镜像回收那些事
- redis实战第十四篇 redis cluster ask重定向