.NET 自定义过滤器 - ActionFilterAttribute

2024-09-08 06:44

本文主要是介绍.NET 自定义过滤器 - ActionFilterAttribute,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

这个代码片段定义了一个自定义的 ASP.NET Core 过滤器(GuardModelStateAttribute),用于在控制器动作执行之前验证模型状态(ModelState)。如果模型状态无效,则构造一个 ProblemDetails 对象来描述错误,并返回一个 BadRequest 响应。

代码片段:

/// <summary>
/// 验证 ModelState 是否有效
/// </summary>
public class GuardModelStateAttribute : ActionFilterAttribute
{// <summary>/// 在执行操作之前进行验证。/// 如果模型状态无效,则返回 BadRequest 响应。/// </summary>/// <param name="context">Action 执行上下文</param>public override void OnActionExecuting(ActionExecutingContext context){// 验证 ModelState 是否有效if (!context.ModelState.IsValid){// 构造 ProblemDetails 对象来构建错误响应var problemDetails = new ProblemDetails{Title = "Bad Request",                          // 错误标题Detail = "参数验证失败,请检查输入参数",           // 错误详情Status = (int)HttpStatusCode.BadRequest,        // HTTP 状态码Instance = context.HttpContext.Request.Path,    // 请求路径};// 遍历 ModelState 字典,将错误信息添加到 Extensions 字典中foreach (var key in context.ModelState.Keys){// 获取每个键对应的错误信息var errors = context.ModelState[key]?.Errors;// 如果没有错误信息,则跳过if (errors is not { Count: > 0 }) continue;// 遍历每个错误,并将其添加到 ProblemDetails 的 Extensions 字典中foreach (var error in errors){problemDetails.Extensions.Add(key, error.ErrorMessage);}}// 设置响应结果context.Result = new BadRequestObjectResult(problemDetails);}}
}

代码解读

  1. 类定义

    public class GuardModelStateAttribute : ActionFilterAttribute
    
    • GuardModelStateAttribute 继承自 ActionFilterAttribute,这是一个内置的过滤器接口,用于在执行控制器动作前后执行一些逻辑。
  2. 覆盖 OnActionExecuting 方法

    public override void OnActionExecuting(ActionExecutingContext context)
    
    • OnActionExecuting 方法是在控制器动作执行之前调用的。覆盖这个方法可以让我们在动作执行前做一些预处理工作。
  3. 验证模型状态

    if (!context.ModelState.IsValid)
    
    • ModelState.IsValid 是一个布尔属性,表示模型状态是否有效。如果为 false,表示模型状态无效,即请求中的数据未通过验证。
  4. 构造 ProblemDetails 对象

    var problemDetails = new ProblemDetails
    {Title = "Bad Request",Detail = "参数验证失败,请检查输入参数",Status = (int)HttpStatusCode.BadRequest,Instance = context.HttpContext.Request.Path,
    };
    
    • ProblemDetails 是一个标准的对象,用于描述 HTTP 错误响应。这里设置了错误标题、详细信息、HTTP 状态码(400 Bad Request)以及请求的路径。
  5. 收集并附加错误信息

    foreach (var key in context.ModelState.Keys)
    {var errors = context.ModelState[key]?.Errors;if (errors is not { Count: > 0 }) continue;foreach (var error in errors){problemDetails.Extensions.Add(key, error.ErrorMessage);}
    }
    
    • 遍历 ModelState 中的所有键值对,获取每个字段的验证错误信息,并将这些错误信息添加到 ProblemDetailsExtensions 字典中。
  6. 设置响应结果

    context.Result = new BadRequestObjectResult(problemDetails);
    
    • 设置 ActionExecutingContextResult 属性,返回一个包含 ProblemDetailsBadRequestObjectResult,这将导致控制器不再继续执行,并返回一个带有错误信息的 HTTP 响应。

作用

这个自定义过滤器的作用是:

  • 验证模型状态:在控制器动作执行之前验证请求中的数据是否满足验证规则。
  • 返回错误响应:如果数据验证失败,则构造一个包含详细错误信息的 ProblemDetails 对象,并返回一个 BadRequest 响应。
  • 简化错误处理:通过在过滤器中集中处理模型状态验证,可以减少在每个控制器动作中重复编写类似的错误处理逻辑。

使用方法

// Add services to the container.
#region 向容器中添加服务// 关闭默认模型验证过滤器
builder.Services.Configure<ApiBehaviorOptions>(options => options.SuppressModelStateInvalidFilter = true);builder.Services.AddControllers(options =>
{// 添加过滤器options.Filters.Add<GuardModelStateAttribute>();
})
.AddNewtonsoftJson(options =>
{options.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss"; //格式化时间
});#endregion

要在控制器中使用这个过滤器,可以在控制器或动作方法上添加 [GuardModelState] 属性:

[ApiController]
[Route("[controller]")]
[GuardModelState] // 在控制器级别应用过滤器
public class MyController : ControllerBase
{[HttpGet("{id}")]public ActionResult Get(int id){// 控制器逻辑return Ok();}[HttpPost][GuardModelState] // 在动作方法级别应用过滤器public ActionResult Post([FromBody] MyModel model){// 控制器逻辑return Ok();}
}

总结

GuardModelStateAttribute 是一个自定义的 ASP.NET Core 过滤器,用于在控制器动作执行前验证模型状态,并在模型状态无效时返回一个带有详细错误信息的 BadRequest 响应。通过使用这个过滤器,可以简化错误处理逻辑,并提高代码的可维护性和可读性。

这篇关于.NET 自定义过滤器 - ActionFilterAttribute的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1147411

相关文章

如何自定义Nginx JSON日志格式配置

《如何自定义NginxJSON日志格式配置》Nginx作为最流行的Web服务器之一,其灵活的日志配置能力允许我们根据需求定制日志格式,本文将详细介绍如何配置Nginx以JSON格式记录访问日志,这种... 目录前言为什么选择jsON格式日志?配置步骤详解1. 安装Nginx服务2. 自定义JSON日志格式各

Android自定义Scrollbar的两种实现方式

《Android自定义Scrollbar的两种实现方式》本文介绍两种实现自定义滚动条的方法,分别通过ItemDecoration方案和独立View方案实现滚动条定制化,文章通过代码示例讲解的非常详细,... 目录方案一:ItemDecoration实现(推荐用于RecyclerView)实现原理完整代码实现

基于Spring实现自定义错误信息返回详解

《基于Spring实现自定义错误信息返回详解》这篇文章主要为大家详细介绍了如何基于Spring实现自定义错误信息返回效果,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录背景目标实现产出背景Spring 提供了 @RestConChina编程trollerAdvice 用来实现 HTT

SpringSecurity 认证、注销、权限控制功能(注销、记住密码、自定义登入页)

《SpringSecurity认证、注销、权限控制功能(注销、记住密码、自定义登入页)》SpringSecurity是一个强大的Java框架,用于保护应用程序的安全性,它提供了一套全面的安全解决方案... 目录简介认识Spring Security“认证”(Authentication)“授权” (Auth

Spring Boot拦截器Interceptor与过滤器Filter详细教程(示例详解)

《SpringBoot拦截器Interceptor与过滤器Filter详细教程(示例详解)》本文详细介绍了SpringBoot中的拦截器(Interceptor)和过滤器(Filter),包括它们的... 目录Spring Boot拦截器(Interceptor)与过滤器(Filter)详细教程1. 概述1

SpringBoot自定义注解如何解决公共字段填充问题

《SpringBoot自定义注解如何解决公共字段填充问题》本文介绍了在系统开发中,如何使用AOP切面编程实现公共字段自动填充的功能,从而简化代码,通过自定义注解和切面类,可以统一处理创建时间和修改时间... 目录1.1 问题分析1.2 实现思路1.3 代码开发1.3.1 步骤一1.3.2 步骤二1.3.3

dubbo3 filter(过滤器)如何自定义过滤器

《dubbo3filter(过滤器)如何自定义过滤器》dubbo3filter(过滤器)类似于javaweb中的filter和springmvc中的intercaptor,用于在请求发送前或到达前进... 目录dubbo3 filter(过滤器)简介dubbo 过滤器运行时机自定义 filter第一种 @A

基于.NET编写工具类解决JSON乱码问题

《基于.NET编写工具类解决JSON乱码问题》在开发过程中,我们经常会遇到JSON数据处理的问题,尤其是在数据传输和解析过程中,很容易出现编码错误导致的乱码问题,下面我们就来编写一个.NET工具类来解... 目录问题背景核心原理工具类实现使用示例总结在开发过程中,我们经常会遇到jsON数据处理的问题,尤其是

Node.js net模块的使用示例

《Node.jsnet模块的使用示例》本文主要介绍了Node.jsnet模块的使用示例,net模块支持TCP通信,处理TCP连接和数据传输,具有一定的参考价值,感兴趣的可以了解一下... 目录简介引入 net 模块核心概念TCP (传输控制协议)Socket服务器TCP 服务器创建基本服务器服务器配置选项服

Java 8 Stream filter流式过滤器详解

《Java8Streamfilter流式过滤器详解》本文介绍了Java8的StreamAPI中的filter方法,展示了如何使用lambda表达式根据条件过滤流式数据,通过实际代码示例,展示了f... 目录引言 一.Java 8 Stream 的过滤器(filter)二.Java 8 的 filter、fi