亲手搓一个 ASP.NET Core 过滤器使用 统一返回值模型/规范化结果/API 返回值

已于 2023-11-01 20:38:41 修改
阅读量1.2k 收藏 8
点赞数 3
文章标签： asp.net 后端
于 2023-02-09 18:00:40 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45026510/article/details/128957780
版权
本文介绍了如何在ASP.NETCore.Net7.0项目中创建和使用过滤器来实现API的统一返回值模型，包括验证过滤器、异常过滤器和操作过滤器。通过自定义过滤器，可以标准化错误和成功响应，提供更好的API交互体验。同时，文章探讨了解决验证和操作拦截器可能出现的问题，以及提供了两种解决方案。
摘要由CSDN通过智能技术生成

亲手搓一个 ASP.NET Core 过滤器使用 统一返回值模型/规范化结果/API 返回值

环境 .Net 7.0 项目 ASP.NET Core WebAPI

筛选器、过滤器、拦截器介绍

ASP.NET Core 中的筛选器

请求管道

创建统一返回值基类

public class BaseResultModel
{
    public int? Code { get; set; }

    public string Message { get; set; }

    public object? Data { get; set; }

    public int ReturnStatus { get; set; }
}

拦截特性验证过滤器

IActionFilter 接口

编号方法说明
1OnActionExecuted(ActionExecutedContext)在操作执行后调用，然后执行操作结果。
2OnActionExecuting(ActionExecutingContext)在操作执行之前调用，模型绑定完成后。

自定义验证过滤器

public class ValidationError
{
    public ValidationError(string field, string message)
    {
        Field = field;
        Message = message;
    }

    public string Field { get; set; }

    public string Message { get; set; }
}

/// <summary>
/// 验证过滤器
/// </summary>
public class MyValidationFilterAttribute : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid) // 是否通过验证
        {
            var result = context.ModelState.Keys
                .SelectMany(key => context.ModelState[key]!.Errors.Select(x => new ValidationError(key, x.ErrorMessage)))
                .ToList();
            context.Result = new ObjectResult(new BaseResultModel
            {
                Code = 400,
                Message = "error",
                Data = result,
                ReturnStatus = 0
            });
        }
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        // throw new NotImplementedException();
    }
}

添加过滤器

添加过滤器

解除默认设置

builder.Services.Configure<ApiBehaviorOptions>(options =>
{
    options.SuppressModelStateInvalidFilter = true;
});

创建业务

// Person类用于接口请求数据
public class Person
{
    [Range(1,10,ErrorMessage = "范围1-10")]
    public int Age { get; set; }

    [MinLength(2,ErrorMessage = "名称不能低于2个字符")]
    public string Name { get; set; } = String.Empty;
}

// API接口
[HttpPost]
public Person AddPerson(Person input)
{
    return input;
}

事例

未通过特性验证

验证失败事例

验证成功事例

拦截异常过滤器

IExceptionFilter 接口

编号方法说明
1OnException(ExceptionContext)在操作引发后 Exception调用

自定义异常过滤器

/// <summary>
/// 异常过滤器
/// </summary>
public class MyExceptionFilterAttribute : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        var exception = context.Exception;
        context.ExceptionHandled = true;
        context.Result = new ObjectResult(new BaseResultModel()
        {
            Code = 400,
            Message = exception.InnerException != null ? exception.InnerException.Message : exception.Message,
            Data = exception.Message, // 可改为其他值
            ReturnStatus = 3
        });
    }
}

创建业务

[HttpGet]
public void ThrowException()
{
    throw new Exception("抛出了一个异常");
}

添加过滤器

添加异常拦截过滤器

事例

拦截异常

验证异常拦截

操作筛选器

IActionFilter 接口

编号方法说明
1OnActionExecuted(ActionExecutedContext)在操作执行后调用，然后执行操作结果。
2OnActionExecuting(ActionExecutingContext)在操作执行之前调用，模型绑定完成后。

自定义操作筛选器

/// <summary>
/// 操作拦截器
/// </summary>
public class MyActionFilterAttribute : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        // throw new NotImplementedException();
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        var result = context.Result as ObjectResult;
        context.Result = new OkObjectResult(new BaseResultModel
        {
            Code = 200,
            Message = "success",
            Data = result?.Value,
            ReturnStatus = 1
        });
    }
}

创建业务

[HttpPost]
public DateTime GetNowTime()
{
    return DateTime.Now;
}

添加过滤器

添加过滤器

事例

请求成功

使用拦截器统一返回值,将三个过滤器添加到配置中

builder.Services.AddMvc(options =>
{
    options.Filters.Add<MyActionFilterAttribute>();
    options.Filters.Add<MyExceptionFilterAttribute>();
    options.Filters.Add<MyValidationFilterAttribute>();
});

优化

原因

由于【特性拦截器】和【操作拦截器】都继承了IActionFilter接口，但拦截位置不同所以会出现异常信息包含在操作拦截器内(套娃现象)，所以要修改两个拦截器内逻辑

套娃

解决一

取消特性验证拦截器，在操作拦截器内进行验证判断

/// <summary>
/// 操作拦截器
/// </summary>
public class MyActionFilterAttribute : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        // throw new NotImplementedException();
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        if (!context.ModelState.IsValid)
        {
            var result = context.ModelState.Keys
                .SelectMany(key => context.ModelState[key]!.Errors.Select(x => new ValidationError(key, x.ErrorMessage)))
                .ToList();
            context.Result = new ObjectResult(new BaseResultModel
            {
                Code = 400,
                Message = "error",
                Data = result,
                ReturnStatus = ReturnStatus.Fail
            });
        }
        else
        {
            var statusCode = HttpStatusCode.OK;
            var result = context.Result as ObjectResult;
            context.Result = new OkObjectResult(new BaseResultModel
            {
                Code = (int)statusCode,
                Message = "success",
                Data = result?.Value,
                ReturnStatus = ReturnStatus.Success
            });
        }
    }
}

解决二

/// <summary>
/// 操作拦截器
/// </summary>
public class MyActionFilterAttribute : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            var result = context.ModelState.Keys
                .SelectMany(
                    key => context.ModelState[key]!.Errors.Select(x => new ValidationError(key, x.ErrorMessage)))
                .ToList();
            context.Result = new ObjectResult(new BaseResultModel
            {
                Code = 400,
                Message = "error",
                Data = result,
                ReturnStatus = ReturnStatus.Fail
            });
        }
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        var statusCode = HttpStatusCode.OK;
        var result = context.Result as ObjectResult;
        context.Result = new OkObjectResult(new BaseResultModel
        {
            Code = (int)statusCode,
            Message = "success",
            Data = result?.Value,
            ReturnStatus = ReturnStatus.Success
        });
    }
}

完整代码

/// <summary>
/// 异常过滤器
/// </summary>
public class MyExceptionFilterAttribute : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        var exception = context.Exception;
        context.ExceptionHandled = true;
        context.Result = new ObjectResult(new BaseResultModel()
        {
            Code = 400,
            Message = exception.InnerException != null ? exception.InnerException.Message : exception.Message,
            Data = exception.Message,
            ReturnStatus = ReturnStatus.Error
        });
    }
}

/// <summary>
/// 操作拦截器/特性拦截器
/// </summary>
public class MyActionFilterAttribute : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            var result = context.ModelState.Keys
                .SelectMany(
                    key => context.ModelState[key]!.Errors.Select(x => new ValidationError(key, x.ErrorMessage)))
                .ToList();
            context.Result = new ObjectResult(new BaseResultModel
            {
                Code = 400,
                Message = "error",
                Data = result,
                ReturnStatus = ReturnStatus.Fail
            });
        }
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        var statusCode = HttpStatusCode.OK;
        var result = context.Result as ObjectResult;
        context.Result = new OkObjectResult(new BaseResultModel
        {
            Code = (int)statusCode,
            Message = "success",
            Data = result?.Value,
            ReturnStatus = ReturnStatus.Success
        });
    }
}
JiaMu Sun
关注
  • 3
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
ASP.NET Core中的统一结果返回与统一异常处理
.Net技术、软件架构、人工智能、数字化转型、DeveloperSharp、微服务、工业互联网、智能制造
05-11 797
首先，我们可以定义一个简单的模型来表示API的返回结果。这个模型通常包含状态码、消息和可能的数据。set;set;set;在这个模型中，Code表示状态码，Message是返回的消息，而Data是返回的数据。
ASP.NET Core Mvc中空返回值的处理方法详解
10-17
在ASP.NET Core MVC中，当你在控制器的Action中返回`null`时，默认的行为是返回HTTP状态码204 NoContent，而不是像ASP.NET MVC或ASP.NET WebAPI那样返回200 OK并包含一个null的响应内容。这种变化的主要目的是优化...
.Net Core webapi RestFul 统一接口数据返回格式
lwpoor123的博客
12-21 2100
json对象中data是返回的实际结果对象，可以是一个对象、一个list、一个字符串、一个数字......分别实现类带有泛型的 ApiResponse 类和 ApiResponse 类。的隐式转换，所以就完美解决这个问题，大大减少了代码量。注意在泛型类中，使用运算符重载，实现了。中，我们定义了一个运算符重载，实现了。但是整体的json格式要以上面的为准。2、使用过滤器(Filter)实现。类型呀，这不是类型不一致吗？1、自定义一个统一返回类。但这接口的返回值明明是。创建对应的接口和实现类。
【AOP】ASP.NET Core中各种Filter（拦截器）
最新发布
在这里你大概率会有所收获，欢迎指错||纠正||建议||水评+点赞&&评论&&关注&&转发
06-05 838
在ASP.NET Core中，Filter（过滤器）是一种强大的机制，允许你在请求处理管道中的特定阶段运行代码。这些过滤器提供了在请求的不同阶段执行逻辑的能力，比如授权、日志记录、异常处理等。ASP.NET Core 提供了多种类型的过滤器，每种类型都在请求处理管道的不同阶段运行。
ASP.NET Core 统一异常处理和返回
10年职场两茫茫，35岁凄凉奈若何
01-29 389
ASP.NET Core 统一异常处理和返回
详解ASP.NET Core WebApi 返回统一格式参数
10-17
主要介绍了详解ASP.NET Core WebApi 返回统一格式参数，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
ASP .NET Core Api 使用过滤器
csdn_aspnet的专栏
01-28 1万+
资源过滤器在模型验证和模型绑定请求之前运行，也在我们的请求结果从服务器返回时运行。ActionFilterAttribute 拦截器通过 重写 OnActionExecuting，来 拦截action的请求消息，当执行OnActionExecuting完成以后才真正进入请求的action中，action运行完后又把控制权给了 OnActionExecuted，这个管道机制可以使我们用它来轻松实现 权限认证、日志记录 ，跨域以及很多需要对全局或者部分请求做手脚的的功能。异步ActionFilter。
ASP.NET Core WebApi返回结果统一包装实践
秉持Love and share的态度去学习和生活
06-13 1588
近期在重新搭建一套基于ASP.NET Core WebAPI的框架，这其中确实带来了不少的收获，毕竟当你想搭建一套框架的时候，你总会不自觉的去想，如何让这套框架变得更完善一点更好用一点。其中在关于WebApi统一结果返回的时候，让我也有了更一步的思考，首先是如何能更好的限制返回统一的格式，其次是关于结果的包装一定是更简单更强大。在不断的思考和完善中，终于有了初步的成果，便分享出来，学无止境思考便无止境，希望以此能与君共勉。 首先如果让返回的结果格式统一，就得有一个统一的包装类去包装所有的返回结果...
ASP.NET Core中的Action的返回值类型实现
10-15
ASP.NET Core是一个高度可扩展的开源框架，用于构建现代、跨平台的Web应用程序。在ASP.NET Core中，控制器的Action方法扮演着核心角色，它们处理客户端请求并返回响应。本文将详细探讨ASP.NET Core中Action的返回值...
ASP.NET Core 过滤器中使用依赖注入知识点总结
01-01
在ASP.NET Core里，我们可以使用ServiceFilter来完成这个需求。 ServiceFilter允许我们解析一个已经添加IoC容器的服务，因此我们需要把ContentFilter注册一下。 services.AddScoped(); 在需要的地方直接用特性方式...
ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法
01-20
ASP.NET Core WebAPI中使用FluentValidation验证数据模型是一种高效且灵活的方式，它极大地简化了对用户输入数据的验证过程。FluentValidation库允许开发者创建强类型的验证规则，使得代码更加整洁，易于维护。 ...
ASP.NET Core 3.0 gRPC拦截器的使用
10-15
主要介绍了ASP.NET Core 3.0 gRPC拦截器的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
ASP.NET Core基础之AOP编程(二)-拦截器
物联网大联盟
12-12 1314
实现AOP的另外一种方式是拦截器，那么它和过滤器有什么区别呢？
netcore 过滤器 拦截器
qq_39788123的博客
05-07 987
.net core 3.1 过滤器(Filter) 和AOP面向切面拦截器_11980719的技术博客_51CTO博客
netcore使用过滤器特性，限定方法在指定环境（Development,Staging,Production）是否运行
atzqtzq的博客
03-11 275
1.特性 /// <summary> /// 运行环境：Development,Staging,Production /// </summary> public class EnableHostEnvionmentAttribute : ActionFilterAttribute { private string hostEnvNames; /// <summary> ///
【.Net Core】过滤器Filter
在这里你大概率会有所收获，欢迎指错||纠正||建议||水评+点赞&&评论&&关注&&转发
02-02 3067
通过使用 ASP.NET Core 中的筛选器，可在请求处理管道中的特定阶段之前或之后运行代码。 内置筛选器处理任务，例如： 授权（防止用户访问未获授权的资源）。 响应缓存（对请求管道进行短路出路，以便返回缓存的响应）。 可以创建自定义筛选器，用于处理横切关注点。 横切关注点的示例包括错误处理、缓存、配置、授权和日志记录。 筛选器可以避免复制代码。 例如，错误处理异常筛选器可以合并错误处理。 本文档适用于 Razor Pages、API 控制器和具有视图的控制器。 筛选器不能直接用于 Razor 组件
ASP.NET Core MVC （core 3.1)拦截器
weixin_45381269的博客
09-20 1338
ASP.NET Core MVC （core 3.1)拦截器
过滤器 和 拦截器的 6个区别，别再傻傻分不清了
热门推荐
程序员内点事
06-04 9万+
哎~ 丢了大人了
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值