springboot定製錯誤頁面

Spring_Boot專欄
上一篇	主目錄	下一篇

1 SpringBoot默認的錯誤處理機制

默認效果
1）瀏覽器，返回一個默認的錯誤頁面

瀏覽器發送請求的請求頭：

2）如果是其他客戶端，默認響應一個json數據

原理：

可以參照ErrorMvcAutoConfiguration；錯誤處理的自動配置；

給容器中添加了以下組件

1、DefaultErrorAttributes (@ConditionalOnMissingBean)：

幫我們在頁面共享信息；
@Override
	public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
			boolean includeStackTrace) {
		Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>();
		errorAttributes.put("timestamp", new Date());
		addStatus(errorAttributes, requestAttributes);
		addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
		addPath(errorAttributes, requestAttributes);
		return errorAttributes;
	}

2、BasicErrorController (@ConditionalOnMissingBean)：處理默認/error請求

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
    
    @RequestMapping(produces = "text/html")//產生html類型的數據；瀏覽器發送的請求來到這個方法處理
	public ModelAndView errorHtml(HttpServletRequest request,
			HttpServletResponse response) {
		HttpStatus status = getStatus(request);
		Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
				request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
		response.setStatus(status.value());
        
        //去哪個頁面作爲錯誤頁面；包含頁面地址和頁面內容
		ModelAndView modelAndView = resolveErrorView(request, response, status, model);
		return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
	}

	@RequestMapping
	@ResponseBody    //產生json數據，其他客戶端來到這個方法處理；
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
		Map<String, Object> body = getErrorAttributes(request,
				isIncludeStackTrace(request, MediaType.ALL));
		HttpStatus status = getStatus(request);
		return new ResponseEntity<Map<String, Object>>(body, status);
	}

3、ErrorPageCustomizer：

	@Value("${error.path:/error}")
	private String path = "/error";  系統出現錯誤以後來到error請求進行處理；（web.xml註冊的錯誤頁面規則）

4、DefaultErrorViewResolver (@ConditionalOnMissingBean)：

@Override
	public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
			Map<String, Object> model) {
		ModelAndView modelAndView = resolve(String.valueOf(status), model);
		if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
			modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
		}
		return modelAndView;
	}

	private ModelAndView resolve(String viewName, Map<String, Object> model) {
        //默認SpringBoot可以去找到一個頁面？  error/404
		String errorViewName = "error/" + viewName;
        
        //模板引擎可以解析這個頁面地址就用模板引擎解析
		TemplateAvailabilityProvider provider = this.templateAvailabilityProviders
				.getProvider(errorViewName, this.applicationContext);
		if (provider != null) {
            //模板引擎可用的情況下返回到errorViewName指定的視圖地址
			return new ModelAndView(errorViewName, model);
		}
        //模板引擎不可用，就在靜態資源文件夾下找errorViewName對應的頁面   error/404.html
		return resolveResource(errorViewName, model);
	}

步驟：

一但系統出現4xx或者5xx之類的錯誤；ErrorPageCustomizer就會生效（定製錯誤的響應規則）；就會來到/error請求；就會被BasicErrorController處理；

1）響應頁面；去哪個頁面是由DefaultErrorViewResolver解析得到的；

protected ModelAndView resolveErrorView(HttpServletRequest request,
      HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
    //所有的ErrorViewResolver得到ModelAndView
   for (ErrorViewResolver resolver : this.errorViewResolvers) {
      ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
      if (modelAndView != null) {
         return modelAndView;
      }
   }
   return null;
}

2 自定製錯誤響應

2.1 如何定製錯誤的頁面

1）有模板引擎的情況下：templates/error/狀態碼.html 【將錯誤頁面命名爲錯誤狀態碼.html 放在模板引擎文件夾裏面的 error文件夾下】，發生此狀態碼的錯誤就會來到對應的頁面
我們可以使用4xx和5xx作爲錯誤頁面的文件名來匹配這種類型的所有錯誤，精確優先（優先尋找精確的狀態碼.html： 404.html>4XX.html ）

頁面能獲取的信息：

timestamp：時間戳
status：狀態碼
error：錯誤提示
exception：異常對象
message：異常消息
errors：JSR303數據校驗的錯誤都在這裏

【注】什麼是有模板引擎？
Thymeleaf是一種模板引擎，在pom.xml文件中添加了Thymeleaf的依賴就是在項目中有了Thymeleaf的模板引擎

2）沒有模板引擎（模板引擎找不到這個錯誤頁面）：就在靜態資源文件夾下找

3）以上都沒有錯誤頁面，就是默認來到SpringBoot默認的錯誤提示頁面；

2.2 如何定製錯誤的json數據

1）自定義異常處理&返回定製json數據
自定義異常exception/UserNotExistException.class：

public class UserNotExistException extends RuntimeException{
    //Alt+Insert生成構造器
    public UserNotExistException() {
        super("用戶不存在！");
    }
}

模擬拋出異常controller/IndexController.class

@Controller
public class IndexController {

    //testUDE測試用戶自定義異常./user?user=xxx模擬拋出一個異常
    @ResponseBody
    @RequestMapping("/user")
    public String testUDE(@RequestParam("user") String user){
        if(user.equals("xxx")){
            throw new UserNotExistException();
        }
        return "testUDE";
    }
}

異常控制處理器controller/ExceptionController.class

@ControllerAdvice
public class ExceptionController {

    @ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    public Map<String,Object> handleException(Exception e){

        Map<String,Object> map = new HashMap<>();
        map.put("code","user_not_exist");
        map.put("message",e.getMessage());
        return map;
    }
}
//沒有自適應效果...

【注】什麼是自適應效果？
當用瀏覽器發送請求時返回錯誤頁面；當用客戶端發送請求時返回json數據

2）轉發到/error進行自適應響應效果處理

@ControllerAdvice
public class ExceptionController {

    //@ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e,
                                  HttpServletRequest request){

        //傳入我們自己的錯誤狀態碼  4xx 5xx，否則就不會進入定製錯誤頁面的解析流程
        /**
         * Integer statusCode = (Integer) request
         .getAttribute("javax.servlet.error.status_code");
         */
        request.setAttribute("javax.servlet.error.status_code",500);
        Map<String,Object> map = new HashMap<>();
        map.put("code","user_not_exist");
        map.put("message",e.getMessage());
        return "forward:/error";
    }
}

這樣雖然可以有自適應效果，但是我們自定義的數據code和message無法攜帶

2.3 將我們的定製數據攜帶出去

出現錯誤以後，會來到/error請求，會被BasicErrorController處理，響應出去可以獲取的數據是由getErrorAttributes得到的（是AbstractErrorController（ErrorController）規定的方法）

1、完全來編寫一個ErrorController的實現類【或者是編寫AbstractErrorController的子類】，放在容器中；
2、頁面上能用的數據，或者是json返回能用的數據都是通過errorAttributes.getErrorAttributes得到；

容器中DefaultErrorAttributes.getErrorAttributes()；默認進行數據處理的；

自定義ErrorAttributes：component/MyErrorAttributes.class

//給容器中加入我們自己定義的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
        errorAttributes.put("author","shaneholmes");
        return errorAttributes;
    }
}

【注】springboot 2.x版本以後不需要在從requestAttribute中拿出數據放入map中了：

但要想將自己的數據傳出去，需要放到request域中：request.setAttribute("ext",map);

@ControllerAdvice
public class ExceptionController {

    //@ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e,
                                  HttpServletRequest request){

        //傳入我們自己的錯誤狀態碼  4xx 5xx，否則就不會進入定製錯誤頁面的解析流程
        /**
         * Integer statusCode = (Integer) request
         .getAttribute("javax.servlet.error.status_code");
         */
        request.setAttribute("javax.servlet.error.status_code",500);
        Map<String,Object> map = new HashMap<>();
        map.put("code","user_not_exist");
        map.put("message",e.getMessage());
        //要想將自己的數據傳出去，需要放到request域中
        request.setAttribute("ext",map);
        return "forward:/error";
    }
}

最終的效果：響應是自適應的，可以通過定製ErrorAttributes改變需要返回的內容

springboot定製錯誤頁面

目錄

1 SpringBoot默認的錯誤處理機制

2 自定製錯誤響應

2.1 如何定製錯誤的頁面

2.2 如何定製錯誤的json數據

2.3 將我們的定製數據攜帶出去

springboot Service的路由

zookeeper專欄

軟件測試 1 -- 軟件缺陷&測試分類

HBase專欄

springboot設置dev、test環境

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結