ASP.NET Core 2.2 WebApi 系列【八】统一返回格式(返回值、模型验证、异常)
现阶段,基本上都是前后端分离项目,这样一来,就需要前后端配合,没有统一返回格式,那么对接起来会很麻烦,浪费时间。我们需要把所有接口及异常错误信息都返回一定的Json格式,有利于前端处理,从而提高了工作效率。
一、准备工作
定义响应实体类
/// <summary>
/// 响应实体类
/// </summary>
public class ResultModel
{
/// <summary>
/// 状态码
/// </summary>
public int ReturnCode { get; set; } /// <summary>
/// 内容
/// </summary>
public object Data { get; set; } /// <summary>
/// 错误信息
/// </summary>
public string ErrorMessage { get; set; } /// <summary>
/// 是否成功
/// </summary>
public bool IsSuccess { get; set; }
}
修改Controller层
在controller层处理业务请求,new 一个ResultModel 对象,返回给前端。
/// <summary>
/// 查询用户
/// </summary>
/// <returns></returns>
[Route("getUser")]
[HttpGet]
public ResultModel GetUser()
{
var data = _userRepository.GetAll().ToList();
return new ResultModel() { Data = data, ErrorMessage = null, IsSuccess = true, ReturnCode = };
}
这样需要每个方法都需要重新new一个ResultModel 对象,感觉有点代码冗余。
我们只需要加几个静态方法,每个方法返回都是ResultModel对象,成功的时候调用ResultModel.OK,失败的时候调用ResultModel.ERROR即可。
优化
添加两个静态方法
/// <summary>
/// 成功
/// </summary>
/// <param name="data">返回数据</param>
/// <returns></returns>
public static ResultModel Ok(object data)
{
return new ResultModel { Data = data, ErrorMessage = null, IsSuccess = true, ReturnCode = };
}
/// <summary>
/// 失败
/// </summary>
/// <param name="str">错误信息</param>
/// <param name="code">状态码</param>
/// <returns></returns>
public static ResultModel Error(string str,int code)
{
return new ResultModel { Data = null, ErrorMessage = str, IsSuccess = false, ReturnCode = code };
}
修改控制器
/// <summary>
/// 查询用户
/// </summary>
/// <returns></returns>
[Route("getUser")]
[HttpGet]
public ResultModel GetUser()
{
var data = _userRepository.GetAll().ToList();
return ResultModel.Ok(data);
}
二、全局异常处理
通过全局异常处理,任何错误信息都会被拦截,返回统一格式。
定义全局异常处理中间件
using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using NetCoreWebApi.Util;
using Newtonsoft.Json; namespace NetCoreWebApi.Filter
{
/// <summary>
/// 处理全局信息中间件
/// </summary>
public class ExceptionMiddleWare
{
/// <summary>
/// 处理HTTP请求的函数。
/// </summary>
private readonly RequestDelegate _next;
/// <summary>
/// 构造函数
/// </summary>
/// <param name="next"></param>
public ExceptionMiddleWare(RequestDelegate next)
{
_next = next;
} public async Task Invoke(HttpContext context)
{
try
{
//抛给下一个中间件
await _next(context);
}
catch (Exception ex)
{
await WriteExceptionAsync(context, ex);
}
finally
{
await WriteExceptionAsync(context, null);
}
} private async Task WriteExceptionAsync(HttpContext context, Exception exception)
{
if (exception != null)
{
var response = context.Response;
var message = exception.InnerException == null ? exception.Message : exception.InnerException.Message;
response.ContentType = "application/json";
await response.WriteAsync(JsonConvert.SerializeObject(ResultModel.Error(message, ))).ConfigureAwait(false);
}
else
{
var code = context.Response.StatusCode;
switch (code)
{
case :
return;
case :
return;
case :
context.Response.ContentType = "application/json";
await context.Response.WriteAsync(JsonConvert.SerializeObject(ResultModel.Error("token已过期,请重新登录.", code))).ConfigureAwait(false);
break;
default:
context.Response.ContentType = "application/json";
await context.Response.WriteAsync(JsonConvert.SerializeObject(ResultModel.Error("未知错误", code))).ConfigureAwait(false);
break;
}
}
}
}
}
注册中间件
在Startup.cs启动类的Configure方法中添加UseMiddleware方法
//异常处理中间件
app.UseMiddleware(typeof(ExceptionMiddleWare));
三、验证实体模型
有两种方式:
1.使用自定义过滤器
2.使用默认自带的400模型验证,需要在控制器上面加上【ApiController】,这种方式优先级比较高,如果需要自定义模型验证,则需要先关闭默认的模型验证
【ApiController】
自动推断参数绑定:可以省略[FromBody]等参数特性
自动模型验证:自动验证模型是否合法
参考:https://blog.csdn.net/sD7O95O/article/details/81844154
services.AddMvc(e =>
{
e.Filters.Add<CheckModel>();
})
.SetCompatibilityVersion(CompatibilityVersion.Version_2_2)
.ConfigureApiBehaviorOptions(e =>
{
//关闭默认模型验证
e.SuppressModelStateInvalidFilter = true;
});
自定义过滤器
创建CheckModel过滤器继承ActionFilterAttribute抽象类,重写其中需要的方法
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using NetCoreWebApi.Util; namespace NetCoreWebApi.Filter
{
/// <summary>
/// 验证实体对象是否合法
/// </summary>
public class CheckModel : ActionFilterAttribute
{
/// <summary>
/// Action 调用前执行
/// </summary>
/// <param name="actionContext"></param>
public override void OnActionExecuting(ActionExecutingContext actionContext)
{
if (!actionContext.ModelState.IsValid)
{
//初始化返回结果
var result = new ResultModel { IsSuccess = false, ReturnCode = };
foreach (var item in actionContext.ModelState.Values)
{
foreach (var error in item.Errors)
{
result.ErrorMessage += error.ErrorMessage + "|";
}
}
actionContext.Result = new JsonResult(result);
}
}
/// <summary>
/// Action 方法调用后,Result 方法调用前执行
/// </summary>
/// <param name="context"></param>
public override void OnActionExecuted(ActionExecutedContext context)
{
}
}
}
将写的过滤器注册到全局
services.AddMvc(e =>
{
//注册过滤器
e.Filters.Add<CheckModel>();
})
.SetCompatibilityVersion(CompatibilityVersion.Version_2_2)
.ConfigureApiBehaviorOptions(e =>
{
//关闭默认模型验证
e.SuppressModelStateInvalidFilter = true;
});
创建UserDto
using System.ComponentModel.DataAnnotations; namespace NetCoreWebApi.Repository.Dto
{
/// <summary>
/// 用户传输对象
/// </summary>
public class UserDto
{
/// <summary>
/// 用户Id
/// </summary>
[StringLength(, ErrorMessage = "{0}最多{1}个字符"), Display(Name = "用户Id")]
public string UserId { get; set; }
/// <summary>
/// 用户名
/// </summary>
[StringLength(, ErrorMessage = "{0}最多{1}个字符"), Display(Name = "用户名")]
public string UserName { get; set; }
/// <summary>
/// 邮箱
/// </summary>
[StringLength(, ErrorMessage = "{0}最多{1}个字符"), Display(Name = "邮箱")]
public string Email { get; set; }
}
}
测试
默认模型验证
services.AddMvc(e =>
{
//注册过滤器
//e.Filters.Add<CheckModel>();
})
.SetCompatibilityVersion(CompatibilityVersion.Version_2_2)
.ConfigureApiBehaviorOptions(e =>
{
////关闭默认模型验证
//e.SuppressModelStateInvalidFilter = true;
e.InvalidModelStateResponseFactory = actionContext =>
{
//获取验证失败的模型字段
var errors = actionContext.ModelState
.Where(e1 => e1.Value.Errors.Count > )
.Select(e1 => e1.Value.Errors.First().ErrorMessage)
.ToList();
var str = string.Join("|", errors);
return new JsonResult(ResultModel.Error(str, ));
};
});
两种验证方法效果是一致的
ASP.NET Core 2.2 WebApi 系列【八】统一返回格式(返回值、模型验证、异常)的更多相关文章
- ASP.NET Core 2.2 WebApi 系列【九】使用SignalR (作者:tenghao510 ) 学习及内容补充
原文地址: ASP.NET Core 2.2 WebApi 系列[九]使用SignalR 今天,看到了大牛的这篇博文, 发了一下评论, 我很惊喜, 没想到他很快就回复了我, 而且通过QQ帮助了S ...
- ASP.NET Core 3.0 WebApi 系列【1】创建ASP.NET Core WebApi 项目
目录 写在前面 一.运行环境 二.项目搭建 三.测试 API 四.基础知识 五.写在最后 写在前面 C#语言可以创建RESTful服务,被称作WebApi.在这里总结学习使用支持创建.读取.更新.删除 ...
- ASP.NET Core 2.2 WebApi 系列【一】搭建ASP.NET Core WebApi项目
一.步骤 从“文件”菜单中选择“新建”>“项目” . 选择“ASP.NET Core Web 应用程序”模板,再单击“下一步” . 将项目命名为 NetCoreWebApi,然后单击“创建” . ...
- ASP.NET Core 3.0 WebApi 系列【2】.Net Core 3.0+ CodeFirst + MySql 实现数据的迁移
写在前面 在前一小节中,我们创建了基于RESFULL风格的服务.这个小节,尝试使用CodeFirst+MySql 的方式实现数据迁移. 一.开发环境 [1]运行环境:win10 家庭版 [2]开发工具 ...
- ASP.NET Core 2.2 WebApi 系列【九】使用SignalR
1.添加 SignalR 客户端库 右键点击项目->然后选择“添加” >“客户端库” 提供程序选择:unpkg ,库选择:@aspnet/signalr@1.1.4 选择“选择特定文件” ...
- ASP.NET Core 2.2 WebApi 系列【七】泛型仓储模式和工作单元
在之前的泛型仓储模式实现中,每个增删改都调用了SaveChanges方法,导致每次更新都提交了事务. 在实际开发过程中,我们经常遇到同时操作多张表数据,那么按照之前的写法,对数据库提交了多次操作,开启 ...
- ASP.NET Core 2.2 WebApi 系列【六】泛型仓储模式
为什么要使用泛型仓储?好处是? 前两章在autofac注入的时候,用的User类作为例子,写了增删改查四个接口,也就是仓储的GRUD. 当我们再添加一个实体(比如Student)时,StudentRe ...
- ASP.NET Core 2.2 WebApi 系列【五】MiniProfiler与Swagger集成
MiniProfiler 是一款性能分析的轻量级程序,可以基于action(request)记录每个阶段的耗时时长,还是可以显示访问数据库时的SQL(支持EF.EF Code First)等 一.安装 ...
- ASP.NET Core 2.2 WebApi 系列【四】集成Swagger
Swagger 是一款自动生成在线接口文档+功能测试功能软件 一.安装程序包 通过管理 NuGet 程序包安装,搜索Swashbuckle.AspNetCore 二.配置 Swagger 将 Swag ...
随机推荐
- python基础实战之猜年龄游戏
目录 一.Python基础实战之猜年龄游戏 给定年龄,用户可以猜三次年龄 年龄猜对,让用户选择两次奖励 用户选择两次奖励后可以退出 age = 18 # 答案 count = 0 # 游戏次数控制 p ...
- WPF的DataGrid用法-小白向
前几天打算尝试下DataGrid的用法,起初以为应该很简单,可后来被各种使用方法和功能实现所折磨.网络上的解决方法太多,但也太杂.没法子,我只好硬着头皮阅览各种文献资料,然后不断的去尝试,总算小有成果 ...
- javascript对url进行编码和解码
这里总结下JavaScript对URL进行编码和解码的三个方法. 为什么要对URL进行编码和解码 只有[0-9[a-Z] $ - _ . + ! * ' ( ) ,]以及某些保留字,才能不经过编码直接 ...
- javascript树形汇总金额
在开发企业应用的时候总会遇到树形汇总金额的场景,即将树形的列表中的叶子节点(没有子节点)的金额汇总到父节点上. 这种需求一般是在前端进行处理,即使用JavaScript处理,因为叶子节点的金额可能是不 ...
- .Net Core控制台&EFCore连接Mysql
在用惯了Asp.Net Core提供的基架后,反过来想一想,貌似忘记了控制台如何去连接数据库了,因此,写一篇文章来借此巩固下并以后再来回顾时,加快步骤. 1.新建一个.Net Core控制台,然后安装 ...
- 分布式系统的发展演变以及RPC简介
场景 什么是分布式系统 分布式系统是若干独立计算机的集合,这些计算机对于用户来说就像单个相关系统. 分布式系统是建立在网络之上的软件系统. 注: 博客: https://blog.csdn.net/b ...
- isNotBlank()和isNotEmpty()总结
import org.apache.commons.lang.StringUtils; import org.junit.Test; public class Test{ //总结:isNotBlan ...
- CSS入门(背景各种属性的详解、垂直居中和过渡效果的详解、渐变效果的简单讲解、雪碧图和精灵图)
一.各种背景属性 1.background-image 属性为元素设置背景图像. 元素的背景占据了元素的全部尺寸,包括内边距和边框,但不包括外边距. 默认地,背景图像位于元素的左上角,并在水平和垂直方 ...
- JavaScript 基于HTML5 canvas 获取文本占用的像素宽度
基于HTML5 canvas 获取文本占用的像素宽度 by:授客 QQ:1033553122 直接上代码 // 获取单行文本的像素宽度 getTextPixelWith(text, fontS ...
- iOS核心动画高级技巧-5
9. 图层时间 图层时间 时间和空间最大的区别在于,时间不能被复用 -- 弗斯特梅里克 在上面两章中,我们探讨了可以用CAAnimation和它的子类实现的多种图层动画.动画的发生是需要持续一段时间的 ...