欢迎光临散文网 会员登陆 & 注册

SpringBoot项目jar、war包启动解析

2023-03-30 15:54 作者:java大能虫  | 我要投稿

一、jar包和war包的区别

1.1 war包

  1. war包是Java Web应用程序的一种打包方式符合Servlet标准,它是Web Archive的缩写,主要用于存储Web应用程序相关的文件,包括Java类文件、JSP、HTML、CSS、JavaScript、图片等资源文件。

  2. war包需要部署到web服务器中(Tomcat、Apache、IIS)

1.2 jar包

  1. jar包是类的归档文件,主要用于存储Java类文件和相关资源文件。它通常被用于封装Java应用程序或Java类库,方便程序的部署和发布

  2. jar包可以被JVM直接加载和运行。

1.3 主要区别:

  1. jar包主要用于存储Java类文件和相关资源文件,而war包主要用于存储Web应用程序相关的文件。

  2. jar包可以被JVM直接加载和运行,而war包需要被Web服务器加载和运行。

  3. jar包通常用于封装Java应用程序或Java类库,而war包用于封装Java Web应用程序。

二、SpringBoot使用war包启动

war包启动:需要先启动外部的Web服务器,实现Servlet3.0规范中引导应用启动类,然后将war包放入Web服务器下,Web服务器通过回调引导应用启动类方法启动应用。

2.1 Servlet3.0规范中引导应用启动的说明

  • 在Servlet容器(Tomcat、Jetty等)启动应用时,会扫描应用jar包中 ServletContainerInitializer 的实现类。

  • 框架必须在jar包的 META-INF/services 的文件夹中提供一个名为 javax.servlet.ServletContainerInitializer 的文件,文件内容要写明 ServletContainerInitializer 的实现类的全限定名。

  • 这个 ServletContainerInitializer 是一个接口,实现它的类必须实现一个方法:onStartUp

  • 可以在这个 ServletContainerInitializer 的实现类上标注 @HandlesTypes 注解,在应用启动的时候自行加载一些附加的类,这些类会以字节码的集合形式传入 onStartup 方法的第一个参数中。

2.2 SpringBootServletInitializer的作用和原理

Spirng中
SpringServletContainerInitializer实现了Servlet的规范

@HandlesTypes(WebApplicationInitializer.class)public class SpringServletContainerInitializer implements ServletContainerInitializer {    @Override    public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)            throws ServletException {        // SpringServletContainerInitializer会加载所有的WebApplicationInitializer类型的普通实现类        List<WebApplicationInitializer> initializers = new LinkedList<WebApplicationInitializer>();        if (webAppInitializerClasses != null) {            for (Class<?> waiClass : webAppInitializerClasses) {                // 如果不是接口,不是抽象类                if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&                        WebApplicationInitializer.class.isAssignableFrom(waiClass)) {                    try {                        // 创建该类的实例                        initializers.add((WebApplicationInitializer) waiClass.newInstance());                    }                    catch (Throwable ex) {                        throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);                    }                }            }        }        if (initializers.isEmpty()) {            servletContext.log("No Spring WebApplicationInitializer types detected on classpath");            return;        }        servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");        AnnotationAwareOrderComparator.sort(initializers);        // 启动Web应用onStartup方法        for (WebApplicationInitializer initializer : initializers) {            initializer.onStartup(servletContext);        }    } }

@HandlesTypes使用BCEL的ClassParser在字节码层面读取了/WEB-INF/classes和jar中class文件的超类名和实现的接口名,判断是否与记录的注解类名相同,若相同再通过
org.apache.catalina.util.Introspection类加载为Class对象保存起来,最后传入onStartup方法参数中


SpringServletContainerInitializer类上标注了@HandlesTypes(WebApplicationInitializer.class),所以会导入WebApplicationInitializer实现类

SpringBoot中
SpringBootServletInitializer是WebApplicationInitializer的抽象类,实现了onStartup方法

创建父容器

所以我们只需要自定义类继承
SpringBootServletInitializer并实现configure方法告诉启动类所在的位置就可以实现SpringBoot自启动了

例如:

三、SpringBoot使用jar包启动

按照java官方文档规定,java -jar命令引导的具体启动类必须配置在MANIFEST.MF中的Main-class属性中,该值代表应用程序执行入口类也就是包含main方法的类。

从MANIFEST.MF文件内容可以看到,Main-Class这个属性定义了
org.springframework.boot.loader.JarLauncher,JarLauncher就是对应Jar文件的启动器。而我们项目的启动类SpringBootDemoApplication定义在Start-Class属性中,

JarLauncher会将BOOT-INF/classes下的类文件和BOOT-INF/lib下依赖的jar加入到classpath下,然后调用META-INF/MANIFEST.MF文件Start-Class属性完成应用程序的启动。

关于 jar 官方标准说明请移步

JAR File Specification JAR (file format)

SpringBoot的jar包,会有3个文件夹:

  • BOOT-INF:存放自己编写并编译好的 .class 文件和静态资源文件、配置文件等

  • META-INF:有一个 MANIFEST.MF 的文件

  • org:spring-boot-loader 的一些 .class 文件


META-INF 下面的 MANIFEST.MF 文件,里面的内容如下:

  • 在 Start-Class 中注明了 SpringBoot 的主启动类

  • 在 Main-Class 中注明了一个类: JarLauncher

父类Launcher#launch

3.1 registerUrlProtocolHandler:注册URL协议并清除应用缓存

先设置当前系统的一个变量
java.protocol.handler.pkgs
,而这个变量的作用,是设置 URLStreamHandler 实现类的包路径。

之后要重置缓存,目的是清除之前启动的残留。

3.2createClassLoader:设置类加载路径

3.3 执行main方法

所以 SpringBoot 应用在开发期间只需要写 main 方法,引导启动即可。

SpringBoot项目jar、war包启动解析的评论 (共 条)

分享到微博请遵守国家法律