快捷導(dǎo)航

SpringMVC實現(xiàn)全局異常處理器的經(jīng)典案例

更新時間：2025年03月26日 11:08:39 作者：凱醬

文章介紹了如何使用@ControllerAdvice和相關(guān)注解實現(xiàn)SpringMVC的全局異常處理,通過統(tǒng)一的異常處理類和自定義業(yè)務(wù)異常類,可以將所有控制器的異常集中處理,并以JSON格式返回給前端,感興趣的朋友一起看看吧

通過 @ControllerAdvice 注解，我們可以在一個地方對所有 @Controller 注解的控制器進行管理。
注解了 @ControllerAdvice 的類的方法可以使用 @ExceptionHandler、 @InitBinder、 @ModelAttribute 注解到方法上，這對所有注解了 @RequestMapping 的控制器內(nèi)的方法都有效。

@ExceptionHandler：用于捕獲所有控制器里面的異常，并進行處理。@InitBinder：用來設(shè)置 WebDataBinder，WebDataBinder 用來自動綁定前臺請求參數(shù)到 Model 中。@ModelAttribute：@ModelAttribute 本來的作用是綁定鍵值對到 Model
里，此處是讓全局的@RequestMapping 都能獲得在此處設(shè)置的鍵值對。

本文使用 @ControllerAdvice + @ExceptionHandler 進行全局的 Controller 層異常處理。只要設(shè)計得當(dāng)，就再也不用在 Controller 層進行 try-catch 了！

一、經(jīng)典案例

需求：希望通過全局統(tǒng)一的異常處理將自定義錯誤碼以json的形式發(fā)送給前端。
1、統(tǒng)一返回結(jié)果類 ApiResult
首先，定義一個統(tǒng)一結(jié)果返回類，最終需要將這個結(jié)果類的內(nèi)容返回給前端。

package com.tao.smp.exception;
/**
 * Api統(tǒng)一的返回結(jié)果類
 */
public class ApiResult {
    /**
     * 結(jié)果碼
     */
    private String code;
    /**
     * 結(jié)果碼描述
     */
    private String msg;
    public ApiResult() {
    }
    public ApiResult(ResultCode resultCode) {
        this.code = resultCode.getCode();
        this.msg = resultCode.getMsg();
    }
    /**
     * 生成一個ApiResult對象, 并返回
     *
     * @param resultCode
     * @return
     */
    public static ApiResult of(ResultCode resultCode) {
        return new ApiResult(resultCode);
    }
    public String getCode() {
        return code;
    }
    public void setCode(String code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    @Override
    public String toString() {
        return "ApiResult{" +
                "code='" + code + '\'' +
                ", msg='" + msg + '\'' +
                '}';
    }
}

2、錯誤碼枚舉類 ResultCode
有了 ApiResult ，接下來需要定義一個枚舉類，來包含所有自定義的結(jié)果碼。

package com.tao.smp.exception;
/**
 * 錯誤碼
 */
public enum ResultCode {
    /**
     * 成功
     */
    SUCCESS("0", "success"),
    /**
     * 未知錯誤
     */
    UNKNOWN_ERROR("0x10001", "unkonwn error"),
    /**
     * 用戶名錯誤或不存在
     */
    USERNAME_ERROR("0x10002", "username error or does not exist"),
    /**
     * 密碼錯誤
     */
    PASSWORD_ERROR("0x10003", "password error"),
    /**
     * 用戶名不能為空
     */
    USERNAME_EMPTY("0x10004", "username can not be empty");
    /**
     * 結(jié)果碼
     */
    private String code;
    /**
     * 結(jié)果碼描述
     */
    private String msg;
    ResultCode(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public String getCode() {
        return code;
    }
    public String getMsg() {
        return msg;
    }
}

3、自定義業(yè)務(wù)異常類 BusinessRuntimeException
接下來需要定義我們自己的業(yè)務(wù)異常類，以后和業(yè)務(wù)相關(guān)的異常通通拋出這個異常類，我們將錯誤碼枚舉變量的值存于其中。

package com.tao.smp.exception;
/**
 * 自定義業(yè)務(wù)異常
 */
public class BusinessRuntimeException extends RuntimeException {
    /**
     * 結(jié)果碼
     */
    private String code;
    /**
     * 結(jié)果碼描述
     */
    private String msg;
    /**
     * 結(jié)果碼枚舉
     */
    private ResultCode resultCode;
    public BusinessRuntimeException(ResultCode resultCode) {
        super(resultCode.getMsg());
        this.code = resultCode.getCode();
        this.msg = resultCode.getMsg();
        this.resultCode = resultCode;
    }
    public String getCode() {
        return code;
    }
    public void setCode(String code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public ResultCode getResultCode() {
        return resultCode;
    }
    public void setResultCode(ResultCode resultCode) {
        this.resultCode = resultCode;
    }
}

4、全局異常處理類 GlobalExceptionResolver

最后便是定義全局異常處理類。

通過 @ControllerAdvice 指定該類為 Controller 增強類。
通過 @ExceptionHandler 自定捕獲的異常類型。
通過 @ResponseBody 返回 json 到前端。

注意一點：被@ControllerAdvice注解的全局異常處理類也是一個 Controller ，我們需要配置掃描路徑，確保能夠掃描到這個Controller。

package com.tao.smp.exception;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
/**
 * 全局Controller層異常處理類
 */
@ControllerAdvice
public class GlobalExceptionResolver {
    private static final Logger LOG = LoggerFactory.getLogger(GlobalExceptionResolver.class);
    /**
     * 處理所有不可知異常
     *
     * @param e 異常
     * @return json結(jié)果
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ApiResult handleException(Exception e) {
        // 打印異常堆棧信息
        LOG.error(e.getMessage(), e);
        return ApiResult.of(ResultCode.UNKNOWN_ERROR);
    }
    /**
     * 處理所有業(yè)務(wù)異常
     *
     * @param e 業(yè)務(wù)異常
     * @return json結(jié)果
     */
    @ExceptionHandler(BusinessRuntimeException.class)
    @ResponseBody
    public ApiResult handleOpdRuntimeException(BusinessRuntimeException e) {
        // 不打印異常堆棧信息
        LOG.error(e.getMsg());
        return ApiResult.of(e.getResultCode());
    }
}

二、測試

1、測試 TestController

package com.tao.smp.controller;
import com.tao.smp.exception.BusinessRuntimeException;
import com.tao.smp.exception.ResultCode;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
/**
 * 測試異常的拋出
 */
@Controller
@RequestMapping("/")
public class TestController {
    /**
     * 測試返回異常信息
     * @return
     */
    @GetMapping("/exception")
    public String returnExceptionInfo() {
        if (1 != 2) {
            // 用戶民錯誤或不存在異常
            throw new BusinessRuntimeException(ResultCode.USERNAME_ERROR);
        }
        return "success";
    }
}