SpringBoot 是為了簡化 Spring 應用的建立、運作、調試、部署等一系列問題而誕生的産物,自動裝配的特性讓我們可以更好的關注業務本身而不是外部的XML配置,我們隻需遵循規範,引入相關的依賴就可以輕易的搭建出一個 WEB 工程
實際項目開發中,程式往往會發生各式各樣的異常情況,特别是身為服務端開發人員的我們,總是不停的編寫接口提供給前端調用,分工協作的情況下,避免不了異常的發生,如果直接将錯誤的資訊直接暴露給使用者,這樣的體驗可想而知,且對黑客而言,詳細異常資訊往往會提供非常大的幫助…
采用try-catch的方式,手動捕獲異常資訊,然後傳回對應的結果集,相信很多人都看到過類似的代碼(如:封裝成Result對象);該方法雖然間接性的解決錯誤暴露的問題,同樣的弊端也很明顯,增加了大量的代碼量,當異常過多的情況下對應的catch層愈發的多了起來,很難管理這些業務異常和錯誤碼之間的比對,是以最好的方法就是通過簡單配置全局掌控….
接下來就看看 Spring Boot 提供的解決方案
1 導入依賴
在 pom.xml 中添加上 spring-boot-starter-web 的依賴即可
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
自定義異常
在應用開發過程中,除系統自身的異常外,不同業務場景中用到的異常也不一樣,為了與标題 輕松搞定全局異常 更加的貼切,定義個自己的異常,看看如何捕獲…
package com.battcn.exception;
/**
* 自定義異常
*
* @author Levin
* @since
public class CustomException extends RuntimeException
private static final long serialVersionUID = 4564124491192825748L;
private int code;
public CustomException() {
super();
}
public CustomException(int code, String message) {
super(message);
this.setCode(code);
}
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
}
2 異常資訊模闆
定義傳回的異常資訊的格式,這樣異常資訊風格更為統一
package com.battcn.exception;
/**
* @author Levin
* @since
public class ErrorResponseEntity
private int code;
private String message;
// 省略 get set
3 控制層
仔細一看是不是和平時正常寫的代碼沒啥差別,不要急,接着看….
package com.battcn.controller;
import com.battcn.exception.CustomException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.Map;
/**
* 全局異常示範
*
* @author Levin
* @since
@RestController
public class ExceptionController
@GetMapping("/test3")
public String test3(Integer num) {
// TODO 示範需要,實際上參數是否為空通過 @RequestParam(required = true) 就可以控制
if (num == null) {
throw new CustomException(400, "num不能為空");
}
int i = 10 / num;
return "result:"
4 異常處理(關鍵)
注解概述:
- @ControllerAdvice捕獲 Controller 層抛出的異常,如果添加 @ResponseBody 傳回資訊則為JSON 格式。
- @RestControllerAdvice相當于 @ControllerAdvice 與 @ResponseBody 的結合體。
- @ExceptionHandler統一處理一種類的異常,減少代碼重複率,降低複雜度。
建立一個 GlobalExceptionHandler 類,并添加上 @RestControllerAdvice 注解就可以定義出異常通知類了,然後在定義的方法中添加上 @ExceptionHandler 即可實作異常的捕捉…
package com.battcn.config;
import com.battcn.exception.CustomException;
import com.battcn.exception.ErrorResponseEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* 全局異常處理
*
* @author Levin
* @since
@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler
/**
* 定義要捕獲的異常 可以多個 @ExceptionHandler({})
*
* @param request request
* @param e exception
* @param response response
* @return
@ExceptionHandler(CustomException.class)
public ErrorResponseEntity customExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
response.setStatus(HttpStatus.BAD_REQUEST.value());
CustomException exception = (CustomException) e;
return new ErrorResponseEntity(exception.getCode(), exception.getMessage());
}
/**
* 捕獲 RuntimeException 異常
* TODO 如果你覺得在一個 exceptionHandler 通過 if (e instanceof xxxException) 太麻煩
* TODO 那麼你還可以自己寫多個不同的 exceptionHandler 處理不同異常
*
* @param request request
* @param e exception
* @param response response
* @return
@ExceptionHandler(RuntimeException.class)
public ErrorResponseEntity runtimeExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
response.setStatus(HttpStatus.BAD_REQUEST.value());
RuntimeException exception = (RuntimeException) e;
return new ErrorResponseEntity(400, exception.getMessage());
}
/**
* 通用的接口映射異常處理方
*/
@Override
protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body, HttpHeaders headers,
HttpStatus status, WebRequest request) {
if (ex instanceof MethodArgumentNotValidException) {
MethodArgumentNotValidException exception = (MethodArgumentNotValidException) ex;
return new ResponseEntity<>(new ErrorResponseEntity(status.value(), exception.getBindingResult().getAllErrors().get(0).getDefaultMessage()), status);
}
if (ex instanceof MethodArgumentTypeMismatchException) {
MethodArgumentTypeMismatchException exception = (MethodArgumentTypeMismatchException) ex;
logger.error("參數轉換失敗,方法:" + exception.getParameter().getMethod().getName() + ",參數:" + exception.getName()
+ ",資訊:" + exception.getLocalizedMessage());
return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "參數轉換失敗"), status);
}
return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "參數轉換失敗"), status);
}
}
測試
完成準備事項後,啟動Chapter17Application,通過下面的測試結果可以發現,真的是 so easy,代碼變得整潔了,擴充性也變好了…
通路 http://localhost:8080/test3
{"code":400,"message":"num不能為空"}
{"code":400,"message":"/ by zero"}
result:2