快捷導(dǎo)航

SpringBoot統(tǒng)一響應(yīng)格式及統(tǒng)一異常處理

更新時(shí)間：2023年05月11日 09:24:25 作者：JK凱

在我們開發(fā)SpringBoot后端服務(wù)時(shí)，一般需要給前端統(tǒng)一響應(yīng)格式，本文主要介紹了SpringBoot統(tǒng)一響應(yīng)格式及統(tǒng)一異常處理

一、統(tǒng)一響應(yīng)基礎(chǔ)類

在項(xiàng)目中對(duì)應(yīng)工具類或Vo層來創(chuàng)建我們的統(tǒng)一響應(yīng)類

ResponseResult:

import com.fasterxml.jackson.annotation.JsonInclude;
import com.zhang.enums.AppHttpCodeEnum;
import java.io.Serializable;
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ResponseResult<T> implements Serializable {
    private Integer code;
    private String msg;
    private T data;
    public ResponseResult() {
        this.code = AppHttpCodeEnum.SUCCESS.getCode();
        this.msg = AppHttpCodeEnum.SUCCESS.getMsg();
    }
    public ResponseResult(Integer code, T data) {
        this.code = code;
        this.data = data;
    }
    public ResponseResult(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    public ResponseResult(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public static ResponseResult errorResult(int code, String msg) {
        ResponseResult result = new ResponseResult();
        return result.error(code, msg);
    }
    public static ResponseResult okResult() {
        ResponseResult result = new ResponseResult();
        return result;
    }
    public static ResponseResult okResult(int code, String msg) {
        ResponseResult result = new ResponseResult();
        return result.ok(code, null, msg);
    }
    public static ResponseResult okResult(Object data) {
        ResponseResult result = setAppHttpCodeEnum(AppHttpCodeEnum.SUCCESS, AppHttpCodeEnum.SUCCESS.getMsg());
        if (data != null) {
            result.setData(data);
        }
        return result;
    }
    public static ResponseResult errorResult(AppHttpCodeEnum enums) {
        return setAppHttpCodeEnum(enums, enums.getMsg());
    }
    public static ResponseResult errorResult(AppHttpCodeEnum enums, String msg) {
        return setAppHttpCodeEnum(enums, msg);
    }
    public static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums) {
        return okResult(enums.getCode(), enums.getMsg());
    }
    private static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums, String msg) {
        return okResult(enums.getCode(), msg);
    }
    public ResponseResult<?> error(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
        return this;
    }
    public ResponseResult<?> ok(Integer code, T data) {
        this.code = code;
        this.data = data;
        return this;
    }
    public ResponseResult<?> ok(Integer code, T data, String msg) {
        this.code = code;
        this.data = data;
        this.msg = msg;
        return this;
    }
    public ResponseResult<?> ok(T data) {
        this.data = data;
        return this;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public T getData() {
        return data;
    }
    public void setData(T data) {
        this.data = data;
    }
}

里面還有用到一個(gè)響應(yīng)的枚舉類AppHttpCodeEnum，接下來我們創(chuàng)建這個(gè)枚舉類

二、響應(yīng)枚舉類

AppHttpCodeEnum:

public enum AppHttpCodeEnum {
    // 成功
    SUCCESS(200, "操作成功"),
    // 登錄
    NEED_LOGIN(401, "需要登錄后操作"),
    NO_OPERATOR_AUTH(403, "無權(quán)限操作"),
    SYSTEM_ERROR(500, "出現(xiàn)錯(cuò)誤"),
    USERNAME_EXIST(501, "用戶名已存在"),
    PHONENUMBER_EXIST(502, "手機(jī)號(hào)已存在"), EMAIL_EXIST(503, "郵箱已存在"),
    REQUIRE_USERNAME(504, "必需填寫用戶名"),
    CONTENT_NOT_NULL(506, "評(píng)論內(nèi)容不能為空"),
    FILE_TYPE_ERROR(507, "文件類型錯(cuò)誤"),
    USERNAME_NOT_NULL(508, "用戶名不能為空"),
    NICKNAME_NOT_NULL(509, "昵稱不能為空"),
    PASSWORD_NOT_NULL(510, "密碼不能為空"),
    EMAIL_NOT_NULL(511, "郵箱不能為空"),
    NICKNAME_EXIST(512, "昵稱已存在"),
    LOGIN_ERROR(505, "用戶名或密碼錯(cuò)誤");
    int code;
    String msg;
    AppHttpCodeEnum(int code, String errorMessage) {
        this.code = code;
        this.msg = errorMessage;
    }
    public int getCode() {
        return code;
    }
    public String getMsg() {
        return msg;
    }
}

一般我們?cè)谶@個(gè)枚舉類中管理需要響應(yīng)的錯(cuò)誤code及msg

三、統(tǒng)一響應(yīng)格式使用

在對(duì)應(yīng)的controller或者service里面使用統(tǒng)一響應(yīng)類

成功: ResponseResult.okResult()
失敗: ResponseResult.errorResult(AppHttpCodeEnum.SYSTEM_ERROR), 參數(shù)傳入我們定義的響應(yīng)枚舉類

四、統(tǒng)一異常處理

1. 自定義異常

為什么我們需要自定義異常？因?yàn)樵谀承┣闆r下，我們需要返回我們自定義的響應(yīng)格式非常不方便，如在處理用戶鑒權(quán)或token校驗(yàn)的時(shí)候，因?yàn)橄襁@些部分我們一般都是在單獨(dú)的工具類中去處理，這時(shí)候如果報(bào)錯(cuò)其實(shí)就可以拋出我們自定義的異常，交由我們?nèi)值漠惓Ｌ幚砣ソy(tǒng)一返回響應(yīng)。

在exception包下新建SystemException類
SystemException繼承RuntimeException

具體實(shí)現(xiàn)代碼如下

exception.SystemException:

import com.jk.enums.AppHttpCodeEnum;
public class SystemException extends RuntimeException{
    private int code;
    private String msg;
    public int getCode() {
        return code;
    }
    public String getMsg() {
        return msg;
    }
    public SystemException(AppHttpCodeEnum appHttpCodeEnum) {
        super(appHttpCodeEnum.getMsg());
        this.code = appHttpCodeEnum.getCode();
        this.msg = appHttpCodeEnum.getMsg();
    }
}

目前只是自定義了異常，我們還需要對(duì)自定義的異常進(jìn)行處理，返回統(tǒng)一的響應(yīng)格式。

2.異常處理

在handler.exception包下新建GlobalExceptionHandler處理類
@RestControllerAdvice是組合注解，由@ControllerAdvice、@ResponseBody組成，標(biāo)明是一個(gè)統(tǒng)一異常處理的類，并把返回結(jié)果封裝在ResponseBody中
@Slf4j是Lombok實(shí)現(xiàn)日志輸出的注解
@ExceptionHandler標(biāo)明該方法處理哪些異常

具體代碼實(shí)現(xiàn)如下:

handler.exception.GlobalExceptionHandler:

import com.jk.enums.AppHttpCodeEnum;
import com.jk.exception.SystemException;
import com.jk.vo.ResponseResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    @ExceptionHandler(SystemException.class)
    public ResponseResult systemExceptionHandler(SystemException e) {
        log.error("出現(xiàn)了異常! {}", e);
        return ResponseResult.errorResult(e.getCode(), e.getMsg());
    }
    @ExceptionHandler(Exception.class)
    public ResponseResult exceptionHandler(Exception e) {
        log.error("出現(xiàn)了異常! {}", e);
        return ResponseResult.errorResult(AppHttpCodeEnum.SYSTEM_ERROR.getCode(), e.getMessage());
    }
}

可以看到我們除了處理自定義異常SystemException外，還對(duì)Exception就是其他我們無法預(yù)料到的異常做了一個(gè)兜底。

3.自定義異常使用

在需要拋出異常的地方:

throw new SystemException(AppHttpCodeEnum.LOGIN_ERROR);

前端接收到的響應(yīng)是:

{
    "code": 505,
    "msg": "用戶名或密碼錯(cuò)誤"
}

這樣就比接收到500錯(cuò)誤也不知道錯(cuò)誤原因好多了。

到此這篇關(guān)于SpringBoot統(tǒng)一響應(yīng)格式及統(tǒng)一異常處理的文章就介紹到這了,更多相關(guān)SpringBoot統(tǒng)一響應(yīng)格式及異常處理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: