springmvc统一返回数据格式

最新推荐文章于 2023-09-29 00:00:03 发布

黑马Jack

最新推荐文章于 2023-09-29 00:00:03 发布

阅读量775

点赞数

分类专栏： Java springboot 文章标签： java json

本文链接：https://blog.csdn.net/m0_46991388/article/details/115611438

版权

本文介绍了如何在SpringMVC中实现接口统一返回JSON数据格式，包括状态码、消息和数据三个部分，通过创建返回码枚举类和结果类来规范返回信息，简化前端数据处理。使用枚举ResultCodeEnum定义状态码，创建R.java类封装返回数据，从而实现统一的数据格式。

摘要由CSDN通过智能技术生成

springmvc统一返回数据格式

springmvc会封装响应成json返回，一般我们会将所有接口的数据格式统一，使前端(iOS Android, Web)对数据的操作更一致、轻松。我们可以将返回数据格式统一为：1.状态码；2.返回消息；3.数据。
如下：

{
  "success": 布尔, //响应是否成功
  "code": 数字, //响应码
  "message": 字符串, //返回消息
  "data": HashMap //返回数据，放在键值对中
}

接下来进行统一返回数据格式的配置：

1、创建返回码定义枚举类

在guli-framework-common中创建包com.guli.common.constants，创建枚举类 ResultCodeEnum.java

@Getter
public enum ResultCodeEnum {

	SUCCESS(true, 20000,"成功"),
	UNKNOWN_REASON(false, 20001, "未知错误"),
	BAD_SQL_GRAMMAR(false, 21001, "sql语法错误"),
	JSON_PARSE_ERROR(false, 21002, "json解析异常"),
	PARAM_ERROR(false, 21003, "参数不正确"),
	FILE_UPLOAD_ERROR(false, 21004, "文件上传错误"),
	EXCEL_DATA_IMPORT_ERROR(false, 21005, "Excel数据导入错误");

	private Boolean success;

	private Inte