.net web api在MVC架构下添加过滤器,返回统一类型,异常处理

25 篇文章 7 订阅
1 篇文章 0 订阅

简介:我们将通过OnActionExecuted方法来实现,OnActionExecuted是ASP.NET Core MVC框架提供的一个过滤器接口方法,用于在控制器方法执行后对结果进行处理。

  1. 新建ApiResponseFilter.cs过滤器实现类,继承于IActionFilter类,ApiResponseFilter.cs类全部代码如下
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc;
using MySqlX.XDevAPI.Common;

namespace EF_Core
{
    public class ApiResponseFilter : IActionFilter
    {
        public void OnActionExecuted(ActionExecutedContext context)
        {
            if (context.Exception != null)
            {
                // 如果发生异常,则返回统一的错误信息
                context.Result = new ObjectResult(new ApiResponse
                {
                    Success = false,
                    Message = context.Exception.Message,
                    StatusCode = 500
                })
                {
                    StatusCode = 500
                };
                context.ExceptionHandled = true;
            }
            else if (context.Result is ObjectResult result && result.StatusCode >= 200 && result.StatusCode < 300)
            {
                // 如果返回结果为ObjectResult且状态码为2xx,则将数据包装成ApiResponse对象
                context.Result = new ObjectResult(new ApiResponse
                {
                    Success = true,
                    Data = result.Value,
                    StatusCode = result.StatusCode.GetValueOrDefault(200)
                })
                {
                    StatusCode = result.StatusCode
                };
            }
            else
            {
                // 如果状态码为null或者不是2xx,将默认状态码设置为200
                context.Result = new ObjectResult(new ApiResponse
                {
                    Success = true,
                    Data = (context.Result as ObjectResult)?.Value,
                    StatusCode = 200
                })
                {
                    StatusCode = 200
                };
            }
        }

        public void OnActionExecuting(ActionExecutingContext context)
        {
            // 在执行Action前的处理,可不实现
        }
    }

    public class ApiResponse
    {
        public bool Success { get; set; }
        public string Message { get; set; }
        public object Data { get; set; }
        public int StatusCode { get; set; }
    }
}


在这里插入图片描述
2. 在Program.cs类中注册该过滤器。

builder.Services.AddControllers(options =>
 {
     options.Filters.Add(new ApiResponseFilter()); // 注册ApiResponseFilter
 });

在这里插入图片描述
3. 测试返回
在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值