spring boot 1.5.4 exception control

spring boot has implemented unified exception handling. Let’s take a look at how to customize exception handling

1. Error code page mapping

1.1 Static page

Must be configured in the resources/static/error folder and named after the error code

The following is the content of the 404 error page. When accessing When a link does not exist, locate this page

nbsp;html><meta><title>Not Found</title><h1 id="Sorry-Not-Found">Sorry, Not Found</h1><p>status code is 404</p>

Display effect

1.2 Dynamic Template page (the page storage location cannot be changed, and there are only two names: 4xx and 5xx)

Example (5xx.ftl)

nbsp;html><meta><title>Error</title><h1 id="server-error">server error</h1><p></p><div>error code: ${status}-${error}</div><div>error msg: ${exception!},${message!}</div><div><div>${trace!}</div></div>

Deliberately access a request that throws an exception (/test2/throwex)

@Controller
@RequestMapping("/test2")public class Test2 {

    @RequestMapping("")public String index(){return "test";
    }

    @RequestMapping("/throwex")
    @ResponseBodypublic String throwex(){int a = 3;int b=0;return String.valueOf(a/b);
    }
}

Page effect

If you use ajax to access this error request, the error message represented by json will be returned

Demo page (/test2 -> test.ftl)

nbsp;html><meta><title>test</title><script></script><h1 id="test-page">test page</h1><div>
<button>请求异常测试</button><div></div>
<textarea></textarea>
</div><script>var doAjax = function () {
        $.ajax({
            url:&#39;/test2/throwex&#39;,
            async:true,
            type:&#39;GET&#39;,
            data:{},
            dataType:&#39;json&#39;,
            success:function (data) {
                $(&#39;#msg&#39;).text(data);
            },
            error: function(xhr, textStatus, errorThrown) {//                alert(XMLHttpRequest.status);//                alert(XMLHttpRequest.readyState);//                alert(textStatus);                $(&#39;#errorMsg&#39;).text(xhr.responseText);
            }
        }); 
    };</script>

Visit the test page, click the button, and check the effect as follows:

Here, use the web browser and ajax to access the error interface to get different results, one output Error page, an output error Json, which is determined by the reception type of the request.

Accept:text/html -> Return the error page

Accept:application/json, text/javascript -> Return the error json

The specific implementation can be View the BasicErrorController class

2. Customize the mapping of error codes to pages

2.1 Static page mapping configuration (control the error code mapping relationship when customizing the embedded container )

@Componentpublic class CustomizationBean implements EmbeddedServletContainerCustomizer{/** * 定制方法一：实现EmbeddedServletContainerCustomizer
     * @param container     */@Overridepublic void customize(ConfigurableEmbeddedServletContainer container) {//container.setPort(9000);    }/** * 定制方法二：注入EmbeddedServletContainerFactory
     * @return */@Beanpublic EmbeddedServletContainerFactory servletContainer() {
        TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory();
        factory.setPort(9001);
        factory.setSessionTimeout(10, TimeUnit.MINUTES);//优先级高于配置在/static/error文件夹里面的404.html页面factory.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/error/403.html"));return factory;
    }
}

2.2 Dynamic page mapping configuration

@Componentpublic class MyErrorViewResolver  implements ErrorViewResolver {

    @Overridepublic ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<string> model) {  return new ModelAndView("/error/error",model);}

}</string>

This custom ViewResolver will replace the default page processor DefaultErrorViewResolver. The above configuration maps all errors (regardless of error codes) to the error page error.ftl for unified management.

New error.ftl page rendering error content

Similar configuration to 5xx.ftl

3. Some abnormal configurations

#BasicErrorController的请求路径(你可以遇到错误后跳转的路径，该路径是一个BasicErrorController的请求路径，映射到它errorHtml或者error方法，由请求接受类型决定，一个返回错误页面，一个返回错误json)

#server.error.path=/error

#always include stacktrace（是否包含异常的堆栈信息，默认NEVER，页面无法获取到${trace!}的值，可取值NEVER,ALWAYS,ON_TRACE_PARAM; on_trace_param意思是请求带上参数 ?trace=true）

<em>server.error.include-stacktrace=always<br><br><br></em>

4.springboot exception handling process

controller->Error jump->BasicErrorController->Call errorHtml method->getErrorAttributes (get error attributes and return model)->Throw to the page Processor ErrorViewResolver

So you can customize controller/customize##ErrorAttributes/customizeErrorViewResolver etc., implement More complex exception handling

The above is the detailed content of spring boot 1.5.4 exception control. For more information, please follow other related articles on the PHP Chinese website!