.Net Core WebAPI 利用 IActionFilter 实现请求缓存
.Net Core WebAPI 利用 IActionFilter 实现请求缓存
本文使用Redis缓存方式
- 1 新建类
首先新建一个缓存类CustomActionCacheAttribute继承Attribute，因为需要给方法做标记。再引用并实现IActionFilter接口
public class CustomActionCacheAttribute: Attribute, IActionFilter
{
// 标记的方法执行前执行
public void OnActionExecuting(ActionExecutingContext context)
{
}
// 标记的方法执行完的回调
public void OnActionExecuted(ActionExecutedContext context)
{
}
}
- 2 注入redis缓存
在 .Net core 中，提供了一个操作所有缓存对象的接口IDistributedCache，需要引用
using Microsoft.Extensions.Caching.Distributed，然后在类中声明变量。
private IDistributedCache _cache;
因为该Filter标注在方法上，运行时解析，所以无法通过注入的方式来注入该对象
所以需要使用扩展来获取IDistributedCache 对象
- 3 扩展获取DI注入对象
新建静态类CustomDIContainer
代码如下：
/// 使用到了IHttpContextAccessor，所以需要在Startup的ConfigureServices方法中进行http上下文初始化注入.
public void ConfigureServices(IServiceCollection services)
{
......
// 注入NewtonsoftJson组件
services.AddControllers().AddNewtonsoftJson();
// 注入缓存组件
services.AddDistributedRedisCache(r => r.Configuration = Configuration["Redis:ConnectionString"]);
// 注入请求上下文
services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
......
}
- 4 缓存扩展
在缓存中，不单单仅是缓存一个方法，应该做到方法的拓展缓存，既根据不同的传参进行方法返回值的缓存，所以需要对方法的参数进行序列化。
方法如下：
/// 并在方法内部声明存储请求参数及方法的字符串
private string _urlParams;
- 5 拓展缓存过期时间
每个方法返回结果都会根据不同的更新频率设置不同的缓存时间。声明属性可供头部标注。
/// - 6 完整代码
public class CustomActionCacheAttribute : Attribute, IActionFilter
{
/// - 7 最后注意
在.Net Core 3需要配置读取body，在代码中方法执行前和方法执行后中多次使用了HttpContext的Body参数，所以需要在Startup中Configure方法添加可多次读取。
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
......
app.Use(next => context =>
{
context.Request.EnableBuffering();
return next(context);
});
......
}
- 8 使用
/// 如果文中有错误之处，欢迎各位看官指正，谢谢。如需转载，请指明原出处。