百度360必应搜狗淘宝本站头条
nodejsbufferorg.jsoupsetnocountoncv2.bitwise_nottime.strptime
当前位置：网站首页 > 编程字典 > 正文

SpringBoot嵌入式Tomcat的自动配置原理

toyiye 2024-06-21 12:33 8 浏览 0 评论

在读本篇文章之前如果你读过这篇文章https://mp.weixin.qq.com/s/I3-sM55JSb4BFJ-zPosZgQ应该会更加轻松

准备工作

我们知道SpringBoot的自动装配的秘密在org.springframework.boot.autoconfigure包下的spring.factories文件中，而嵌入Tomcat的原理就在这个文件中加载的一个配置类：org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration

@Configuration
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
@ConditionalOnClass(ServletRequest.class)
@ConditionalOnWebApplication(type = Type.SERVLET)
@EnableConfigurationProperties(ServerProperties.class)
@Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,
 ServletWebServerFactoryConfiguration.EmbeddedTomcat.class,
 ServletWebServerFactoryConfiguration.EmbeddedJetty.class,
 ServletWebServerFactoryConfiguration.EmbeddedUndertow.class })
public class ServletWebServerFactoryAutoConfiguration {
 @Bean
 public ServletWebServerFactoryCustomizer servletWebServerFactoryCustomizer(
 ServerProperties serverProperties) {
 return new ServletWebServerFactoryCustomizer(serverProperties);
 }
 @Bean
 @ConditionalOnClass(name = "org.apache.catalina.startup.Tomcat")
 public TomcatServletWebServerFactoryCustomizer tomcatServletWebServerFactoryCustomizer(
 ServerProperties serverProperties) {
 return new TomcatServletWebServerFactoryCustomizer(serverProperties);
 }
 /**
 * Registers a {@link WebServerFactoryCustomizerBeanPostProcessor}. Registered via
 * {@link ImportBeanDefinitionRegistrar} for early registration.
 */
 public static class BeanPostProcessorsRegistrar
 implements ImportBeanDefinitionRegistrar, BeanFactoryAware {
 private ConfigurableListableBeanFactory beanFactory;
 @Override
 public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
 if (beanFactory instanceof ConfigurableListableBeanFactory) {
 this.beanFactory = (ConfigurableListableBeanFactory) beanFactory;
 }
 }
 @Override
 public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
 BeanDefinitionRegistry registry) {
 if (this.beanFactory == null) {
 return;
 }
 registerSyntheticBeanIfMissing(registry,
 "webServerFactoryCustomizerBeanPostProcessor",
 WebServerFactoryCustomizerBeanPostProcessor.class);
 registerSyntheticBeanIfMissing(registry,
 "errorPageRegistrarBeanPostProcessor",
 ErrorPageRegistrarBeanPostProcessor.class);
 }
 private void registerSyntheticBeanIfMissing(BeanDefinitionRegistry registry,
 String name, Class<?> beanClass) {
 if (ObjectUtils.isEmpty(
 this.beanFactory.getBeanNamesForType(beanClass, true, false))) {
 RootBeanDefinition beanDefinition = new RootBeanDefinition(beanClass);
 beanDefinition.setSynthetic(true);
 registry.registerBeanDefinition(name, beanDefinition);
 }
 }
 }
}

首先看一下上方的几个注解

  1. @AutoConfigureOrder这个注解是决定配置类的加载顺序的，当注解里的值越小越先加载，而Ordered.HIGHEST_PRECEDENCE的值是Integer.MIN_VALUE也就是说这个类肯定是最先加载的那一批
  2. @ConditionalOnXXX在之前的文章中已经无数次提到了，就不再阐述了
  3. @EnableConfigurationProperties开启ServerProperties类的属性值配置。而这个类里面包含的就是Web服务的配置
@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {
 private Integer port;
 private InetAddress address;
 @NestedConfigurationProperty
 private final ErrorProperties error = new ErrorProperties();
 private Boolean useForwardHeaders;
 private String serverHeader;
 private int maxHttpHeaderSize = 0; // bytes
 private Duration connectionTimeout;
 @NestedConfigurationProperty
 private Ssl ssl;
 @NestedConfigurationProperty
 private final Compression compression = new Compression();
 @NestedConfigurationProperty
 private final Http2 http2 = new Http2();
 private final Servlet servlet = new Servlet();
 private final Tomcat tomcat = new Tomcat();
 private final Jetty jetty = new Jetty();
 private final Undertow undertow = new Undertow();
}

这个类的代码太多了，这里就不一一贴出来了，我们平常在application.properties中配置的server.xxx就是这个类中属性

  1. @Import引入了4个类，看都是什么吧
  2. BeanPostProcessorsRegistrar
public static class BeanPostProcessorsRegistrar
 implements ImportBeanDefinitionRegistrar, BeanFactoryAware {
 @Override
 public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
 BeanDefinitionRegistry registry) {
 if (this.beanFactory == null) {
 return;
 }
 registerSyntheticBeanIfMissing(registry,
 "webServerFactoryCustomizerBeanPostProcessor",
 WebServerFactoryCustomizerBeanPostProcessor.class);
 registerSyntheticBeanIfMissing(registry,
 "errorPageRegistrarBeanPostProcessor",
 ErrorPageRegistrarBeanPostProcessor.class);
 }
 private void registerSyntheticBeanIfMissing(BeanDefinitionRegistry registry,
 String name, Class<?> beanClass) {
 if (ObjectUtils.isEmpty(
 this.beanFactory.getBeanNamesForType(beanClass, true, false))) {
 RootBeanDefinition beanDefinition = new RootBeanDefinition(beanClass);
 beanDefinition.setSynthetic(true);
 registry.registerBeanDefinition(name, beanDefinition);
 }
 }
 }

这个类注册了两个bean：WebServerFactoryCustomizerBeanPostProcessor和ErrorPageRegistrarBeanPostProcessor关于这两个bean的作用稍后再详细介绍

  1. EmbeddedTomcat
@Configuration
 @ConditionalOnClass({ Servlet.class, Tomcat.class, UpgradeProtocol.class })
 @ConditionalOnMissingBean(value = ServletWebServerFactory.class, search = SearchStrategy.CURRENT)
 public static class EmbeddedTomcat {
 @Bean
 public TomcatServletWebServerFactory tomcatServletWebServerFactory() {
 return new TomcatServletWebServerFactory();
 }
 }

这个类会在存在Tomcat相关jar包时添加一个TomcatServletWebServerFactorybean

其他两个相信大家都知道怎么回事了

  1. 除了这些这个类还注入了两个类ServletWebServerFactoryCustomizer和TomcatServletWebServerFactoryCustomizer

现在前期准备工作已经做好了，看一下这个Tomcat是如何启动的吧

启动

启动入口在ServletWebServerApplicationContext中的onRefresh方法

protected void onRefresh() {
 super.onRefresh();
 try {
 createWebServer();
 }
 catch (Throwable ex) {
 throw new ApplicationContextException("Unable to start web server", ex);
 }
 }

Tomcat的启动就在createWebServer方法里面了

private void createWebServer() {
 WebServer webServer = this.webServer;
 ServletContext servletContext = getServletContext();
 //第一次访问的时候两个对象都为空
 if (webServer == null && servletContext == null) {
 ServletWebServerFactory factory = getWebServerFactory();
 this.webServer = factory.getWebServer(getSelfInitializer());
 }
 else if (servletContext != null) {
 try {
 getSelfInitializer().onStartup(servletContext);
 }
 catch (ServletException ex) {
 throw new ApplicationContextException("Cannot initialize servlet context",
 ex);
 }
 }
 initPropertySources();
 }

首先看一下getWebServerFactory

protected ServletWebServerFactory getWebServerFactory() {
 // 这里获取的beanname就是上方注册的tomcatServletWebServerFactory了
 String[] beanNames = getBeanFactory()
 .getBeanNamesForType(ServletWebServerFactory.class);
 if (beanNames.length == 0) {
 throw new ApplicationContextException(
 "Unable to start ServletWebServerApplicationContext due to missing "
 + "ServletWebServerFactory bean.");
 }
 if (beanNames.length > 1) {
 throw new ApplicationContextException(
 "Unable to start ServletWebServerApplicationContext due to multiple "
 + "ServletWebServerFactory beans : "
 + StringUtils.arrayToCommaDelimitedString(beanNames));
 }
 return getBeanFactory().getBean(beanNames[0], ServletWebServerFactory.class);
 }

准备环境里注册的bean现在出来一个了。注意，上方还注册了一个后置处理器EmbeddedServletContainerCustomizerBeanPostProcessor，获取beantomcatServletWebServerFactory的时候就会执行后置处理器的postProcessBeforeInitialization方法

public Object postProcessBeforeInitialization(Object bean, String beanName)
 throws BeansException {
 if (bean instanceof WebServerFactory) {
 postProcessBeforeInitialization((WebServerFactory) bean);
 }
 return bean;
}
private void postProcessBeforeInitialization(WebServerFactory webServerFactory) {
 LambdaSafe
 .callbacks(WebServerFactoryCustomizer.class, getCustomizers(),
 webServerFactory)
 .withLogger(WebServerFactoryCustomizerBeanPostProcessor.class)
 .invoke((customizer) -> customizer.customize(webServerFactory));
 }
 private Collection<WebServerFactoryCustomizer<?>> getCustomizers() {
 if (this.customizers == null) {
 // Look up does not include the parent context
 this.customizers = new ArrayList<>(getWebServerFactoryCustomizerBeans());
 this.customizers.sort(AnnotationAwareOrderComparator.INSTANCE);
 this.customizers = Collections.unmodifiableList(this.customizers);
 }
 return this.customizers;
 }
 @SuppressWarnings({ "unchecked", "rawtypes" })
 private Collection<WebServerFactoryCustomizer<?>> getWebServerFactoryCustomizerBeans() {
 return (Collection) this.beanFactory
 .getBeansOfType(WebServerFactoryCustomizer.class, false, false).values();
 }

这个处理器的作用是获得所有定制器，然后执行定制器的方法

接着往下看

这个时候就可以启动Tomcat了

public WebServer getWebServer(ServletContextInitializer... initializers) {
 Tomcat tomcat = new Tomcat();
 File baseDir = (this.baseDirectory != null ? this.baseDirectory
 : createTempDir("tomcat"));
 tomcat.setBaseDir(baseDir.getAbsolutePath());
 Connector connector = new Connector(this.protocol);
 tomcat.getService().addConnector(connector);
 customizeConnector(connector);
 tomcat.setConnector(connector);
 tomcat.getHost().setAutoDeploy(false);
 configureEngine(tomcat.getEngine());
 for (Connector additionalConnector : this.additionalTomcatConnectors) {
 tomcat.getService().addConnector(additionalConnector);
 }
 prepareContext(tomcat.getHost(), initializers);
 return getTomcatWebServer(tomcat);
 }
protected TomcatWebServer getTomcatWebServer(Tomcat tomcat) {
 return new TomcatWebServer(tomcat, getPort() >= 0);
 }
public TomcatWebServer(Tomcat tomcat, boolean autoStart) {
 Assert.notNull(tomcat, "Tomcat Server must not be null");
 this.tomcat = tomcat;
 this.autoStart = autoStart;
 initialize();
 }
private void initialize() throws WebServerException {
 TomcatWebServer.logger
 .info("Tomcat initialized with port(s): " + getPortsDescription(false));
 synchronized (this.monitor) {
 try {
 addInstanceIdToEngineName();
 Context context = findContext();
 context.addLifecycleListener((event) -> {
 if (context.equals(event.getSource())
 && Lifecycle.START_EVENT.equals(event.getType())) {
 // Remove service connectors so that protocol binding doesn't
 // happen when the service is started.
 removeServiceConnectors();
 }
 });
 // Start the server to trigger initialization listeners
 this.tomcat.start();
 // We can re-throw failure exception directly in the main thread
 rethrowDeferredStartupExceptions();
 try {
 ContextBindings.bindClassLoader(context, context.getNamingToken(),
 getClass().getClassLoader());
 }
 catch (NamingException ex) {
 // Naming is not enabled. Continue
 }
 // Unlike Jetty, all Tomcat threads are daemon threads. We create a
 // blocking non-daemon to stop immediate shutdown
 startDaemonAwaitThread();
 }
 catch (Exception ex) {
 throw new WebServerException("Unable to start embedded Tomcat", ex);
 }
 }
 }

相关推荐

为何越来越多的编程语言使用JSON（为什么编程）

JSON是JavascriptObjectNotation的缩写，意思是Javascript对象表示法，是一种易于人类阅读和对编程友好的文本数据传递方法，是JavaScript语言规范定义的一个子...

何时在数据库中使用 JSON（数据库用json格式存储）

在本文中，您将了解何时应考虑将JSON数据类型添加到表中以及何时应避免使用它们。每天?分享?最新?软件?开发?，Devops，敏捷?，测试?以及?项目?管理?最新?，最热门?的?文章?，每天?花?...

MySQL 从零开始:05 数据类型（mysql数据类型有哪些,并举例）

前面的讲解中已经接触到了表的创建，表的创建是对字段的声明，比如：上述语句声明了字段的名称、类型、所占空间、默认值和是否可以为空等信息。其中的int、varchar、char和decimal都...

JSON对象花样进阶（json格式对象）

一、引言在现代Web开发中，JSON（JavaScriptObjectNotation）已经成为数据交换的标准格式。无论是从前端向后端发送数据，还是从后端接收数据，JSON都是不可或缺的一部分。...

深入理解 JSON 和 Form-data（json和formdata提交区别）

在讨论现代网络开发与API设计的语境下，理解客户端和服务器间如何有效且可靠地交换数据变得尤为关键。这里，特别值得关注的是两种主流数据格式：...

JSON 语法（json 语法 priority）

JSON语法是JavaScript语法的子集。JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔花括号保存对象方括号保存数组JS...

JSON语法详解（json的语法规则）

JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔大括号保存对象中括号保存数组注意：json的key是字符串,且必须是双引号，不能是单引号...

MySQL JSON数据类型操作（mysql的json）

概述mysql自5.7.8版本开始，就支持了json结构的数据存储和查询，这表明了mysql也在不断的学习和增加nosql数据库的有点。但mysql毕竟是关系型数据库，在处理json这种非结构化的数据...

JSON的数据模式（json数据格式示例）

像XML模式一样，JSON数据格式也有Schema，这是一个基于JSON格式的规范。JSON模式也以JSON格式编写。它用于验证JSON数据。JSON模式示例以下代码显示了基本的JSON模式。{"...

前端学习——JSON格式详解（后端json格式）

JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScriptProgrammingLa...

什么是 JSON:详解 JSON 及其优势（什么叫json）

现在程序员还有谁不知道JSON吗？无论对于前端还是后端，JSON都是一种常见的数据格式。那么JSON到底是什么呢？JSON的定义...

PostgreSQL JSON 类型:处理结构化数据

PostgreSQL提供JSON类型，以存储结构化数据。JSON是一种开放的数据格式，可用于存储各种类型的值。什么是JSON类型？JSON类型表示JSON(JavaScriptO...

JavaScript:JSON、三种包装类（javascript 包）

JOSN:我们希望可以将一个对象在不同的语言中进行传递，以达到通信的目的，最佳方式就是将一个对象转换为字符串的形式JSON（JavaScriptObjectNotation）-JS的对象表示法...

Python数据分析 只要1分钟 教你玩转JSON 全程干货

Json简介：Json，全名JavaScriptObjectNotation,JSON(JavaScriptObjectNotation(记号、标记))是一种轻量级的数据交换格式。它基于J...

比较一下JSON与XML两种数据格式?（json和xml哪个好）

JSON（JavaScriptObjectNotation）和XML（eXtensibleMarkupLanguage）是在日常开发中比较常用的两种数据格式，它们主要的作用就是用来进行数据的传...

取消回复欢迎 你 发表评论:

请填写验证码
一周热门
最近发表
标签列表