SpringBoot统一返回数据格式和统一异常处理

最新推荐文章于 2025-07-14 13:58:22 发布

mickey0380

最新推荐文章于 2025-07-14 13:58:22 发布

阅读量1.2k

点赞数 19

CC 4.0 BY-SA版权

分类专栏： JavaWeb 文章标签： java spring boot

本文链接：https://blog.csdn.net/mickey2007/article/details/137096137

1. 统一返回数据格式

目前的前后端开发大部分数据的传输格式都是json，因此定义一个统一规范的数据格式有利于前后端的交互与UI的展示。

1.1 统一结果的一般形式

是否响应成功
响应状态码
状态码描述
响应数据

1.2 创建状态码接口类

package com.miaxis.utils;
 
public interface ResultCode {
    /*成功状态码*/
    Integer SUCCESS = 20000;
    /*失败的状态码*/
    Integer ERROR = 20001;
}

1.3 创建统一结果类

只可以调用统一结果类的方法，不可以直接创建；

内置静态方法，返回对象；

为便于自定义统一结果的信息，建议使用链式编程，将返回对象设类本身，即return this;

响应数据由于为json格式，可定义为JsonObject或Map形式；

package com.miaxis.utils;
 
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
 
import java.util.HashMap;
import java.util.Map;
@Data
public class ResponseResult{
    private ResponseResult(){}
    @ApiModelProperty(value = "是否成功")
    private Boolean success;
    @ApiModelProperty(value = "状态码")
    private Integer code;
    @ApiModelProperty(value = "返回消息")
    private String message;
    @ApiModelProperty(value = "返回的数据")
    private Map<String,Object> data = new HashMap<>();
 
    /*提供工具方法*/
    public static ResponseResult ok(){
        ResponseResult responseResult = new ResponseResult();
        responseResult.se