SpringBoot全局異常處理與定制404頁面的方法
一、錯(cuò)誤處理原理分析
使用SpringBoot創(chuàng)建的web項(xiàng)目中,當(dāng)我們請求的頁面不存在(http狀態(tài)碼為404),或者器發(fā)生異常(http狀態(tài)碼一般為500)時(shí),SpringBoot就會(huì)給我們返回錯(cuò)誤信息。
也就是說,在SpringBoot的web項(xiàng)目中,會(huì)自動(dòng)創(chuàng)建一個(gè)/error的錯(cuò)誤接口,來返回錯(cuò)誤信息。但是針對不同的訪問方式,會(huì)有以下兩種不同的返回信息。這主要取決于你訪問時(shí)的http頭部信息的Accept
這個(gè)值來指定你可以接收的類型有哪些
使用瀏覽器訪問時(shí)的頭信息及其返回結(jié)果
Accept: text/html
使用其他設(shè)備,如手機(jī)客戶端等訪問時(shí)頭部信息及其返回結(jié)果(一般是在前后端分離的架構(gòu)中)
Accept: */*
二、進(jìn)行錯(cuò)誤處理
處理異常主要有兩種方式:
1. 使用SpringBoot的自動(dòng)配置原理進(jìn)行異常處理
SpringBoot自動(dòng)配置了一個(gè)類ErrorMvcAutoConfiguration
來處理處理異常,有興趣的可以去看一下,然后在這個(gè)類中定義一個(gè)錯(cuò)誤的BasicErrorController類,主要代碼有如下:
@Controller @RequestMapping({"${server.error.path:${error.path:/error}}"}) public class BasicErrorController extends AbstractErrorController { /** * 錯(cuò)誤的頁面響應(yīng) */ @RequestMapping(produces = {"text/html"}) public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) { HttpStatus status = this.getStatus(request); Map<String, Object> model = Collections.unmodifiableMap(this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.TEXT_HTML))); response.setStatus(status.value()); // 得到一個(gè)modelAndView對象 ModelAndView modelAndView = this.resolveErrorView(request, response, status, model); return modelAndView != null ? modelAndView : new ModelAndView("error", model); } /** * 錯(cuò)誤的json響應(yīng) */ @RequestMapping public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) { HttpStatus status = this.getStatus(request); if (status == HttpStatus.NO_CONTENT) { return new ResponseEntity(status); } else { Map<String, Object> body = this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.ALL)); return new ResponseEntity(body, status); } }
多的代碼就不深究了,感興趣的可以去看一下。上邊的代碼也就是說,針對不同的請求方式,會(huì)返回不同的結(jié)果,其關(guān)鍵在于 @RequestMapping
注解的produces = {"text/html"}
屬性上
1)、返回一個(gè)錯(cuò)誤頁面,如404、500等。
有模板引擎的情況(可以用于渲染頁面)
項(xiàng)目中使用的了模板引擎,如:thymeleaf 、freemarker等做為頁面的渲染時(shí)。在templates創(chuàng)建/error文件夾并添加錯(cuò)誤的狀態(tài)碼對應(yīng)的.html文件,如下圖:
這里的404和500就是確定的錯(cuò)誤狀態(tài)碼,而4xx表示其他的4開頭的錯(cuò)誤,如400,401等。當(dāng)然可以為每一個(gè)狀態(tài)碼都設(shè)置對應(yīng)的錯(cuò)誤頁面,但是這樣做,并沒有什么好處,所以就直接使用4xx.html這樣的泛指代替了。
可以在我們錯(cuò)誤頁面中獲取到如下信息(就是ModelAndView對象中的內(nèi)容):
字段名 | 說明 |
---|---|
timstamp | 時(shí)間戳 |
status | 錯(cuò)誤狀態(tài)碼 |
error | 錯(cuò)誤提示 |
exception | 異常對象 |
message | 異常消息 |
path | 頁面路徑 |
細(xì)心的小伙伴會(huì)發(fā)現(xiàn),這個(gè)其實(shí)就是當(dāng)你用手機(jī)請求時(shí)返回的json內(nèi)容
比如:在代碼中加入上邊信息,然后在在后端寫一個(gè)錯(cuò)誤代碼:
@RequestMapping("haserror") @ResponseBody public Object myError(){ int i =10/0; return "something is error"; } 這是一個(gè)錯(cuò)誤頁面: <ul> <li>錯(cuò)誤狀態(tài)碼:[[${status}]]</li> <li>錯(cuò)誤消息:[[${error}]]</li> <li>異常對象:[[${exception}]]</li> <li>異常消息:[[${message}]]</li> <li>當(dāng)前時(shí)間:[[${timestamp}]]</li> </ul>
沒有模板引擎的情況
當(dāng)項(xiàng)目中沒有使用模板引擎的時(shí)候,就將整個(gè)error文件夾移到static文件夾下就可以了。
不過此時(shí)并不能獲取上邊的那些信息了,因?yàn)檫@本就是靜態(tài)資源,沒有模板引擎進(jìn)行渲染
2)、返回對應(yīng)的json串
這個(gè)并沒有什么好說的,返回的就是一個(gè)json字符串。格式如下:
{ "timestamp": "2020-04-22T16:13:37.506+0000", "status": 500, "error": "Internal Server Error", "message": "/ by zero", "path": "/hello/haserror", "reason": "完了,你寫的代碼又產(chǎn)生了一次線上事故" }
3)、自定義頁面返回信息
這才是最重要的內(nèi)容,因?yàn)檫@個(gè)信息不僅是做為json返回的,也是可以在上邊的錯(cuò)誤頁面中拿到,也可以直接返回一個(gè)json。其實(shí)也很簡單,就是在Spring容器中添加一個(gè)ErrorAttributes
對象就可以了,這里我選擇繼承它的一個(gè)子類。
@Component public class MyErrorAttributes extends DefaultErrorAttributes { @Override public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) { //調(diào)用父類的方法,會(huì)自動(dòng)獲取內(nèi)置的那些屬性,如果你不想要,可以不調(diào)用這個(gè) Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace); //添加自定義的屬性 errorAttributes.put("reason","完了,你寫的代碼又產(chǎn)生了一次線上事故"); // 你可以看一下這個(gè)方法的參數(shù)webRequest這個(gè)對象,我相信你肯定能發(fā)現(xiàn)好東西 return errorAttributes; } }
這就可以了,用兩種請求方式分別測試一個(gè)我們的這個(gè)自定義屬性是否可用:
2. 使用AOP的異常通知進(jìn)行處理(推薦)
它的原理就是獲取一個(gè)全局的異常通知,然后進(jìn)行處理。我們只需要在項(xiàng)目中寫下邊代碼就可以了(其實(shí)上邊也只是寫了一個(gè)自定義異常信息的類)
@ControllerAdvice public class ErrroAcvice { /** * 全局捕獲異常的切面類 * @param request 請求對象,可不傳 * @param response 響應(yīng)對象,可不傳 * @param e 異常類(這個(gè)要和你當(dāng)前捕獲的異常類是同一個(gè)) */ @ExceptionHandler(Exception.class) //也可以只對一個(gè)類進(jìn)行捕獲 public void errorHandler(HttpServletRequest request, HttpServletResponse response,Exception e){ /* * You can do everything you want to do * 這里你拿到了request和response對象,你可以做任何你想做的事 * 比如: * 1.用request從頭信息中拿到Accept來判斷是請求方可接收的類型從而進(jìn)行第一個(gè)方法的判斷 * 2.如果你也想返回一個(gè)頁面,使用response對象進(jìn)行重定向到自己的錯(cuò)誤頁面就可以了 * 3.你甚至還拿到了異常對象 */ String accept = request.getHeader("Accept"); // 根據(jù)這個(gè)字符串來判斷做出什么響應(yīng) try { response.setStatus(500); response.getWriter().write("hello"); } catch (IOException ex) { ex.printStackTrace(); } } }
3. 兩種方法對比:第一種方法,就是在當(dāng)前項(xiàng)目中放置一些錯(cuò)誤狀態(tài)碼的頁面讓SpringBoot去查找。也支持自定義返回的錯(cuò)誤信息第二種方法,就是直接使用AOP的思想,進(jìn)行異常通知處理,自由性很大。我個(gè)人建議使用第二種方法,因?yàn)樽杂啥群芨?,可以根?jù)自己的業(yè)務(wù)邏輯進(jìn)行隨時(shí)改變,而且還有一個(gè)很大的用處。下一篇文章會(huì)有個(gè)很好的例子使用了第二種方式后,通過第一種方式放置的錯(cuò)誤頁面和自定義錯(cuò)誤信息全部失效
到此這篇關(guān)于SpringBoot全局異常處理與定制404頁面的方法的文章就介紹到這了,更多相關(guān)spring boot 全局異常處理內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
IDEA提示內(nèi)存不足low memory的錯(cuò)誤解決
運(yùn)行項(xiàng)目變得很卡,這種情況比較能直觀感受出來,Idea內(nèi)存指示器,則需要設(shè)置才能看到,本文主要介紹了IDEA提示內(nèi)存不足low memory的錯(cuò)誤解決,具有一定的參考價(jià)值,感興趣的可以了解一下2024-03-03Java 數(shù)據(jù)庫連接池詳解及簡單實(shí)例
這篇文章主要介紹了Java 數(shù)據(jù)庫連接池詳解及簡單實(shí)例的相關(guān)資料,需要的朋友可以參考下2016-12-12