.net core AOP

AOP，即面向切面编程

```mindmap>400
# 自定义
## IAuthorizationFilter
## IResourceFilter
## IExceptionFilter
## IActionFilter
## IResultFilter
# 内置Filter特性
## ActionFilterAttribute
## ExceptionFilterAttribute
## ResultFilterAttribute
## FormatFilterAttribute
## ServiceFilterAttribute
## TypeFilterAttribute
```

# 定义过滤器
| 列名 | 列名 | 列名 |  列名 |
| --- | --- |--- |  --- |
| 1 | Authorization Filter | 授权过滤器| 用于身份验证和授权，是五种Filter中优先级最高的 |
| 2 | Resource Filter |资源过滤器 | 在Action执行前后进行资源处理，如资源缓存、防盗链等。 |
| 3 | Exception Filter | 异常过滤器 |用于全局的异常处理，捕获并处理未捕获的异常 |
| 4 | Action Filter | 操作过滤器 |在Action执行前后进行拦截，常用于执行操作日志、参数验证等。 |
| 5 | Result Filter | 结果过滤器 | 在Action结果返回前后进行拦截，常用于对结果进行格式化,大小写转换等操作。 |

![](/media/202408/2024-08-15_103838_2543660.08930108930748704.png)

![](/media/202408/2024-08-15_162148_0678050.4824349401495245.png)

![](/media/202408/2024-08-15_164129_6579850.025839495337491414.png)

```java
public class AuthonizationFilter :Attribute,IAuthorizationFilter
{
    public void OnAuthorization(AuthorizationFilterContext context)
    {
        //这里可以做复杂的权限控制操作
        if (context.HttpContext.User.Identity.Name != "1") //简单的做一个示范
        {
            //未通过验证则跳转到无权限提示页
            RedirectToActionResult content = new RedirectToActionResult("NoAuth", "Exception", null);
            context.Result = content;
        }
    }
}

public class ResourceFilter : Attribute,IResourceFilter
{
    public void OnResourceExecuted(ResourceExecutedContext context)
    {
        // 执行完后的操作
    }

public void OnResourceExecuting(ResourceExecutingContext context)
    {
        // 执行中的过滤器管道
    }
}

public class ExecptionFilter : Attribute, IExceptionFilter
{
    private ILogger<ExecptionFilter> _logger;
    //构造注入日志组件
    public ExecptionFilter(ILogger<ExecptionFilter> logger)
    {
        _logger = logger;
    }

public void OnException(ExceptionContext context)
    {
        //日志收集
        _logger.LogError(context.Exception, context?.Exception?.Message??"异常");
    }
}

public class ActionFilter : Attribute, IActionFilter
{
    public void OnActionExecuted(ActionExecutedContext context)
    {
        //执行完成....
    }

public void OnActionExecuting(ActionExecutingContext context)
    {
        //执行中...
    }
}

public class ResultFilter : Attribute, IResultFilter
{
    public void OnResultExecuted(ResultExecutedContext context)
    {
        // 在结果执行之后调用的操作...
    }

public void OnResultExecuting(ResultExecutingContext context)
    {
        // 在结果执行之前调用的一系列操作
    }
}

```

# 注册过滤器
- 全局：将作用于所有请求的action
- controller：将作用于这个controller下的所有action
- action：作用于单个action

## 全局注册
```java
builder.Services.AddMvc(options => options.Filters.Add<FilterAttribute>(););
```
## Controller 注册方式
```java
[Route("api/[controller]")]
[ApiController]
[Filter]//添加过滤器特性，该控制器的所有方法自动走该过滤器
public class FilterAttributeController : ControllerBase
{
    [HttpGet]
    [Filter]//添加过滤器特性，该方法自动走该过滤器
    public string G_Method1() => return "1";
}
```
## action 注册方式
```java
[Route("api/[controller]")]
[ApiController]
public class FilterAttributeController : ControllerBase
{
    [HttpGet]
    [Filter]//添加过滤器特性，该方法自动走该过滤器
    public string G_Method1() => return "1";
}
```

# TypeFilter 和 ServiceFilter

这两个特性都可以实现自定义过滤器的局部注入，但有不同：

- ServiceFilter和TypeFilter都实现了IFilterFactory
- ServiceFilter需要对自定义的Filter进行注册，TypeFilter不需要
- ServiceFilter的Filter生命周期源自于您如何注册，而TypeFilter每次都会创建一个新的实例

```java
//在Program.cs中必须先注册MyFilter这个过滤器到服务容器中
builder.Services.AddSigleton<MyFilter>();

//控制器方法上用ServiceFilter注入自定义过滤器
[ServiceFilter(typeof(MyFilter))]
public IActionResult Index()
{
    //一些处理
    ...
    return Ok();
}

//控制器方法上用TypeFilter注入自定义过滤器
[TypeFilter(typeof(MyFilter),IsReusable = true)]
public IActionResult Index()
{
    //一些处理
    ...
    return Ok();
}
```

# Filter特性
- ActionFilterAttribute ：行为过滤器特性
- ExceptionFilterAttribute：异常过滤器特性
- ResultFilterAttribute：结果过滤器特性
- FormatFilterAttribute：响应格式化过滤器特性
- ServiceFilterAttribute：用来局部使用过滤器的特性
- TypeFilterAttribute：也是用来局部注入过滤器的特性

```java
 // 继承了一个 ActionFilterAttribute，这个抽象类继承了什么接口呢？
 //ResponseHeaderAttribute是一个自定义特性，[ResponseHeader]
 public class ResponseHeaderAttribute : ActionFilterAttribute
 {
     private readonly string _name;
     private readonly string _value;

/// 构造函数
     public ResponseHeaderAttribute(string name, string value)
     {
         (_name, _value) = (name, value); //元组赋值法
     }
     // 结果过滤器里边的 结果被执行前
     public override void OnResultExecuting(ResultExecutingContext context)
     {
         //添加响应头，键值对信息  （你对HTTP协议了解多少？？）
         context.HttpContext.Response.Headers.Add(_name, _value);
         base.OnResultExecuting(context);
     }
 }

//在控制器上应用
[ResponseHeader("Filter-Header", "Filter Value")]
public class UserController : ControllerBase
{
    public IActionResult Index() =>Content("请通过浏览器F12调试工具查看输出的响应头信息");
    // ...
    //也可以在方法上面应用
    [ResponseHeader("Another-Filter-Header", "Another Filter Value")]
    public IActionResult Multiple() => Content("请通过浏览器F12调试工具查看输出的响应头信息");
}

```