Asp.NetCore 5.0 WebApi模型验证

最新推荐文章于 2025-11-01 09:59:38 发布

原创最新推荐文章于 2025-11-01 09:59:38 发布 · 581 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#c# #asp.net

本文介绍了如何在ASP.NET Core 3.1环境中创建一个自定义的Action过滤器，用于统一接口返回消息格式。首先定义了一个`ReturnMsg`类作为公共返回消息格式，然后实现`ModelValidateActionFilterAttribute`过滤器，该过滤器在模型验证失败时，将错误信息转换为定制的消息并返回。过滤器可以全局应用，确保验证不通过时不会执行具体的操作，提供了一种优雅的错误处理方式。

一、定义一个消息返回类

使用Action过滤器
　　首先定义一个消息返回类，用于所有接口消息规范返回格式，当然，这不是必须的；

	/// <summary>
    /// 公用的返回消息格式
    /// </summary>
    public class ReturnMsg
    {
        /// <summary>
        /// 返回的Code
        /// </summary>
        public string Code { get; set; }
 
        /// <summary>
        /// 消息
        /// </summary>
        public string Msg  { get; set; }
    }

二、自定义Action过滤器

1.然后自定义Action过滤器，我在.NetCore3.1环境下实现，使用的是Attribute的形式。

代码如下（示例）：

public class ModelValidateActionFilterAttribute : ActionFilterAttribute
    {
    //OnActionExecuted 在执行操作调用完成后，在返回结果操作之前调用。
    //OnActionExecuting 在模型绑定完成后，在执行操作之前调用。
    //OnResultExecuted 在操作结果执行之后调用。
    //OnResultExecuting 在操作结果执行之前调用。
        public override void OnActionExecuting(ActionExecutingContext context)
        {
            if (!context.ModelState.IsValid)
            {
                //公共返回数据类
                ReturnMsg returnMsg = new ReturnMsg() { Code = "500" };
 
                //获取具体的错误消息
                foreach (var item in context.ModelState.Values)
                {
                    //遍历所有项目的中的所有错误信息
                    foreach (var err in item.Errors)
                    {
                        //消息拼接,用|隔开，前端根据容易解析
                        returnMsg.Msg += $"{err.ErrorMessage}"+",";
                    }
                }
                returnMsg.Msg = returnMsg.Msg.TrimEnd(',')
                context.Result = new JsonResult(returnMsg);
            }
             
        }
    }