SpringBoot的全域例外處理

注解@ControllerAdvice

使用 @ControllerAdvice注解類放在專案中，Spring能掃描到的地方，就可以實作全域例外的處理

注解@ExceptionHandler

捕獲到例外后會進入此注解的方法中去執行具體的代碼(比如跳轉html界面等等操作)

具體操作

1.創建MyExceptionHandler類

import ifshop.returnMapper.ReturnMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Map;

/**
 * @Author if
 * @Description:
 * 使用 @ControllerAdvice,只要把這個類放在專案中，Spring能掃描到的地方，就可以實作全域例外的處理
 * @Date 2021-02-13 下午 05:02
 */
@ControllerAdvice
public class MyExceptionHandler {
    @Autowired
    private ReturnMapper returnMapper;
    /**
     * 全域處理Exception
     * 錯誤的情況下回傳500
     * @return
     */
    @ResponseBody
    @ExceptionHandler(value = {Exception.class})
    public Map<String,Object> handleOtherExceptions() {
    //此處可以寫自己的具體的處理，以下僅示例例外時向前端回傳500和說明
        return returnMapper.returnMethod(500,"服務器出了點小差",null);
    }
}

注意： 代碼中的ReturnMapper類是我自定義的一個簡單回傳模板類，具體代碼如下：

import org.springframework.stereotype.Service;
import java.util.HashMap;
import java.util.Map;

/**
 * @Author if
 * @Description: What is it
 * @Date 2021-01-25 下午 06:35
 */
@Service
public class ReturnMapper {
    /**
     * 給網頁url，回傳int型別的狀態碼
     * 200 （成功） 服務器已成功處理了請求， 通常，這表示服務器提供了請求的網頁，
     * 400 （錯誤請求） 服務器不理解請求的語法，（引數錯誤或者少了）
     * 401 （無權限處理）禁止訪問介面
     * 404 （未找到） 服務器找不到請求的網頁，
     * 405 （方法禁用） 禁用請求中指定的方法，
     * 500 （服務器內部錯誤） 服務器遇到錯誤，無法完成請求，
     * 503 （服務正忙） 服務器目前無法使用（由于超載或停機維護）， 通常，這只是暫時狀態，
     * @param msg
     * @param data
     * @return 回傳給前端code狀態碼、msg提示訊息，data資料
     */
    public Map<String,Object> returnMethod(int http,String msg,Object data){
        Map<String,Object> map=new HashMap<>();
        map.put("code",http);
        /**
         * 訪問成功且有資料回傳
         */
        if(http == 200){
            map.put("msg",msg);
            map.put("data",data);
            return map;
        }
        /**
         * 404找不到網頁
         */
        else if(http==404){
            map.put("msg","找不到該頁面");
            return map;
        }
        /**
         * 401無權限操作
         */
        else if(http==401){
            map.put("msg","無權限操作");
            return map;
        }
        /**
         * 400,405,500訪問失敗
         */
        else{
            map.put("msg","服務器出了點小差");
            return map;
        }
    }
}

2.Controller類撰寫測驗介面代碼

import ifshop.returnMapper.ReturnMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Map;

/**
 * @Author if
 * @Description: What is it
 * @Date 2021-01-25 下午 06:35
 */
@RestController
public class UserController {
    @Autowired
    private ReturnMapper returnMapper;
    
    @PostMapping("testException")
    public Map<String,Object> test(){
        return returnMapper.returnMethod(200,"測驗","測驗");
    }
    @RequestMapping("helloTest")
    public Map<String,Object> test3(){
        return returnMapper.returnMethod(200,"正常訪問","正常測驗");
    }
}

3.測驗

按照正常的post訪問testException介面時會正常訪問用get訪問testException介面時會報405
如圖

但是我們撰寫了例外處理代碼，就會交給我們的全域例外處理類來處理，而不是spring自帶的處理
如圖

4.總結

這只是一個很簡單的全域例外處理的小例子，實際上springboot還有許多對于例外的處理機制，本博客只是對其中一個進行了示例