摘要：對(duì)應(yīng)的請(qǐng)求信息如下如果是其他客戶端請(qǐng)求，如測(cè)試，會(huì)默認(rèn)返回?cái)?shù)據(jù)在之前的文章中介紹過了的自動(dòng)配置機(jī)制，默認(rèn)錯(cuò)誤處理機(jī)制也是自動(dòng)配置其中的一部分。在這個(gè)包中加載了所有的自動(dòng)配置類，其中就是處理異常的機(jī)制。

??在我們開發(fā)的過程中經(jīng)常會(huì)看到下圖這個(gè)界面，這是SpringBoot默認(rèn)出現(xiàn)異常之后給用戶拋出的異常處理界面。

??對(duì)應(yīng)的請(qǐng)求信息如下：

??如果是其他客戶端請(qǐng)求，如postman測(cè)試，會(huì)默認(rèn)返回json數(shù)據(jù)

{
        "timestamp":"2019-08-06 22:26:16",
        "status":404,
        "error":"Not Found",
        "message":"No message available",
        "path":"/asdad"
}

??在之前的文章中介紹過了SpringBoot的自動(dòng)配置機(jī)制，默認(rèn)錯(cuò)誤處理機(jī)制也是自動(dòng)配置其中的一部分。在spring-boot-autoconfiguration-XXX.jar這個(gè)包中加載了所有的自動(dòng)配置類，其中ErrorMvcAutoConfiguration就是SpringBoot處理異常的機(jī)制。

??下面簡(jiǎn)單的分析一下它的機(jī)制

??首先看一下ErrorMvcAutoConfiguration這個(gè)類里面主要起作用的幾個(gè)方法

/**
 * 綁定一些錯(cuò)誤信息
 */
@Bean
@ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT)
public DefaultErrorAttributes errorAttributes() {
    return new DefaultErrorAttributes(this.serverProperties.getError().isIncludeException());
}
/**
 * 默認(rèn)錯(cuò)誤處理
 */
@Bean
@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) {
    return new BasicErrorController(errorAttributes, this.serverProperties.getError(), this.errorViewResolvers);
}
/**
 * 錯(cuò)誤處理頁(yè)面
 */
@Bean
public ErrorPageCustomizer errorPageCustomizer() {
    return new ErrorPageCustomizer(this.serverProperties, this.dispatcherServletPath);
}

@Configuration
static class DefaultErrorViewResolverConfiguration {

    private final ApplicationContext applicationContext;

    private final ResourceProperties resourceProperties;

    DefaultErrorViewResolverConfiguration(ApplicationContext applicationContext,
            ResourceProperties resourceProperties) {
        this.applicationContext = applicationContext;
        this.resourceProperties = resourceProperties;
    }
    /**
     * 決定去哪個(gè)錯(cuò)誤頁(yè)面
     */
    @Bean
    @ConditionalOnBean(DispatcherServlet.class)
    @ConditionalOnMissingBean
    public DefaultErrorViewResolver conventionErrorViewResolver() {
        return new DefaultErrorViewResolver(this.applicationContext, this.resourceProperties);
    }

}

??主要起作用的是下面這個(gè)類

org.springframework.boot.web.servlet.error.DefaultErrorAttributes

??這個(gè)類會(huì)共享很多錯(cuò)誤信息，如：

errorAttributes.put("timestamp", new Date());
errorAttributes.put("status", status);
errorAttributes.put("error", HttpStatus.valueOf(status).getReasonPhrase());
errorAttributes.put("errors", result.getAllErrors());
errorAttributes.put("exception", error.getClass().getName());
errorAttributes.put("message", error.getMessage());
errorAttributes.put("trace", stackTrace.toString());
errorAttributes.put("path", path);

??這些信息作為共享信息返回，所以當(dāng)我們使用模板引擎時(shí)，也可以像取出其他參數(shù)一樣取出。

//org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController

@Controller
//定義請(qǐng)求路徑，如果沒有error.path路徑，則路徑為/error
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {

    //如果支持的格式 text/html
    @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
    public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
        HttpStatus status = getStatus(request);
        //獲取要返回的值
        Map model = Collections
                .unmodifiableMap(getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
        response.setStatus(status.value());
        //解析錯(cuò)誤視圖信息，也就是下面1.4中的邏輯
        ModelAndView modelAndView = resolveErrorView(request, response, status, model);
        //返回視圖，如果沒有存在的頁(yè)面模板，則使用默認(rèn)錯(cuò)誤視圖模板
        return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
    }

    @RequestMapping
    public ResponseEntity> error(HttpServletRequest request) {
        //如果是接收所有格式的HTTP請(qǐng)求
        Map body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
        HttpStatus status = getStatus(request);
        //響應(yīng)httpEntity
        return new ResponseEntity<>(body, status);
    }
}

??由上面的源碼可知，basicErrorControll主要用于創(chuàng)建請(qǐng)求返回的controller類，并根據(jù)http請(qǐng)求可接受的格式不同返回對(duì)應(yīng)的信息。也就是我們?cè)谖恼碌囊婚_始看到的情況，頁(yè)面請(qǐng)求和接口測(cè)試工具請(qǐng)求得到的結(jié)果略有差異。

??errorPageCustomizer這個(gè)方法調(diào)了同類里面的ErrorPageCustomizer 這個(gè)內(nèi)部類。當(dāng)遇到錯(cuò)誤時(shí)，如果沒有自定義error.path屬性，請(qǐng)求會(huì)轉(zhuǎn)發(fā)至/error

/**
 * {@link WebServerFactoryCustomizer} that configures the server"s error pages.
 */
private static class ErrorPageCustomizer implements ErrorPageRegistrar, Ordered {

    private final ServerProperties properties;

    private final DispatcherServletPath dispatcherServletPath;

    protected ErrorPageCustomizer(ServerProperties properties, DispatcherServletPath dispatcherServletPath) {
        this.properties = properties;
        this.dispatcherServletPath = dispatcherServletPath;
    }

    @Override
    public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
        //getPath()得到如下地址，如果沒有自定義error.path屬性，則去/error位置
        //@Value("${error.path:/error}")
        //private String path = "/error";
        ErrorPage errorPage = new ErrorPage(
                this.dispatcherServletPath.getRelativePath(this.properties.getError().getPath()));
        errorPageRegistry.addErrorPages(errorPage);
    }

    @Override
    public int getOrder() {
        return 0;
    }

}

??下面的代碼只展示部分核心方法

// org.springframework.boot.autoconfigure.web.servlet.error.DefaultErrorViewResolver

public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {

    static {
        Map views = new EnumMap<>(Series.class);
        views.put(Series.CLIENT_ERROR, "4xx");
        views.put(Series.SERVER_ERROR, "5xx");
        SERIES_VIEWS = Collections.unmodifiableMap(views);
    }

    @Override
    public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map model) {
        //使用HTTP完整狀態(tài)碼檢查是否有頁(yè)面可以匹配
        ModelAndView modelAndView = resolve(String.valueOf(status.value()), model);
        if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
            //使用HTTP狀態(tài)碼第一位匹配初始化中的參數(shù)創(chuàng)建視圖對(duì)象
            modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
        }
        return modelAndView;
    }

    private ModelAndView resolve(String viewName, Map model) {
        // 拼接錯(cuò)誤視圖路徑 /error/{viewName}
        String errorViewName = "error/" + viewName;
        // 使用模板引擎嘗試創(chuàng)建視圖對(duì)象
        TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName,
                this.applicationContext);
        if (provider != null) {
            return new ModelAndView(errorViewName, model);
        }
        //沒有模板引擎，使用靜態(tài)資源文件夾解析視圖
        return resolveResource(errorViewName, model);
    }

    private ModelAndView resolveResource(String viewName, Map model) {
        // 遍歷靜態(tài)資源文件夾，檢查是否有存在視圖
        for (String location : this.resourceProperties.getStaticLocations()) {
            try {
                Resource resource = this.applicationContext.getResource(location);
                resource = resource.createRelative(viewName + ".html");
                if (resource.exists()) {
                    return new ModelAndView(new HtmlResourceView(resource), model);
                }
            }
            catch (Exception ex) {
            }
        }
        return null;
    }
}

??Thymeleaf對(duì)于錯(cuò)誤頁(yè)面的解析如下：

public class ThymeleafTemplateAvailabilityProvider implements TemplateAvailabilityProvider {

    @Override
    public boolean isTemplateAvailable(String view, Environment environment, ClassLoader classLoader,
            ResourceLoader resourceLoader) {
        if (ClassUtils.isPresent("org.thymeleaf.spring5.SpringTemplateEngine", classLoader)) {
            String prefix = environment.getProperty("spring.thymeleaf.prefix", ThymeleafProperties.DEFAULT_PREFIX);
            String suffix = environment.getProperty("spring.thymeleaf.suffix", ThymeleafProperties.DEFAULT_SUFFIX);
            return resourceLoader.getResource(prefix + view + suffix).exists();
        }
        return false;
    }

}

??錯(cuò)誤頁(yè)面首先會(huì)檢查模板引擎文件夾下的/error/HTTP狀態(tài)碼文件，如果不存在，則去檢查模板引擎下的/error/4xx或者/error/5xx文件，如果還不存在，則檢查靜態(tài)資源文件夾下對(duì)應(yīng)的上述文件

??剛才分析了異常處理機(jī)制是如何工作的，下面我們來(lái)自己定義一個(gè)異常頁(yè)面。根據(jù)源碼分析可以看到，自定義錯(cuò)誤頁(yè)面只需要在模板文件夾下的error文件夾下放置4xx或者5xx文件即可。

    
    
    
    
    



    
錯(cuò)誤碼：[[${status}]]
    
信息：[[${message}]]
    
時(shí)間：[[${#dates.format(timestamp,"yyyy-MM-dd hh:mm:ss ")}]]
    
請(qǐng)求路徑：[[${path}]]

??隨意訪問不存在路徑得到下圖

??根據(jù)上面的錯(cuò)誤處理機(jī)制可以得知，最終返回的JSON信息是從一個(gè)map對(duì)象轉(zhuǎn)換出來(lái)的，只需要自定義map中的值，就可以自定義錯(cuò)誤信息的json了。直接重寫DefaultErrorAttributes類的 getErrorAttributes 方法即可。

/**
 * 自定義錯(cuò)誤信息JSON值
 */
@Component
public class ErrorAttributesCustom extends DefaultErrorAttributes {
    //重寫getErrorAttributes方法
    @Override
    public Map getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        //獲取原來(lái)的響應(yīng)數(shù)據(jù)
        Map map = super.getErrorAttributes(webRequest, includeStackTrace);
        String code = map.get("status").toString();
        String message = map.get("error").toString();
        HashMap hashMap = new HashMap<>();
        //添加我們定制的響應(yīng)數(shù)據(jù)
        hashMap.put("code", code);
        hashMap.put("message", message);
        return hashMap;
    }
}

??使用postman測(cè)試結(jié)果如下：