江苏龙网

  1. 主页 > 生活百科 > >

Springboot默认的错误页是如何工作及工作原理你肯定不知道？

SpringBoot

到此你就知道了一个错误的页是如何在Springboot中被注册的 。到目前为止我们看到的注册到Tomcat容器中的错误页都是个地址，比如：默认是/error 。那这个默认的/error又是怎么提供的接口呢？环境：Springboot2.4.12
环境配置接下来的演示都是基于如下接口进行 。
@RestController@RequestMApping("/exceptions")public class ExceptionsController {@GetMapping("/index")public Object index(int a) {if (a == 0) {throw new BusinessException() ;}return "exception" ;}}默认错误输出默认情况下，当请求一个接口发生异常时会有如下两种情况的错误信息提示

  • 基于html

Springboot默认的错误页是如何工作及工作原理你肯定不知道？

文章插图
图片
 
  • 基于JSON

Springboot默认的错误页是如何工作及工作原理你肯定不知道？

文章插图
图片
 
上面两个示例通过请求的Accept请求头设置希望接受的数据类型，得到不同的响应数据类型 。
标准web错误页配置在标准的JAVA web项目中我们一般是在web.xml文件中进行错误页的配置，如下：
<error-page><location>/error</location></error-page>如上配置后，如发生了异常以后容器会自动地跳转到错误页面 。
Spring实现原理在Springboot中没有web.xml，并且Servlet API也没有提供相应的API进行错误页的配置 。那么在Springboot中又是如何实现错误页的配置呢？
Springboot内置了应用服务，如Tomcat，Undertow，Jetty，默认是Tomcat 。那接下来看下基于默认的Tomcat容器错误页是如何进行配置的 。
  • Servlet Web服务自动配置
@EnableConfigurationProperties(ServerProperties.class)@Import({ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,ServletWebServerFactoryConfiguration.EmbeddedTomcat.class,...})public class ServletWebServerFactoryAutoConfiguration {@Configuration(proxyBeanMethods = false)@ConditionalOnClass({ Servlet.class, Tomcat.class, UpgradeProtocol.class })@ConditionalOnMissingBean(value = https://www.isolves.com/it/cxkf/jiagou/2023-08-21/ServletWebServerFactory.class, search = SearchStrategy.CURRENT)static class EmbeddedTomcat {// 这里主要就是配置Web 容器服务，如这里使用的Tomcat// 注意该类实现了ErrorPageRegistry，那么也就是说该类可以用来注册错误页的@BeanTomcatServletWebServerFactory tomcatServletWebServerFactory(ObjectProvider connectorCustomizers,ObjectProvider contextCustomizers,ObjectProvider> protocolHandlerCustomizers) {TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();factory.getTomcatConnectorCustomizers().addAll(connectorCustomizers.orderedStream().collect(Collectors.toList()));factory.getTomcatContextCustomizers().addAll(contextCustomizers.orderedStream().collect(Collectors.toList()));factory.getTomcatProtocolHandlerCustomizers().addAll(protocolHandlerCustomizers.orderedStream().collect(Collectors.toList()));return factory;}}}在@Import中只列出了两个比较重要的BeanPostProcessorsRegistrar与EmbeddedTomcat
BeanPostProcessorsRegistrar注册了两个BeanPostProcessor处理器
public static class BeanPostProcessorsRegistrar implements ImportBeanDefinitionRegistrar, BeanFactoryAware {public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {if (this.beanFactory == null) {return;}registerSyntheticBeanIfMissing(registry, "webServerFactoryCustomizerBeanPostProcessor", WebServerFactoryCustomizerBeanPostProcessor.class, WebServerFactoryCustomizerBeanPostProcessor::new);registerSyntheticBeanIfMissing(registry, "errorPageRegistrarBeanPostProcessor", ErrorPageRegistrarBeanPostProcessor.class, ErrorPageRegistrarBeanPostProcessor::new);}}通过名称也能知道WebServerFactoryCustomizerBeanPostProcessor用来处理Tomcat相关的自定义信息；ErrorPageRegistrarBeanPostProcessor 这个就是重点了，这个就是用来配置我们的自定义错误页面的 。
【Springboot默认的错误页是如何工作及工作原理你肯定不知道？】public class ErrorPageRegistrarBeanPostProcessor implements BeanPostProcessor, BeanFactoryAware {@Overridepublic Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {// 这里判断了当前的bean对象是否是ErrorPageRegistry的实例// 当前类既然是BeanPostProcessor实例，同时上面注册了一个TomcatServletWebServerFactory Bean实例// 那么在实例化TomcatServletWebServerFactory时一定是会调用该BeanPostProcessor处理器的if (bean instanceof ErrorPageRegistry) {postProcessBeforeInitialization((ErrorPageRegistry) bean);}return bean;}// 注册错误页面private void postProcessBeforeInitialization(ErrorPageRegistry registry) {for (ErrorPageRegistrar registrar : getRegistrars()) {registrar.registerErrorPages(registry);}}private Collection<ErrorPageRegistrar> getRegistrars() {if (this.registrars == null) {// Look up does not include the parent context// 从当前上下文中（比包括父上下文）查找ErrorPageRegistrar Bean对象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;}}


推荐阅读


上一篇：SpringBoot通过一个注解结合Redis实现接口限流就是这么简单

下一篇：快速解决网络通断问题