可执行Jar包运行原理

目录

• 1. 打可执行jar包
• 2. 可执行jar包内部结构
• 3. jarlauncher

---

spring boot有一个很方便的功能就是可以将应用打成可执行的jar。那么大家有没想过这个jar是怎么运行起来的呢？本篇博客就来介绍下spring boot可执行jar包的运行原理。

---

1. 打可执行jar包

将spring boot应用打成可执行jar包很容易，只需要在pom中加上一个spring boot提供的插件，然后在执行mvn package即可。

<build>
    <plugins>
        <plugin>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-maven-plugin</artifactid>
        </plugin>
    </plugins>
</build>

注意：

如果你的项目没有继承spring-boot-starter-parent这个pom，你需要做如下配置，将目标绑定到repackage。

<plugin>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-maven-plugin</artifactid>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
</plugin>

关于这个插件的详细使用，可以参考官网

运行完mvn package后，我们会在target目录下看到两个jar文件。myproject-0.0.1-snapshot.jar和myproject-0.0.1-snapshot.jar.original。第一jar文件就是我们应用的可执行jar包，第二个jar文件是应用原始的jar包。

2. 可执行jar包内部结构

将打出来的可执行jar解压开我们能看到下面的结构：

可执行jar 目录结构
├─boot-inf
│  ├─classes
│  └─lib
├─meta-inf
│  ├─maven
│  ├─app.properties
│  ├─manifest.mf      
└─org
    └─springframework
        └─boot
            └─loader
                ├─archive
                ├─data
                ├─jar
                └─util

我们先来重点关注两个地方：meta-inf下面的jar包描述文件和boot-inf这个目录。

manifest-version: 1.0
archiver-version: plexus archiver
built-by: xxxx
start-class: com.xxxx.appserver
spring-boot-classes: boot-inf/classes/
spring-boot-lib: boot-inf/lib/
spring-boot-version: 2.1.6.release
created-by: apache maven 3.3.9
build-jdk: 1.8.0_73
main-class: org.springframework.boot.loader.jarlauncher

在上面我们看到一个熟悉的配置main-class: org.springframework.boot.loader.jarlauncher。我们大概能猜到这个类是整个系统的入口。

再看下boot-inf这个目录下面，我们会发现里面是我们项目打出来的class文件和项目依赖的jar包。看到这里，你可能已经猜到spring boot是怎么启动项目的了。

3. jarlauncher

public class jarlauncher extends executablearchivelauncher {

    static final string boot_inf_classes = "boot-inf/classes/";

    static final string boot_inf_lib = "boot-inf/lib/";

    public jarlauncher() {
    }

    protected jarlauncher(archive archive) {
        super(archive);
    }

    @override
    protected boolean isnestedarchive(archive.entry entry) {
        if (entry.isdirectory()) {
            return entry.getname().equals(boot_inf_classes);
        }
        return entry.getname().startswith(boot_inf_lib);
    }

    public static void main(string[] args) throws exception {
        //项目入口，重点在launch这个方法中
        new jarlauncher().launch(args);
    }

}

//launch方法
protected void launch(string[] args) throws exception {
    jarfile.registerurlprotocolhandler();
    //创建launchedurlclassloader。如果根类加载器和扩展类加载器没有加载到某个类的话，就会通过launchedurlclassloader这个加载器来加载类。这个加载器会从boot-inf下面的class目录和lib目录下加载类。
    classloader classloader = createclassloader(getclasspatharchives());
    //这个方法会读取jar描述文件中的start-class属性，然后通过反射调用到这个类的main方法。
    launch(args, getmainclass(), classloader);
}

4. 简单总结

• spring boot可执行jar包的入口点是jarlauncher的main方法；
• 这个方法的执行逻辑是先创建一个launchedurlclassloader，这个加载器加载类的逻辑是：先判断根类加载器和扩展类加载器能否加载到某个类，如果都加载不到就从boot-inf下面的class和lib目录下去加载；
• 读取start-class属相，通过反射机制调用启动类的main方法，这样就顺利调用到我们开发的spring boot主启动类的main方法了。

5. 远程调试

这边介绍个调试jarlauncher启动的小技巧--idea 远程调试

step1：我们以下面的方式启动我们的spring boot应用

 java -xdebug -xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=y -jar app.jar

step2：在idea中进行如下配置

然后点击下面的执行按钮执行即可：