SpringBoot自定义错误信息，SpringBoot适配Ajax请求

SpringBoot自定义错误信息，SpringBoot自定义异常处理类，

SpringBoot异常结果处理适配页面及Ajax请求，

SpringBoot适配Ajax请求

================================

©Copyright 蕃薯耀 2018年3月29日

http://www.cnblogs.com/fanshuyao/

附件&源码下载见：http://fanshuyao.iteye.com/blog/2414865

一、自定义异常处理类：

1. import java.util.HashMap;
2. import java.util.Map;
3. import javax.servlet.http.HttpServletRequest;
4. import org.springframework.web.bind.annotation.ControllerAdvice;
5. import org.springframework.web.bind.annotation.ExceptionHandler;
6. import com.lqy.springboot.component.CustomErrorAttribute;
7. @ControllerAdvice
8. public class CustomExceptionHandler {
9. /**
10. * 自定义异常数据
11. * 缺点，没有适配页面和Ajax请求，返回的数据都是json数据
12. * @param req
13. * @return
14. */
15. /*@ResponseBody
16. @ExceptionHandler(Exception.class)
17. public Map<String, Object> exceptionHandler(HttpServletRequest req){
18. Map<String, Object> map = new HashMap<String, Object>();
19. map.put("errorCode", 500);
20. map.put("errorMsg", "错误信息");
21. map.put("errorSystem", "errorSystem");
22. return map;
23. }*/
24. /**
25. * 自定义异常数据
26. * 适配页面和Ajax请求
27. * 注解ExceptionHandler(Exception.class)的Exception.class可以替换成自己定义的错误异常类
28. * @param req
29. * @return
30. */
31. @ExceptionHandler(Exception.class)
32. public String exceptionHandler(HttpServletRequest req){
33. Map<String, Object> map = new HashMap<String, Object>();
34. map.put("errorCode", 500);
35. map.put("errorMsg", "错误信息");
36. map.put("errorSystem", "errorSystem");
37. req.setAttribute(CustomErrorAttribute.CUSTOM_ERROR_MAP_NAME, map);
38. //传入自己的错误代码，必须的，否则不会进入自定义错误页面，见：org.springframework.boot.autoconfigure.web.AbstractErrorController
39. req.setAttribute("javax.servlet.error.status_code", 500);
40. //转发到springBoot错误处理请求，能适配网页和Ajax的错误处理
41. //请求/error后，会进入BasicErrorController(@RequestMapping("${server.error.path:${error.path:/error}}"))
42. //页面的数据显示处理是使用：errorAttributes.getErrorAttributes获取显示的，是AbstractErrorController的方法
43. //当需要把自己定义的Map错误信息传递到错误提示页面时，
44. //可以编写一个自定义错误属性类处理：CustomErrorAttribute，继承DefaultErrorAttributes类，
45. //重写getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace)方法
46. return "forward:/error";
47. }
48. }

异常捕捉后请求转发到

1. return "forward:/error";

是为了让SpringBoot底层处理，协助系统适配页面返回结果和Ajax返回结果：当是页面打开时，会跳转到相应的错误页面显示异常信息，当是Ajax请求或者使用工具请求时，返回的json字符串。（下面有图）

SpringBoot适配页面返回结果和Ajax返回结果的代码如下：

1. @RequestMapping(produces = "text/html")
2. public ModelAndView errorHtml(HttpServletRequest request,
3. HttpServletResponse response) {
4. HttpStatus status = getStatus(request);
5. Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
6. request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
7. response.setStatus(status.value());
8. ModelAndView modelAndView = resolveErrorView(request, response, status, model);
9. return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
10. }
11. @RequestMapping
12. @ResponseBody
13. public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
14. Map<String, Object> body = getErrorAttributes(request,
15. isIncludeStackTrace(request, MediaType.ALL));
16. HttpStatus status = getStatus(request);
17. return new ResponseEntity<Map<String, Object>>(body, status);
18. }

二、自定义异常信息传递类

1. import java.util.Map;
2. import org.springframework.boot.autoconfigure.web.DefaultErrorAttributes;
3. import org.springframework.stereotype.Component;
4. import org.springframework.web.context.request.RequestAttributes;
5. @Component
6. public class CustomErrorAttribute extends DefaultErrorAttributes {
7. public static final String CUSTOM_ERROR_MAP_NAME = "customErrorMap";
8. @Override
9. public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
10. Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
11. //设置传递自己定义的错误信息
12. map.put(CUSTOM_ERROR_MAP_NAME, requestAttributes.getAttribute(CUSTOM_ERROR_MAP_NAME, RequestAttributes.SCOPE_REQUEST));
13. return map;
14. }
15. }

定义这个类，是为了传递自己想要显示的错误信息，例如在Controller发生错误时，想把某些特殊信息传到错误页面，就可以自定义一个异常信息处理类，传递自己的自定义错误信息，同时也兼容SpringBoot本身定义好的错误 信息。

三、页面显示异常信息

1. <!DOCTYPE html>
2. <html xmlns:th="http://www.thymeleaf.org">
3. <head>
4. <meta charset="UTF-8">
5. <title>500</title>
6. </head>
7. <body>
8. <div>500错误</div>
9. <div>path：[[${path}]]</div>
10. <div>status：[[${status}]]</div>
11. <div>timestamp：[[${#dates.format(timestamp, 'yyyy-MM-dd HH:mm:ss')}]]</div>
12. <div>error：[[${error}]]</div>
13. <div>exception：[[${exception}]]</div>
14. <div>message：[[${message}]]</div>
15. <div>errors：[[${errors}]]</div>
16. <!-- 自定义属性 -->
17. <div>customErrorMap.errorMsg：[[${customErrorMap.errorMsg}]]</div>
18. <div>customErrorMap.errorSystem：[[${customErrorMap.errorSystem}]]</div>
19. <div>customErrorMap.errorCode：[[${customErrorMap.errorCode}]]</div>
20. </body>
21. </html>

页面显示结果：

Post请求结果：

项目源码见附件：SpringBoot-自定义错误.zip

======SpringBoot自定义错误页面见：======

SpringBoot自定义错误页面，SpringBoot 404、500错误提示页面

SpringBoot 4xx.html、5xx.html错误提示页面

http://www.cnblogs.com/fanshuyao/p/8668072.html

================================

©Copyright 蕃薯耀 2018年3月29日

http://www.cnblogs.com/fanshuyao/