SpringBoot對Spring MVC都做了哪些事？（三）
作者：Spring全家桶實戰案例
要完全替換默認行為，可以實現ErrorController并注冊該類型的bean定義，或者添加ErrorAttributes類型的bean以使用現有機制，但替換內容。
上一篇：《??SpringBoot對Spring MVC都做了哪些事？（二）??》
錯誤處理
默認情況下，Spring Boot提供了一個/error映射，以合理的方式處理所有錯誤，并在servlet容器中注冊為“全局”錯誤頁。對于機器客戶端，它生成一個JSON響應，其中包含錯誤、HTTP狀態和異常消息的詳細信息。對于瀏覽器客戶端，有一個以HTML格式呈現相同數據的“whitelabel”錯誤視圖（要對其進行自定義，請添加一個解決錯誤的視圖）。
如果要自定義默認錯誤處理行為，可以設置許多server.error屬性。
要完全替換默認行為，可以實現ErrorController并注冊該類型的bean定義，或者添加ErrorAttributes類型的bean以使用現有機制，但替換內容。
你還可以定義一個用@ControllerAdvice注釋的類，以自定義JSON格式，以針對特定控制器和/或異常類型返回，如以下示例所示：
(basePackageClasses = AcmeController.class)public class AcmeControllerAdvice extends ResponseEntityExceptionHandler { (YourException.class) ResponseEntity<?> handleControllerException(HttpServletRequest request, Throwable ex) { HttpStatus status = getStatus(request); return new ResponseEntity<>(new CustomErrorType(status.value(), ex.getMessage()), status); } private HttpStatus getStatus(HttpServletRequest request) { Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code"); if (statusCode == null) { return HttpStatus.INTERNAL_SERVER_ERROR; } return HttpStatus.valueOf(statusCode); }}
在前面的示例中，如果你的異常是由與AcmeController在同一個包中定義的控制器引發的，那么將使用CustomErrorType POJO的JSON表示，而不是ErrorAttributes表示。
自定義錯誤頁
如果要顯示給定狀態代碼的自定義HTML錯誤頁面，可以將文件添加到/error目錄。錯誤頁面可以是靜態HTML（即，添加到任何靜態資源目錄下），也可以使用模板構建。文件名應為準確的狀態代碼或序列掩碼。
例如，要將404映射到靜態HTML文件，目錄結構如下：
src/ +- main/ +- java/ | + <source code> +- resources/ +- public/ +- error/ | +- 404.html +- <other public assets>
要使用FreeMarker模板映射所有5xx錯誤，目錄結構如下：
src/ +- main/ +- java/ | + <source code> +- resources/ +- templates/ +- error/ | +- 5xx.ftlh +- <other templates>
對于更復雜的映射，你還可以添加實現ErrorViewResolver接口的bean，如以下示例所示：
public class MyErrorViewResolver implements ErrorViewResolver { public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) { // Use the request or status to optionally return a ModelAndView return ... }}
系統默認提供的DefaultErrorViewResolver 在該類中我們可以看到默認從如下幾個位置查找錯誤頁。
public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered { private static final Map<Series, String> SERIES_VIEWS; static { Map<Series, String> views = new EnumMap<>(Series.class); views.put(Series.CLIENT_ERROR, "4xx"); views.put(Series.SERVER_ERROR, "5xx"); SERIES_VIEWS = Collections.unmodifiableMap(views);} ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) { ModelAndView modelAndView = resolve(String.valueOf(status.value()), 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) { String errorViewName = "error/" + viewName; // ... return resolveResource(errorViewName, model); } private ModelAndView resolveResource(String viewName, Map<String, Object> model) { // 從以下路徑進行查找(路徑都會拼接上error/目錄) // classpath:/META-INF/resources/ // classpath:/resources/ // classpath:/static/ // classpath:/public/ // 以上路徑都可以通過spring.web.resources.staticLocations進行配置 for (String location : this.resources.getStaticLocations()) { try { Resource resource = this.applicationContext.getResource(location); resource = resource.createRelative(viewName + ".html"); if (resource.exists()) { return new ModelAndView(new HtmlResourceView(resource), model); } } } return null; }}
Spring MVC之外的映射錯誤頁面
對于不使用Spring MVC的應用程序，可以使用ErrorPageRegistrar接口直接注冊ErrorPages。此抽象直接與底層嵌入式servlet容器一起工作，即使你沒有Spring MVC DispatcherServlet，也可以工作。
自定義錯誤頁
ErrorPageRegistrar errorPageRegistrar(){ return new MyErrorPageRegistrar();}private static class MyErrorPageRegistrar implements ErrorPageRegistrar { public void registerErrorPages(ErrorPageRegistry registry) { registry.addErrorPages(new ErrorPage(HttpStatus.BAD_REQUEST, "/400")); }}
工作原理
- TomcatServletWebServerFactory
public class TomcatServletWebServerFactory extends AbstractServletWebServerFactory implements ConfigurableTomcatWebServerFactory, ResourceLoaderAware { private Set<ErrorPage> errorPages = new LinkedHashSet<>(); public WebServer getWebServer(ServletContextInitializer... initializers) { prepareContext(tomcat.getHost(), initializers); } protected void prepareContext(Host host, ServletContextInitializer[] initializers) { configureContext(context, initializersToUse); } protected void configureContext(Context context, ServletContextInitializer[] initializers) { TomcatStarter starter = new TomcatStarter(initializers); // 遍歷所有的ErrorPage對象，將其注冊到Tomcat容器中 for (ErrorPage errorPage : getErrorPages()) { org.apache.tomcat.util.descriptor.web.ErrorPage tomcatErrorPage = new org.apache.tomcat.util.descriptor.web.ErrorPage(); tomcatErrorPage.setLocation(errorPage.getPath()); tomcatErrorPage.setErrorCode(errorPage.getStatusCode()); tomcatErrorPage.setExceptionType(errorPage.getExceptionName()); context.addErrorPage(tomcatErrorPage); } }}
- 注冊處理器
// 在該自動配置類中，會注冊一個BeanPostProcessorsRegistrar處理器@Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,...})public class ServletWebServerFactoryAutoConfiguration {}- 注冊錯誤頁注冊器
在上一步中注冊了BeanPostProcessorsRegistrar處理器。在該處理器中會注冊一個ErrorPageRegistrarBeanPostProcessor錯誤頁注冊器的處理器。
public static class BeanPostProcessorsRegistrar implements ImportBeanDefinitionRegistrar, BeanFactoryAware { public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { // ... // 注冊ErrorPageRegistrarBeanPostProcessor，又是一個處理器 registerSyntheticBeanIfMissing(registry, "errorPageRegistrarBeanPostProcessor", ErrorPageRegistrarBeanPostProcessor.class, ErrorPageRegistrarBeanPostProcessor::new); }}
- 注冊錯誤頁
public class ErrorPageRegistrarBeanPostProcessor implements BeanPostProcessor, BeanFactoryAware { private ListableBeanFactory beanFactory; private List<ErrorPageRegistrar> registrars; public void setBeanFactory(BeanFactory beanFactory) { this.beanFactory = (ListableBeanFactory) beanFactory; } public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { // 判斷當前的Bean是不是ErrorPageRegistry對象，在9.2中最后我們提到了TomcatServletWebServerFactory類實現了 // ErrorPageRegistry接口。 if (bean instanceof ErrorPageRegistry) { // 處理 postProcessBeforeInitialization((ErrorPageRegistry) bean); } return bean; } @Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { return bean; } // registry = TomcatServletWebServerFactory private void postProcessBeforeInitialization(ErrorPageRegistry registry) { // 獲取容器中所有ErrorPageRegistrar類型的Bean對象 for (ErrorPageRegistrar registrar : getRegistrars()) { // 將錯誤頁注冊到TomcatServletWebServerFactory中 registrar.registerErrorPages(registry); } } private Collection<ErrorPageRegistrar> getRegistrars() { if (this.registrars == null) { // 從容器中獲取所有ErrorPageRegistrar類型的Bean // 容器默認是注冊了一個ErrorPageRegistrar this.registrars = new ArrayList<>( this.beanFactory.getBeansOfType(ErrorPageRegistrar.class, false, false).values()); this.registrars.sort(AnnotationAwareOrderComparator.INSTANCE); this.registrars = Collections.unmodifiableList(this.registrars); } return this.registrars; }}
以上的過程就實現了自定義錯誤頁的注冊實現。
跨域支持
跨源資源共享（CORS）是大多數瀏覽器實現的W3C規范，允許您以靈活的方式指定授權何種跨域請求。而不是使用一些不太安全、功能不太強大的方法，如IFRAME或JSONP。
從版本4.2開始，Spring MVC支持CORS。在Spring Boot應用程序中使用帶有@CrossOrigin注釋的控制器方法CORS配置不需要任何特定配置。可以通過使用自定義的addCorsMappings(CorsRegistry)方法注冊WebMVCConfiguer bean來定義全局CORS配置，如下例所示：
(proxyBeanMethods = false)public class MyConfiguration { public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurer() { public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/api/**"); } }; }}
責任編輯：姜華
來源：
今日頭條
