.Net Core ActionFilter
目录
作用
- 在请求AuthorizeFilter -> ResourceFilter -> ActionFilter, 可以记录Action的日志
- ActionFilter 在控制器实例化之后执行
- ResourceFilter 可以在全局, Controller, Action 都可以设置, 并且都会执行(一个ResourceFilter可以重复设置)
如果都设置执行顺序为:
- 全局
- Controller
- Action
- Action 方法
- Action
- Controller
- 全局
实现
IActionFilter
- 需要继承 Attribute 并 并实现 IActionFilter
- 实现接口方法
执行顺序为:
- OnActionExecuting
- Action
- OnActionExecuted
IAsyncActionFilter
- 需要继承 Attribute 并 并实现 IAsyncActionFilter
- 实现接口方法
- 该接口只提供一个 OnActionExecutionAsync方法,如果想执行ActionExecutedContext方法,需要执行方法中ActionExecutionDelegate委托并取返回值然后代码在执行为
ActionExecutedContext方法
执行顺序为:
- OnActionExecuting
- Action
- OnActionExecuted
ActionFilterAttribute
- 需要继承 ActionFilterAttribute
- 重写 OnActionExecuting OnActionExecuted OnResultExecuting OnResultExecuted 方法
执行顺序为:
- OnActionExecuting
- Action
- OnActionExecuted
- OnResultExecuting
- OnResultExecuted
Aop Action执行
过滤器代码
using Microsoft.AspNetCore.Mvc.Filters;
namespace Cnpc.Com.Ioc.WebApp.Filter.ActionFilter
{
public class CustomAsyncActionFilter : Attribute, IAsyncActionFilter
{
public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
{
{
Console.WriteLine("ActionExecutingContext.....");
}
ActionExecutedContext executed = await next();
{
Console.WriteLine("ActionExecutedContext.....");
}
}
}
}
Action代码
using Cnpc.Com.Ioc.WebApp.Filter;
using Microsoft.AspNetCore.Mvc;
namespace Cnpc.Com.Ioc.WebApp.Controllers
{
[Route("api/[controller]/[action]")]
[ApiController]
public class TestFilterController : ControllerBase
{
//[TypeFilter(typeof(CustomAsyncActionFilter))] 如果想在ActionFilter支持Nlog 并使用构造注入就这样写
[CustomAsyncActionFilter]
[HttpGet]
public async Task Action_AsyncActionFilter()
{
Console.WriteLine("Func...");
await Task.CompletedTask;
}
}
}
使用日志
Action
//[ServiceFilter(typeof(CustomAsyncActionFilter))] 如果使用SerciceFilter 要先将CustomAsyncActionFilter 注册到ioc中
[TypeFilter(typeof(CustomAsyncActionFilter))] //如果想在ActionFilter支持Nlog 并使用构造注入就这样写
[HttpGet]
public async Task Action_AsyncActionFilter()
{
Console.WriteLine("Func...");
await Task.CompletedTask;
}
CustomAsyncActionFilter.cs
using Cnpc.Com.Ioc.IBll;
using Cnpc.Com.Ioc.IDal;
using Microsoft.AspNetCore.Mvc.Filters;
namespace Cnpc.Com.Ioc.WebApp.Filter.ActionFilter
{
public class CustomAsyncActionFilter : Attribute, IAsyncActionFilter
{
ILogger<CustomAsyncActionFilter> logger { get; set; }
IStudent student { get; set; }
IWrite write { get;set; }
public CustomAsyncActionFilter(ILogger<CustomAsyncActionFilter> logger,IStudent student,IWrite write)
{
this.logger = logger;
this.student = student;
this.write = write;
}
public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
{
{
Console.WriteLine("ActionExecutingContext.....");
logger.LogInformation(context.HttpContext.Request.Path + "before..");
this.student.DoHomeWork(write);
}
ActionExecutedContext executed = await next();
{
Console.WriteLine("ActionExecutedContext.....");
logger.LogInformation(context.HttpContext.Request.Path + "after..");
}
}
}
}
全局注册
Program.cs
//全局注册
builder.Services.AddControllersWithViews(options =>
{
options.Filters.Add<CustomAsyncActionFilter>();
});