Spring Boot 可执行 jar 可执行 war 结构

2019-03-25 本文已影响0人洋洋洒洒_6a20

原文地址 https://docs.spring.io/spring-boot/docs/1.5.19.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar

Spring引导加载程序模块允许Spring引导支持可执行jar和war文件。如果您正在使用Maven或Gradle插件，那么可执行jar将自动生成，您通常不需要知道它们如何工作的细节。

如果您需要从不同的构建系统创建可执行jar，或者您只是对底层技术感兴趣，那么本节将提供一些背景知识。

E.1嵌套的jar

Java没有提供任何加载嵌套的jar文件(即包含在jar中的jar文件)的标准方法。如果您希望分发一个自包含的应用程序，您可以只从命令行运行该应用程序，而不需要解压缩，那么这可能会有问题。
为了解决这个问题，许多开发人员使用“shaded”jar。shaded jar只是将所有jar中的所有类打包到一个“uber jar”中。shaded jar的问题是，很难看到在应用程序中实际使用的库。如果在多个jar中使用相同的文件名(但内容不同)，也会出现问题。Spring Boot采用了一种不同的方法，允许您直接嵌套jar。

E.1.1 可执行jar文件结构

Spring引导加载程序兼容的jar文件的结构应该如下所示:

example.jar
 |
 +-META-INF
 |  +-MANIFEST.MF
 +-org
 |  +-springframework
 |     +-boot
 |        +-loader
 |           +-<spring boot loader classes>
 +-BOOT-INF
    +-classes
    |  +-mycompany
    |     +-project
    |        +-YourClasses.class
    +-lib
       +-dependency1.jar
       +-dependency2.jar

应用程序类应该放在一个嵌套的BOOT-INF/classes目录中. 依赖项应该放在一个嵌套的BOOT-INF/lib目录中。

E.1.2 可执行的war文件结构

兼容Spring Boot Loader的war文件的结构应该是这样的:

example.war
 |
 +-META-INF
 |  +-MANIFEST.MF
 +-org
 |  +-springframework
 |     +-boot
 |        +-loader
 |           +-<spring boot loader classes>
 +-WEB-INF
    +-classes
    |  +-com
    |     +-mycompany
    |        +-project
    |           +-YourClasses.class
    +-lib
    |  +-dependency1.jar
    |  +-dependency2.jar
    +-lib-provided
       +-servlet-api.jar
       +-dependency3.jar

依赖项应该放在嵌套的WEB-INF/lib目录中。嵌入式运行时需要但部署到传统web容器时不需要的任何依赖项都应该放在WEB-INF/lib-provide中。

E.2 Spring Boot’s “JarFile” class

用于支持加载嵌套jar的核心类是org.springframework.boot.loader.jar.JarFile。它允许您加载标准jar文件或嵌套的jar文件。第一次加载时，每个JarEntry的位置都被映射成外部jar的文件偏移量

myapp.jar
+-------------------+-------------------------+
| /BOOT-INF/classes | /BOOT-INF/lib/mylib.jar |
|+-----------------+||+-----------+----------+|
||     A.class      |||  B.class  |  C.class ||
|+-----------------+||+-----------+----------+|
+-------------------+-------------------------+
 ^                    ^           ^
 0063                 3452        3980

上面的例子展示了A。类可以在myapp.jar中的/BOOT-INF/classes中找到相当于myapp.jar的0063文件偏移量的位置。B class 可以在myapp嵌套jar的3452文件偏移量中找到，C class 可以再3980位置找到。

有了这些信息，我们可以通过查找外部jar的适当部分来加载特定的嵌套jar。我们不需要解压归档文件，也不需要将所有条目数据读入内存。

E.2.1 与标准Java“JarFile”的兼容性

Spring引导加载程序努力保持与现有代码和库的兼容性。org.springframework.boot.loader.jar.JarFile是java.util.jar.JarFile的扩展。是可替换的。getURL()方法将返回一个URL，该URL打开一个兼容java.net.JarURLConnection的连接，可以与Java的URLClassLoader一起使用。

E.3 启动可执行jar

org.springframework.boot.loader.Launcher 启动器类是一个特殊的引导类，它用作一个可执行jar主入口点。它是jar文件中实际的主类，用于设置适当的URLClassLoader并最终调用main()方法。

有3个启动器子类(JarLauncher, WarLauncher和PropertiesLauncher)。它们的目的是加载资源(.class文件等)从目录中的嵌套jar文件或war文件(与类路径中的显式文件相反)获取。在JarLauncher和WarLauncher的情况下，嵌套路径是固定的。JarLauncher在BOOT-INF/lib/ ,WarLauncher在WEB-INF/lib/和WEB-INF/lib-provide/ 中查找，所以如果您想要更多，只需在这些位置添加额外的jar即可。默认情况下，PropertiesLauncher会出现在应用程序存档中的BOOT-INF/lib/中，您可以通过设置环境变量LOADER_PATH或loader来添加其他位置。

E.3.1 启动程序清单(Launcher manifest)

您需要指定一个适当的启动程序作为META-INF/MANIFEST.MF的主类属性。应该在start类属性中指定要启动的实际类(即您编写的包含main方法的类)。

例如，下面是一个典型的清单。MF为可执行jar文件:

Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.mycompany.project.MyApplication

对于war文件，它应该是:

Main-Class: org.springframework.boot.loader.WarLauncher
Start-Class: com.mycompany.project.MyApplication

您不需要在清单文件中指定类路径项，程序会自动查找路径。

E.3.2 Exploded archives(归档文件)

某些PaaS实现可能选择在运行前解包存档。例如，你可以运行一个解压缩档案，只需启动适当的启动器:

$ unzip -q myapp.jar
$ java org.springframework.boot.loader.JarLauncher

E.4 PropertiesLauncher特性

PropertiesLauncher has a few special features that can be enabled with external properties (System properties, environment variables, manifest entries or loader.properties).

PropertiesLauncher支持从loader.properties以及(由于历史原因)application.properties加载属性。我们建议使用loader.properties，作为对应用程序的支持。application.properties已被弃用，将来可能会被删除。

Key	Purpose
loader.path	逗号分隔的类路径，例如`lib`、`${HOME}/app/lib`,类似 `javac` `-classpath`
loader.home	用于解析`loader.path`中的相对路径。如装载机。`loader.path=lib` `${loader.home}/lib`是一个类路径位置(以及该目录中的所有jar文件)。也用于定位加载`loader.properties`。示例`/opt/app`(默认为`${user.dir}`)。
loader.args	主方法的默认参数(以空格分隔)
loader.main	要启动的主类的名称，例如`com.app.Application`
loader.config.name	属性文件的名称，例如启动器(默认为加载器)。
loader.config.location	属性文件的路径，例如类路径:loader。属性(默认为loader.properties)。
loader.system	布尔标志，指示应将所有属性添加到系统属性中(默认为false)

当指定为环境变量或清单项时，应使用以下名称:

Key Manifest	entry	Environment variable
loader.path	Loader-Path	LOADER_PATH
loader.home	Loader-Home	LOADER_HOME
loader.args	Loader-Args	LOADER_ARGS
loader.main	Start-Class	LOADER_MAIN
loader.config.location	Loader-Config-Location	LOADER_CONFIG_LOCATION
loader.system	Loader-System	LOADER_SYSTEM

构建插件在构建fat jar时自动将Main-Class属性移动到Start-Class。如果您正在使用它，请使用Main-Class属性指定要启动的类的名称，并省略Start-Class。

loader.properties 先在 loader.home查找然后在classpath根目录查找, 最后是classpath:/BOOT-INF/classes 使用存在的第一个位置。
loader.home 只是一个附加属性文件的目录位置(覆盖默认值)，只要load.config存在。没有指定位置。
loader.path 可以包含目录(递归扫描jar和zip文件)、归档路径、归档文件中扫描jar文件的目录(例如，“dependensis .jar!/lib”)或通配符模式(默认JVM行为)。存档路径可以相对于加载器。home，或者文件系统中具有jar:file:前缀的任何地方。
loader.path path(如果为空)默认为BOOT-INF/lib(意味着从存档文件运行的本地目录或嵌套目录)。由于这个属性，当没有提供额外配置时，启动器的行为与JarLauncher相同。
loader.path 不能用于配置加载程序的位置。属性(用于搜索后者的类路径是启动PropertiesLauncher时的JVM类路径)。
占位符替换是在使用前从系统和环境变量以及所有值上的属性文件本身进行的。
属性的搜索顺序是env vars、系统属性和loader(在多个位置查找是有意义的)。属性，分解的存档清单，存档清单。

E.5 可执行jar的限制

在使用Spring引导加载程序打包的应用程序时，需要考虑许多限制。

E.5.1 Zip实体压缩(Zip entry compression)

嵌套实体 ZipEntry 必须使用 ZipEntry.STORED 方法，这是必需的，以便我们可以直接查找嵌套jar中的各个内容。嵌套jar文件本身的内容仍然可以压缩，外部jar中的其他entries也可以压缩。

E.5.2 System ClassLoader

启动的应用程序在加载类时应该使用Thread.getContextClassLoader()(默认情况下，大多数库和框架都会这样做)。通过ClassLoader.getSystemClassLoader()加载嵌套的jar类将会失败。请注意java.util.Logging总是使用系统类加载器，因此您应该考虑不同的日志实现。

E.6 可选的fat jar 替代方案

如果上述限制意味着您不能使用Spring引导加载程序，可以考虑以下替代方案:

Maven Shade Plugin
JarClassLoader
OneJar