這篇文章主要介紹“SpringBoot全局異常問題如何解決”的相關(guān)知識,小編通過實際案例向大家展示操作過程,操作方法簡單快捷,實用性強,希望這篇“SpringBoot全局異常問題如何解決”文章能幫助大家解決問題。
成都創(chuàng)新互聯(lián)云計算的互聯(lián)網(wǎng)服務(wù)提供商,擁有超過13年的服務(wù)器租用、德陽機房托管、云服務(wù)器、虛擬空間、網(wǎng)站系統(tǒng)開發(fā)經(jīng)驗,已先后獲得國家工業(yè)和信息化部頒發(fā)的互聯(lián)網(wǎng)數(shù)據(jù)中心業(yè)務(wù)許可證。專業(yè)提供云主機、虛擬空間、域名申請、VPS主機、云服務(wù)器、香港云服務(wù)器、免備案服務(wù)器等。
SpringBoot 是為了簡化 Spring 應用的創(chuàng)建、運行、調(diào)試、部署等一系列問題而誕生的產(chǎn)物,自動裝配的特性讓我們可以更好的關(guān)注業(yè)務(wù)本身而不是外部的XML配置,我們只需遵循規(guī)范,引入相關(guān)的依賴就可以輕易的搭建出一個 WEB 工程
實際項目開發(fā)中,程序往往會發(fā)生各式各樣的異常情況,特別是身為服務(wù)端開發(fā)人員的我們,總是不停的編寫接口提供給前端調(diào)用,分工協(xié)作的情況下,避免不了異常的發(fā)生,如果直接將錯誤的信息直接暴露給用戶,這樣的體驗可想而知,且對黑客而言,詳細異常信息往往會提供非常大的幫助…
采用try-catch的方式,手動捕獲異常信息,然后返回對應的結(jié)果集,相信很多人都看到過類似的代碼(如:封裝成Result對象);該方法雖然間接性的解決錯誤暴露的問題,同樣的弊端也很明顯,增加了大量的代碼量,當異常過多的情況下對應的catch層愈發(fā)的多了起來,很難管理這些業(yè)務(wù)異常和錯誤碼之間的匹配,所以最好的方法就是通過簡單配置全局掌控….
接下來就看看 Spring Boot 提供的解決方案
在 pom.xml 中添加上 spring-boot-starter-web 的依賴即可
org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test
自定義異常
在應用開發(fā)過程中,除系統(tǒng)自身的異常外,不同業(yè)務(wù)場景中用到的異常也不一樣,為了與標題 輕松搞定全局異常 更加的貼切,定義個自己的異常,看看如何捕獲…
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; } }
定義返回的異常信息的格式,這樣異常信息風格更為統(tǒng)一
package com.battcn.exception; /** * @author Levin * @since public class ErrorResponseEntity private int code; private String message; // 省略 get set
仔細一看是不是和平時正常寫的代碼沒啥區(qū)別,不要急,接著看….
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 演示需要,實際上參數(shù)是否為空通過 @RequestParam(required = true) 就可以控制 if (num == null) { throw new CustomException(400, "num不能為空"); } int i = 10 / num; return "result:"
注解概述:
@ControllerAdvice捕獲 Controller 層拋出的異常,如果添加 @ResponseBody 返回信息則為JSON 格式。
@RestControllerAdvice相當于 @ControllerAdvice 與 @ResponseBody 的結(jié)合體。
@ExceptionHandler統(tǒng)一處理一種類的異常,減少代碼重復率,降低復雜度。
創(chuàng)建一個 GlobalExceptionHandler 類,并添加上 @RestControllerAdvice 注解就可以定義出異常通知類了,然后在定義的方法中添加上 @ExceptionHandler 即可實現(xiàn)異常的捕捉…
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
完成準備事項后,啟動Chapter17Application,通過下面的測試結(jié)果可以發(fā)現(xiàn),真的是 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
關(guān)于“SpringBoot全局異常問題如何解決”的內(nèi)容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識,可以關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道,小編每天都會為大家更新不同的知識點。