SpringBoot實作統一異常處理

分享知識 傳遞快樂

Spring Boot 實作統一異常處理的方法主要有以下兩種：

• 使用@ControllerAdvice和@ExceptionHandler注解
• 使用ErrorController類來實作

1、使用@ControllerAdvice和@ExceptionHandler注解

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.multipart.MaxUploadSizeExceededException;
import org.springframework.web.servlet.ModelAndView;

import com.xh.common.util.map.PageData;
import com.xh.common.util.result.Result;

@ControllerAdvice
public class LocalExceptionHandler {

  @ExceptionHandler(ResultException.class)
  @ResponseBody
  public Result handleResultException(ResultException e) {
    return Result.exception("500", "操作異常", e.getMessage());
  }
  
  @ExceptionHandler(MaxUploadSizeExceededException.class)
  public ModelAndView handleResultException(MaxUploadSizeExceededException e) {
    PageData.entityToMap(Result.exception("403", "上傳檔案過大"));
    return new ModelAndView("", PageData.getMap());
  }

  
  @ExceptionHandler(Exception.class)
  @ResponseBody
  public Result handleResultException(Exception e) {
    return Result.exception("500", "操作異常", e.getMessage());
  }

}      

說明：

　　1、注解@ControllerAdvice表示這是一個控制器增強類，當控制器發生異常就會被此攔截器被攔截。

　　2、注解@ExceptionHandler 定義攔截的異常類，可以擷取抛出的異常資訊。這裡可以定義多個攔截方法，攔截不同的異常類，并且可以擷取抛出的異常資訊，自由度更大。

2、使用ErrorController類來實作

@Controller
public class UserErrorController implements ErrorController {
    @Autowired
    private ErrorAttributes errorAttributes;

    @RequestMapping("/error")
    public String handleError(HttpServletRequest request){
        //錯誤詳情
        ServletWebRequest servletWebRequest = new ServletWebRequest(request);
        Map<String, Object> errorAttributes = this.errorAttributes.getErrorAttributes(servletWebRequest, true);
        //根據狀态碼傳回到對應頁面
        Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
        if(statusCode == 400){
            return "/400";
        }else if(statusCode == 403){
            return "/403";
        }else if(statusCode == 404){
            return "/404";
        }else{
            return "/500";
        }
    }
    @Override
    public String getErrorPath() {
        return "/error";
    }
}