ASP .NET Core Api 使用过滤器

过滤器说明

        过滤器与中间件很相似，过滤器（Filters）可在管道（pipeline）特定阶段（particular stage）前后执行操作。可以将过滤器视为拦截器（interceptors）。

过滤器级别范围

过滤器有多个级别，分别是：

  • 全局级别过滤器（Global scope），通过Program.cs全局添加Filter
  • 控制器级别过滤器（Controller scope），通过AttributeUsage特性配置
  • 动作级别过滤器（Action scope），通过AttributeUsage特性配置

过滤器类型

Asp.Net Core 过滤器：

  • IResourceFilter
  • IAuthorizationFilter
  • IPageFilter
  • ExceptionFilterAttribute
  • ActionFilterAttribute
过滤器类型接口对应特性含义
授权过滤器IAuthorizationFilter、IAsyncAuthorizationFilter没有提供特性类最先执行，用于判断用户是否授权。如果未授权，则直接结束当前请求。这种类型的过滤器实现了 IAsyncAuthorizationFilter 或IAuthorizationFilter 接口。
资源过滤器IResourceFilter、IAsyncResourceFilter没有提供特性类在Authorization过滤器后执行，并在执行其他过滤器 （除Authorization过滤器外）之前和之后执行。由于它在Action之前执行，因而可以用来对请求判断，根据条件来决定是否继续执行Action。这种类型过滤器实现了 IAsyncResourceFilter 或 IResourceFilter 接口。
操作过滤器IActionFilter、IAsyncActionFilterActionFilterAttribute在Action执行的前后执行。与Resource过滤器不一样，它在模型绑定后执行。这种类型的过滤器实现了 IAsyncActionFilter 或 IActionFilter 接口。
页面过滤器IPageFilter、IAsyncPageFilter没有提供特性类页面过滤器是 Razor Pages 等效的操作过滤器
结果过滤器IResultFilter、IAsyncResultFilter、 IAlwaysRunResultFilter、IAsyncAlwaysRunResultFilterResultFilterAttribute在 IActionResult 执行的前后执行，使用它能够控制Action的执行结果，比如：格式化结果等。需要注意的是，它只有在Action方法成功执行完成后才会运行。这种类型过滤器实现了 IAsyncResultFilter 或 IResultFilter 接口。
异常过滤器IExceptionFilter、IAsyncExceptionFilterExceptionFilterAttribute异常过滤器用于管理未处理的异常，比如：用于捕获异常。这种类型的过滤器实现了 IAsyncExceptionFilter 或 IExceptionFilter 接口。

        不同类型的过滤器在ASP.NET Core中的位置。可以看到不同类型的过滤器在不同阶段起作用。授权过滤器先于其他所有操作，并在任何授权错误时阻止请求。 资源过滤器在模型验证和模型绑定请求之前运行，也在我们的请求结果从服务器返回时运行。 动作过滤器类型在动作调用之前和之后起作用。 此外，如果操作引发异常，则会触发异常过滤器。 在管道的末尾，结果过滤器对 IActionResult 最终对象实例进行操作。 

 

ActionFilter

         ActionFilterAttribute 拦截器通过 重写 OnActionExecuting，来 拦截action的请求消息，当执行OnActionExecuting完成以后才真正进入请求的action中，action运行完后又把控制权给了 OnActionExecuted，这个管道机制可以使我们用它来轻松实现 权限认证、日志记录 ，跨域以及很多需要对全局或者部分请求做手脚的的功能。
大概的流程如下：

        ActionFilter全称是ActionFilterAttribute，我们根据微软的命名规范可以看出这是一个特性类，看一下它的声明：

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public abstract class ActionFilterAttribute : Attribute, IActionFilter, IFilterMetadata, IAsyncActionFilter, IAsyncResultFilter, IOrderedFilter, IResultFilter


        这是一个允许标注在类和方法上的特性类，允许多个标记，标注之后子类会继承父类的特性。然后，这个类是一个抽象类，所以我们可以通过继承ActionFilterAttribute来编写自己的ActionFilter。 

ActionFilter 四个方法

public virtual void OnActionExecuted(ActionExecutedContext context);
public virtual void OnActionExecuting(ActionExecutingContext context);

public virtual void OnResultExecuted(ResultExecutedContext context);
public virtual void OnResultExecuting(ResultExecutingContext context);

        上图是这四个方法在一次请求中执行的顺序。在一次请求真正执行之前，想要拦截这个请求，应该使用OnActionExecuting。

        为什么单独说这个呢？因为这个方法的出镜率很高，大多数时候都会使用这个方法进行请求过滤。

 获取Api请求相关信息

 在Program.cs中添加EnableBuffering。一定要添加在UseEndpoints和MapControllers之前

//3.0
//app.Use(next => context =>
//{
//    context.Request.EnableBuffering();
//    return next(context);
//});//net6.0
//启动倒带方式
//app.Use(async (context, next) => {
//    context.Request.EnableBuffering();
//    await next();
//});app.Use((context, next) =>
{context.Request.EnableBuffering();return next(context);
});//同步需要添加此代码
builder.Services.Configure<KestrelServerOptions>(x => x.AllowSynchronousIO = true).Configure<IISServerOptions>(x => x.AllowSynchronousIO = true);

         添加同步ActionFilter或异步ActionFilter。注意：同步与异步不能一起使用 同步ActionFilter

using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Razor.TagHelpers;
using Microsoft.AspNetCore.Mvc.Controllers;
using System.Text;
using System.Text.Json;namespace WebApplication1
{[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]public class ApiFilter : ActionFilterAttribute{private string ActionArguments { get; set; }/// <summary>/// 执行方法体之前/// </summary>/// <param name="context"></param>public override void OnActionExecuting(ActionExecutingContext context){try{if (context.ActionArguments != null && context.ActionArguments.Count > 0){ActionArguments = JsonSerializer.Serialize(context.ActionArguments);}else{ActionArguments = string.Empty;}}catch (Exception ex){var _serviceProvider = context.HttpContext.RequestServices;_serviceProvider.GetService<ILogger<ApiFilter>>()!.LogError(ex.StackTrace);}base.OnActionExecuting(context);}/// <summary>/// 执行方法体之后,返回result前/// </summary>/// <param name="context"></param>public override void OnActionExecuted(ActionExecutedContext context){var request = context?.HttpContext?.Request;//获取IServiceProvidervar _serviceProvider = context.HttpContext.RequestServices;//判断Body是否存在var isBody = context.ActionDescriptor.Parameters.Any(r => r.BindingInfo?.BindingSource == BindingSource.Body);//请求地址string url = request.Host + request.Path + request.QueryString;var descriptor = (ControllerActionDescriptor)context.ActionDescriptor;//获取控制器名称var controllerName = descriptor.ControllerName;//获取action名称var actionName = descriptor.ActionName;//获取request参数var requestArguments = ActionArguments;//请求方式string method = request.Method;//请求Headervar headrs = request.Headers;//context.HttpContext.Request.Form//获取Request Bodystring requestBody = string.Empty;if (request.Method == "POST" && request.Body != null){using StreamReader sr = new StreamReader(request.Body);if (request.Body.CanSeek) request.Body.Seek(0, SeekOrigin.Begin);if (request.Body.CanRead) requestBody = sr.ReadToEnd();if (request.Body.CanSeek) request.Body.Seek(0, SeekOrigin.Begin);}//获取Response Bodyvar Response = context?.HttpContext?.Response;var result = context.Result;if (result is JsonResult json){var x = json.Value;var status = json.StatusCode;var content = JsonSerializer.Serialize(x);}if (result is ViewResult view){var status = view.StatusCode;var content = view.ViewData;var name = view.ViewName;}if (result is ObjectResult ob){var x = ob.Value;var status = ob.StatusCode;var content = JsonSerializer.Serialize(x);}base.OnActionExecuted(context);}/// <summary>/// 返回result之前/// </summary>/// <param name="context"></param>public override void OnResultExecuting(ResultExecutingContext context){base.OnResultExecuting(context);}/// <summary>/// 返回result之后/// </summary>/// <param name="context"></param>public override void OnResultExecuted(ResultExecutedContext context){base.OnResultExecuted(context);}}
}

异步ActionFilter

using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using System.Text.Json;
using System.Net.NetworkInformation;
using System.Net.Sockets;
using System.Net;namespace WebApplication1.Filter
{[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]public class ApiAsyncFilter : ActionFilterAttribute{public override async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next){//执行方法体之前//...//执行方法体await base.OnActionExecutionAsync(context, next);//执行方法体之后//获取requestBodyvar request = context?.HttpContext?.Request;string requestBody = string.Empty;if (request.Method == "POST" && request.Body != null){using StreamReader sr = new StreamReader(request.Body);if (request.Body.CanSeek) request.Body.Seek(0, SeekOrigin.Begin);if (request.Body.CanRead) requestBody = await sr.ReadToEndAsync();//第二种方法if (request.Body.CanRead){var result = await request.BodyReader.ReadAsync();requestBody = Encoding.UTF8.GetString(result.Buffer);}if (request.Body.CanSeek) request.Body.Seek(0, SeekOrigin.Begin);}}public override async Task OnResultExecutionAsync(ResultExecutingContext context, ResultExecutionDelegate next){//返回result之前await base.OnResultExecutionAsync(context, next);}}
}

 ActionFilter 记录异常日志

using Microsoft.AspNetCore.Mvc.Filters;
using System.Text.Json;namespace WebApplication1
{public class ExceptionFilter : ActionFilterAttribute{private string ActionArguments { get; set; }/// <summary>/// 执行方法体之后,返回result前/// </summary>/// <param name="context"></param>public override void OnActionExecuted(ActionExecutedContext context){if (context.Exception != null){LoggerError(context, context.Exception);}base.OnActionExecuted(context);}/// <summary>/// 执行方法体之前/// </summary>/// <param name="context"></param>public override void OnActionExecuting(ActionExecutingContext context){try{if (context.ActionArguments != null && context.ActionArguments.Count > 0){ActionArguments = JsonSerializer.Serialize(context.ActionArguments);}else{ActionArguments = string.Empty;}}catch (Exception ex){context.HttpContext.RequestServices.GetService<ILogger<ExceptionFilter>>()!.LogError(ex.StackTrace);}base.OnActionExecuting(context);}private void LoggerError(ActionExecutedContext context, Exception exception){var _logger = context.HttpContext.RequestServices.GetService<ILogger<ExceptionFilter>>()!;try{string url = context.HttpContext.Request.Host + context.HttpContext.Request.Path + context.HttpContext.Request.QueryString;string method = context.HttpContext.Request.Method;string message = $"\n" + $"地址：{url} \n " +$"方式：{method} \n " +$"参数：{ActionArguments}\n " +$"错误描述：{context.Exception.Message}\n " +$"错误堆栈：{context.Exception.StackTrace}\n ";if (exception.InnerException != null){message += "\n InnerException异常Message：" + exception.InnerException.Message;message += "\n InnerException异常StackTrace：" + exception.InnerException.StackTrace;}_logger.LogError(message);}catch (Exception ex){_logger.LogError(ex.StackTrace);}}}
}

ExceptionFilter 记录异常日志

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.EntityFrameworkCore;
using System;
using System.Net;
using System.Text.Json;namespace WebApplication1
{public class ExceptionFilter : ExceptionFilterAttribute{public override void OnException(ExceptionContext context){Exception ex = context.Exception;string url = context.HttpContext.Request.Host + context.HttpContext.Request.Path + context.HttpContext.Request.QueryString;string method = context.HttpContext.Request.Method;string message = $"\n " + $"地址：{url} \n " +$"方式：{method} \n " +$"错误描述：{ex.Message}\n " +$"错误堆栈：{ex.StackTrace}\n ";//while (ex.InnerException != null) { ex = ex.InnerException; }if (ex.InnerException != null){message += "\n InnerException异常Message：" + ex.InnerException.Message;message += "\n InnerException异常StackTrace：" + ex.InnerException.StackTrace;}context.HttpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;context.Result = new ObjectResult(message);// 表明异常已处理，客户端可得到正常返回context.ExceptionHandled = true;base.OnException(context);}}
}

 全局添加过滤器

在Program.cs添加Filter

builder.Services.Configure<MvcOptions>(opts => opts.Filters.Add<ExceptionFilter>());builder.Services.AddControllersWithViews(options =>
{//options.Filters.Add(new ApiFilter(null,null));options.Filters.Add<ApiFilter>();
});//或者
builder.Services.Configure<MvcOptions>(opts => opts.Filters.Add<ExceptionFilter>());

 参考文档

ASP.NET Core教程-Filter（过滤器） 

https://www.cnblogs.com/cqpanda/p/16907950.html 

全局获取异常 

https://www.cnblogs.com/shenweif/p/17236321.html 

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.rhkb.cn/news/248536.html

如若内容造成侵权/违法违规/事实不符，请联系长河编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Redis -- 开篇热身，常用的全局命令

Redis -- 开篇热身，常用的全局命令

目录 Redis重要文件 启动停止脚本 配置文件 持久化文件存储目录 核心命令 set get 全局命令 keys exists del expire ttl 过期策略是如何实现的 定时器 type 小结 Redis重要文件 启动停止脚本 /usr/bin/redis-benchmark &#xff1a; 用于对Redis做性能基准…
阅读更多...
搭建nginx图片服务器

搭建nginx图片服务器

&#xff08;1&#xff09;将图片存储于/home/data/images目录&#xff1b; &#xff08;2&#xff09;配置nginx.conf user nginx; worker_processes 4;error_log /var/log/nginx/error.log notice; pid /var/run/nginx.pid;events {worker_connections 10000; }ht…
阅读更多...
编译Opencv3.3.1遇到的编译器无法识别的警告的问题解除：

编译Opencv3.3.1遇到的编译器无法识别的警告的问题解除：

问题描述&#xff1a; 本文&#xff0c;就是在一个硬件的SDK中用到了opencv3.3.1的版本&#xff0c;在笔者目前的VS2019,CUDA11版本下编译的问题和解决。在做Cmake的configure的时候&#xff0c;Cmake报了一个找不到编译器版本的错误, Selecting windows SDK version 10.0.1904…
阅读更多...
【时间安排】

【时间安排】

最近刚刚回到家&#xff0c;到家就是会有各种事情干扰&#xff0c;心里变乱人变懒的&#xff0c;而要做的事情也要继续&#xff0c;写论文&#xff0c;改简历&#xff0c;学习新技能。。 明天后天两天写论文改简历 周一&#xff08;早上去城市书房&#xff0c;可能吵一点戴个耳…
阅读更多...
JVM学习

JVM学习

1.Java虚拟机内部有哪些线程共享&#xff0c;那些线程隔离 程序计数器&#xff1a; 通过改变这个计数器的值来选取下一条需要执行的字节码命令 Java虚拟机栈&#xff1a; 栈&#xff0c;每个方法被执行时&#xff0c;Java虚拟机都会同步的创建一个栈帧用于存储局部变量表&…
阅读更多...
Java面试架构篇【一览众山小】

Java面试架构篇【一览众山小】

文章目录 &#x1f6a1; 简介☀️ Spring&#x1f425; 体系结构&#x1f420; 生命周期 &#x1f341; SpringMVC&#x1f330; 执行流程 &#x1f31c; SpringBoot&#x1f30d; 核心组件&#x1f38d; 自动装配&#x1f391; 3.0升级 &#x1f505; spring Cloud Alibaba&am…
阅读更多...
数字滤波器的技术指标

数字滤波器的技术指标

文章目录 幅频特性指标异 相频特性指标各型滤波器的幅度响应表征数字滤波器频率响应特性的三个参量(1) 幅度平方响应(2) 相位响应(3) 群延迟响应 数字滤波器的技术指标一般可以用幅频特性和相频特性指标来给出。 设数字滤波器的频率响应为&#xff1a; H ( e j ω ) ∣ H ( e…
阅读更多...
多线程事务如何回滚？

多线程事务如何回滚？

背景介绍 1&#xff0c;最近有一个大数据量插入的操作入库的业务场景&#xff0c;需要先做一些其他修改操作&#xff0c;然后在执行插入操作&#xff0c;由于插入数据可能会很多&#xff0c;用到多线程去拆分数据并行处理来提高响应时间&#xff0c;如果有一个线程执行失败&am…
阅读更多...
构建基于Flask的跑腿外卖小程序

构建基于Flask的跑腿外卖小程序

跑腿外卖小程序作为现代生活中的重要组成部分&#xff0c;其技术实现涉及诸多方面&#xff0c;其中Web开发框架是至关重要的一环。在这篇文章中&#xff0c;我们将使用Python的Flask框架构建一个简单的跑腿外卖小程序的原型&#xff0c;展示其基本功能和实现原理。 首先&…
阅读更多...
echarts：获取省、市、区/县、镇的地图数据

echarts：获取省、市、区/县、镇的地图数据

目录 第一章 前言 第二章 获取地图的数据&#xff08;GeoJSON格式&#xff09; 2.1 获取省、市、区/县地图数据 2.2 获取乡/镇/街道地图数据 第一章 前言 需求&#xff1a;接到要做大屏的需求&#xff0c;其中需要用echarts绘画一个地图&#xff0c;但是需要的地图是区/县…
阅读更多...
Linux浅学笔记03

Linux浅学笔记03

目录 有关root的命令 用户和用户组 用户组管理&#xff1a;&#xff08;以下需要root用户执行&#xff09; 创建用户组: 删除用户组&#xff1a; 用户管理&#xff1a;&#xff08;以下需要root用户执行&#xff09; 创建用户&#xff1a; 删除用户&#xff1a; 查看用…
阅读更多...
掌握 Android JNI 基础

掌握 Android JNI 基础

写在前面 最近在看一些底层源码&#xff0c;发现 JNI 这块还是有必要系统的看一下&#xff0c;索性就写一写博客&#xff0c;加深加深印象&#x1f37b; 本文重点聊一聊一些干货&#xff0c;避免长篇大论 JNI 概述 JNI 是什么&#xff1f; 定义&#xff1a;Java Native In…
阅读更多...
Mysql流程控制函数

Mysql流程控制函数

任何一门语言都有顺序结构 分支结构 循环结构 流程处理函数可以根据不同的条件&#xff0c;执行不同的处理流程&#xff0c;可以在 SQL 语句中实现不同的条件选择。 MySQL 中的流程处理函数主要包括 IF() 、 IFNULL() 和 CASE() 函数。 IF(value,value1,value2)函数举例 IF…
阅读更多...
Qt无边框窗口拖拽和阴影

Qt无边框窗口拖拽和阴影

先看下效果&#xff1a; 说明 自定义窗口控件的无边框,窗口事件由于没有系统自带边框,无法实现拖拽拉伸等事件的处理,一种方法就是重新重写主窗口的鼠标事件&#xff0c;一种时通过nativeEvent事件处理。重写事件相对繁琐,我们这里推荐nativeEvent处理。注意后续我们在做win平…
阅读更多...
微信小程序 仿微信聊天界面

微信小程序 仿微信聊天界面

1. 需求效果图 2. 方案 为实现这样的效果&#xff0c;首先要解决两个问题&#xff1a; 2.1.点击输入框弹出软键盘后&#xff0c;将已有的少许聊天内容弹出&#xff0c;导致看不到的问题 点击输入框弹出软键盘后&#xff0c;将已有的少许聊天内容弹出&#xff0c;导致看不到的问…
阅读更多...
算法面试八股文『 基础知识篇 』

算法面试八股文『 基础知识篇 』

博客介绍 近期在准备算法面试&#xff0c;网上信息杂乱不规整&#xff0c;出于强迫症就自己整理了算法面试常出现的考题。独乐乐不如众乐乐&#xff0c;与其奖励自己&#xff0c;不如大家一起嗨。以下整理的内容可能有不足之处&#xff0c;欢迎大佬一起讨论。 PS&#xff1a;…
阅读更多...
EPSON RC 机器人-第一个程序

EPSON RC 机器人-第一个程序

创建项目 有机械人且用USB线连接好。可以USB。没有真机的选择 C4 Sample 可以运行程序。 否刚会提示【不能连接到控制器&#xff0c;未安装USB驱动器】 代码 按F5打开运行窗口 再点【开始】 点 【是】&#xff0c;查看运行结果
阅读更多...
手把手教你使用Flask搭建ES搜索引擎(实战篇)

手把手教你使用Flask搭建ES搜索引擎(实战篇)

目录 一、引言 二、准备工作 三、搭建Flask应用程序 四、创建索引并插入数据 五、运行应用程序和测试搜索功能 一、引言 随着互联网的发展&#xff0c;搜索引擎已经成为我们获取信息的重要工具。然而&#xff0c;传统的搜索引擎如Google、Baidu等&#xff0c;虽然功能强大…
阅读更多...
C语言之刷到的怪题（i与sizeof(i)比较大小）

C语言之刷到的怪题（i与sizeof(i)比较大小）

这个题目一般都是选择输出<。为什么呢&#xff1f;因为i是一个全局变量&#xff0c;并且没有初始化&#xff0c;那么i的值就等于0。i--之后就是-1了。而sizeof(i)求出的就是整形变量对应的大小4个字节。-1<4&#xff0c;因此就选择 输出<。其实不然&#xff0c;这个si…
阅读更多...
1.迭代与递归 - JS

1.迭代与递归 - JS

迭代与递归是函数进阶的第一个门槛。迭代就是对已知变量反复赋值变换&#xff1b;递归就是函数体内调用自身。 迭代 一个迭代是就是一个循环&#xff0c;根据迭代式对变量反复赋值。 求近似根&#xff08;切线法&#xff09;&#xff1b; 迭代描述&#xff1a; x 0 x_0 x0…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023