SpringBoot源码解析之应用类型识别

创建SpringBoot项目时,如果不选择starter-web,创建的SpringBoot项目可以正常运行,但运行结束程序便终止了。如果配置starter-web,则正常启动web应用。那么,SpringBoot是如何分辨出来当前应用是为web应用还是其他类型的应用呢?本篇文章带领大家从源码层面进行相应分析。

枚举WebApplicationType

SpringBoot使用枚举类WebApplicationType来定义可支持的应用类型以及相关推断应用类型的常量(数组)及静态方法。下面对该枚举类进行详细的讲解。

应用类型

枚举WebApplicationType中定义了三个应用类型:

  • NONE:应用程序不作为web应用启动,不启动内嵌的服务。
  • SERVLET:应用程序以基于servlet的web应用启动,需启动内嵌servlet web服务。
  • REACTIVE:应用程序以响应式web应用启动,需启动内嵌的响应式web服务。

推断应用类型

SpringBoot启动时,在创建SpringApplication的构造方法内会调用枚举WebApplicationType的deduceFromClasspath方法获得应用类型并设置当前应用是普通web应用、响应式web应用还是非web应用。

SpringApplication的构造方法中调用并设置源代码:

  1. this.webApplicationType = WebApplicationType.deduceFromClasspath();

deduceFromClasspath方法由枚举WebApplicationType提供,具体实现如下:

  1. static WebApplicationType deduceFromClasspath() {
  2. if (ClassUtils.isPresent(WEBFLUX_INDICATOR_CLASS, null)
  3. && !ClassUtils.isPresent(WEBMVC_INDICATOR_CLASS, null)
  4. && !ClassUtils.isPresent(JERSEY_INDICATOR_CLASS, null)) {
  5. return WebApplicationType.REACTIVE;
  6. }
  7. for (String className : SERVLET_INDICATOR_CLASSES) {
  8. if (!ClassUtils.isPresent(className, null)) {
  9. return WebApplicationType.NONE;
  10. }
  11. }
  12. return WebApplicationType.SERVLET;
  13. }

推断的过程中重点调用了ClassUtils.isPresent()方法,用来判断指定类名的类是否存在,是否可以进行加载。ClassUtils.isPresent()方法源代码如下:

  1. public static boolean isPresent(String className, @Nullable ClassLoader classLoader) {
  2. try {
  3. forName(className, classLoader);
  4. return true;
  5. }catch (IllegalAccessError err) {
  6. throw new IllegalStateException("Readability mismatch in inheritance hierarchy of class [" +
  7. className + "]: " + err.getMessage(), err);
  8. }catch (Throwable ex) {
  9. return false;
  10. }
  11. }

isPresent()方法调用了forName()方法,如果在调用forName()方法的过程中出现异常则返回false,也就是目标类不存在。否则,返回true。

看一下forName()方法的部分代码:

  1. public static Class<?> forName(String name, @Nullable ClassLoader classLoader)
  2. throws ClassNotFoundException, LinkageError {

  3. // 此处省略一些非空和基础类型的判断逻辑代码

  4. ClassLoader clToUse = classLoader;
  5. if (clToUse == null) {
  6. //如果为空则获取默认classLoader
  7. clToUse = getDefaultClassLoader();
  8. }
  9. try {
  10. // 返回加载户的Class。
  11. return Class.forName(name, false, clToUse);
  12. } catch (ClassNotFoundException ex) {
  13. // 如果直接加载类出现异常,则尝试加载内部类。
  14. int lastDotIndex = name.lastIndexOf(PACKAGE_SEPARATOR);
  15. if (lastDotIndex != -1) {
  16. // 拼接内部类
  17. String innerClassName =
  18. name.substring(0, lastDotIndex) + INNER_CLASS_SEPARATOR + name.substring(lastDotIndex + 1);
  19. try {
  20. return Class.forName(innerClassName, false, clToUse);
  21. }
  22. catch (ClassNotFoundException ex2) {
  23. // Swallow - let original exception get through
  24. }
  25. }
  26. throw ex;
  27. }
  28. }

通过以上核心代码,可得知forName()方法主要做的事情就是获得类加载器,尝试直接加载类,如果失败则尝试加载该类的内部类,如果依旧失败,则抛出异常。

因此,整个应用类型的推断分以下步骤:

  • SpringBoot调用SpringApplication构造方法;
  • SpringApplication构造方法调用枚举类的类型推断方法deduceFromClasspath()。
  • deduceFromClasspath()方法通过ClassUtils.isPresent()返回结果为true或false来确定是否加载成功指定的类。
  • ClassUtils.isPresent()方法通过调用forName()方法并捕获异常来确定是否能够成功加载该类。
  • forName()方法通过尝试加载指定类和指定类的内部类来确定该类是否存在,存在则返回该类,不存在则抛异常。

在类型推断的过程中枚举类WebApplicationType定义了具体去加载哪些类:

  1. private static final String[] SERVLET_INDICATOR_CLASSES = { "javax.servlet.Servlet",
  2. "org.springframework.web.context.ConfigurableWebApplicationContext" };

  3. private static final String WEBMVC_INDICATOR_CLASS = "org.springframework."
  4. + "web.servlet.DispatcherServlet";

  5. private static final String WEBFLUX_INDICATOR_CLASS = "org."
  6. + "springframework.web.reactive.DispatcherHandler";

  7. private static final String JERSEY_INDICATOR_CLASS = "org.glassfish.jersey.servlet.ServletContainer";
  • 如果应用程序存在DispatcherHandler并且不存在DispatcherServlet和ServletContainer则为响应式web应用,需加载并启动内嵌的响应式web服务。
  • 如果应用程序不包含Servlet和ConfigurableWebApplicationContext则为普通应用程序。
  • 其他情况则为基于servlet的web应用,需加载并启动内嵌的web web服务。
上一篇:揭秘:宜信科技中心如何支持公司史上最大规模全员远程办公|下篇


下一篇:多线程,从start开始! | 带你学《Java语言高级特性》之二