Springboot 如何确定程序的应用类型 WebApplicationType ？

喜欢ヅ旅行 2022-09-09 10:59 189阅读 0赞

Springboot 在启动的时候，首先会初始化一个 SpringApplication 对象，具体调用过程如下：

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16][]

从上面调用方法可知，程序执行时，首先会调用 SpringApplication 的构造方法创建一个 SpringApplication 对象（图3处），而具体的实现在图5处。

【WebApplicationType】

我们将（图5处）SpringApplication 构造方法单独拎出来，在该段代码中的黄色框部分，指明了程序的应用类型（webApplicationType）

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 1][]

我们找到 SpringApplication 该属性的对象类型 WebApplicationType，

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 2][]

然后打开其源码，发现该对象是一个枚举，且里面定义了三个枚举值，分别是 NONE、SERVLET、REACTIVE。

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 3][]

下面三个枚举值的介绍：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>NONE</td> 
   <td> <p>应用程序不应作为 web 应用程序运行，也不应启动嵌入式 web 服务器。</p> </td> 
  </tr> 
  <tr> 
   <td>SERVLET</td> 
   <td>应用程序应作为基于 servlet 的 web 应用程序运行，并应启动嵌入式 servlet web 服务器。</td> 
  </tr> 
  <tr> 
   <td>REACTIVE</td> 
   <td>应用程序应作为反应式 web 应用程序运行，并应启动嵌入式反应式 web 服务器。</td> 
  </tr> 
 </tbody> 
</table>

言外之意，我们的 Springboot 项目的程序类型有三种：

（1）非 web 应用程序（不内嵌服务器）；

（2）内嵌基于 servlet 的 web 服务器（如：Tomcat，Jetty，Undertow 等，其实现在大多Java网站应用都是采用的基于 Tomcat 的 servlet 类型服务器）；

（3）内嵌基于反应式的 web 服务器（如： Netty）；

> 在 servlet 容器当中，采用命令式编程方式，代码一句一句的执行，这样更有利于理解与调试，而在反应式的 web 编程中，是基于异步响应式，现在 WebFlux 框架就是一个较为流行的反应式编程。

既然我们了解到了 Springboot 应用程序的三种类型，那么他又是如何确定当前程序类型的呢？

【WebApplicationType.deduceFromClasspath() 方法】

我们回到刚刚赋值应用类型的那句代码中，可以看到 WebApplicationType.deduceFromClasspath() 这个方法。

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 4][]

打开该方法的实现源码，这里我们就可以看到三个应用类型的获取的代码了。

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 5][]

【ClassUtils.isPresent()】

在这个方法中，反复出现的一个方法就是 ClassUtils.isPresent()，其中里面的参数就是一个包路径类名。那么这个方法又是做什么的呢？我们不妨继续验证下：

我们首先创建一个 Student 类，然后调用 ClassUtils.isPresent() 方法，最后看到方法的返回结果是 true。

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 6][]

现在我们将参数改为不存在的类名 Student2 执行后，发现为 false。

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 7][]

于是我们可以得出如下结论：

ClassUtils.isPresent() 方法是用来判断一个类的存在性的，当这个类存在，那么返回的就是 true；当这个类不存在时，返回的结果就是 fasle。

【总结】

于是我们回到源代码中，结合常量的定义就不难得出 Springboot 应用类型的判断了：

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 8][]

总结如下：

（1）当项目中存在 DispatcherHandler 这个类，且不存在 DispatcherServlet 类和ServletContainer时，程序的应用类型就是 REACTIVE，也就是他会加载嵌入一个反应式的 web 服务器。

（2）当项目中 Servlet 和 ConfigurableWebApplicationContext 其中一个不存在时，则程序的应用类型为 NONE，它并不会加载内嵌任何 web 服务器。

（3）除了上面两种情况外，其余的都按 SERVLET 类型处理，会内嵌一个 servlet 类型的 web 服务器。

而上面的这些类的判定，都来源于 Spring 的相关依赖包，而这依赖包是否需要导入，也是开发者所决定的，所以说开发者可以决定程序的应用类型，并不是 Srpingboot 本身决定的。

最后附带一张图说明：

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 9][]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/d69a1f7585074da892d50b0f221adbb2.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220829/f2a218c2bdf04eb2a8642b3d811f4fa6.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220829/a85185d005024b9d99ead94fac69f915.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220829/734fc81fb9314f9fa625910f98315226.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 4]: /images/20220829/9f49c2750ebe4969aaf13926612efa14.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 5]: /images/20220829/5a033d333d854086b9b9e188204780c6.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 6]: /images/20220829/3c0362327440410cb3d8ebe37994dc39.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 7]: /images/20220829/b04e03e416da4fe0886f468bffcdf7e0.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 8]: /images/20220829/dd1c25c56f4a4298aa586dace14297a7.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAenlxb2s_size_20_color_FFFFFF_t_70_g_se_x_16 9]: /images/20220829/6fa612b3db1e4482a2442802a1ee2e42.png