SpringBoot 是為了簡化Spring 應用的創建、運行、調試、部署等一系列問題而誕生的產物,自動裝配的特性讓我們可以更好的關注業務本身而不是外部的XML配置,我們只要遵循規範,引入相關的依賴就可以輕易的搭建出一個WEB 工程
實際專案開發中,程式往往會發生各式各樣的異常情況,特別是身為服務端開發人員的我們,總是不停的編寫接口提供給前端調用,分工協作的情況下,避免不了異常的發生,如果直接將錯誤的信息直接暴露給用戶,這樣的體驗可想而知,且對駭客而言,詳細異常信息往往會提供非常大的幫助…
採用try-catch的方式,手動捕獲異常信息,然後返回對應的結果集,相信很多人都看到過類似的代碼(如:封裝成Result物件);此方法雖然間接性的解決錯誤暴露的問題,同樣的弊端也很明顯,增加了大量的代碼量,當異常過多的情況下對應的catch層愈發的多了起來,很難管理這些業務異常和錯誤碼之間的匹配,所以最好的方法就是透過簡單配置全域掌控….
接下來就看看Spring Boot 提供的解決方案
在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; } }
定義回傳的異常訊息的格式,這樣異常訊息風格更為統一
package com.battcn.exception; /** * @author Levin * @since public class ErrorResponseEntity private int code; private String message; // 省略 get set
仔細一看是不是和平時正常寫的程式碼沒啥區別,不要著急,接著看….
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:"
註解概述:
##@ControllerAdvice捕捉Controller 層拋出的異常,如果新增@ResponseBody 回傳訊息則為JSON 格式。
@RestControllerAdvice相當於 @ControllerAdvice 與 @ResponseBody 的結合體。
@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不能为空"}訪問http://localhost:8080/test3?num=0
{"code":400,"message":"/ by zero"}訪問http://localhost:8080 /test3?num=5
result:2
以上是SpringBoot全域異常問題怎麼解決的詳細內容。更多資訊請關注PHP中文網其他相關文章!