SpringBoot系列：自定义统一接口返回格式和统一全局异常处理

最新推荐文章于 2025-04-14 09:15:00 发布

Jaksioncc

最新推荐文章于 2025-04-14 09:15:00 发布

阅读量1.2k

点赞数 1

分类专栏： SpringBoot 文章标签： spring boot

本文链接：https://blog.youkuaiyun.com/qq_37712731/article/details/112707724

版权

本文介绍了在SpringBoot项目中如何实现统一的接口数据返回格式和全局异常处理。通过定义错误信息接口类、自定义枚举类、异常处理类以及全局异常处理类，可以提高开发效率并确保接口友好性。在测试中，展示了简单的全局异常捕获功能。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

在我们日常后台的开发中，统一的接口数据返回格式以及统一的全局异常处理，能够大大的提高我们开发效率和接口的友好性，当我们在写后台代码时，在我们的业务中出现一些判断的结果时，可以直接抛出自定义的异常，controller会做一个统一的异常处理返回给前端，我们只需要关注业务返回的结果就好了，把统一的数据返回格式写在controller层就好了。

开始

（1）定义一个基础的错误信息接口类

public interface BaseErrorInterface {
   
    /**
     * 错误码
     */
    String getResultCode();

    /**
     * 错误描述
     */
    String getResultMsg();
}

（2）自定义枚举类

自定义一个枚举类，并实现BaseErrorInterface接口，设置获取错误代码和信息。

public enum CommonEnum implements BaseErrorInterface {
   
    // 数据操作错误定义
    SUCCESS("200", "请求成功"),
    BODY_NOT_MATCH("400", "请求的数据格式不符"),
    SIGNATURE_NOT_MATCH("401", "请求的数字签名不匹配"),
    NOT_FOUND("404", "未找到该资源"),
    INTERNAL_SERVER_ERROR("500", "服务器内部错误"),
    SERVER_BUSY("503", "服务器正忙，请稍后再试");

    /**
     * 错误码
     */
    private String errCode;

    /**
     * 错误描述
     */
    private String errMsg;

    CommonEnum(String errCode, String errMsg) {
   
        this.errCode = errCode;
        this.errMsg = errMsg;
    }

    @Override
    public String getResultCode() {
   
        return errCode;
    }

    @Override
    public String getResultMsg() {
   
        return errMsg;
    }

（3）自定义异常处理类

public class MyException extends RuntimeException {
   

    private static final long serialVersionUID = 1L;

    /**
     * 错误码
     */
    protected String errorCode;
    /**
     * 错误信息
     */
    protected String errorMsg;

    public MyException() {
   
        super()