这些spring-boot-loader模块让 Spring Boot 支持可执行的 jar 和 war 文件。如果您使用 Maven 插件或 Gradle 插件，可执行 jar 会自动生成，您通常不需要了解它们的工作原理。

如果您需要从不同的构建系统创建可执行 jar，或者您只是对底层技术感到好奇，本附录提供了一些背景知识。

1. 嵌套的 JAR

Java 不提供任何标准方法来加载嵌套的 jar 文件（即，本身包含在 jar 中的 jar 文件）。如果您需要分发可以从命令行运行而无需解包的独立应用程序，这可能会出现问题。

为了解决这个问题，许多开发人员使用“阴影”罐子。带阴影的 jar 将所有 jar 中的所有类打包到一个“uber jar”中。带阴影的 jar 的问题是很难看出哪些库实际上在您的应用程序中。如果在多个 jar 中使用相同的文件名（但内容不同），也可能会出现问题。Spring Boot 采用了不同的方法，让您实际上可以直接嵌套 jar。

1.1。可执行 Jar 文件结构

Spring Boot Loader 兼容的 jar 文件应按以下方式构造：

例子.jar
 |
 +-元信息
 | +-清单.MF
 +-组织
 | +-springframework
 | +-启动
 | +-装载机
 | +-<spring boot loader 类>
 +-引导-INF
    +-类
    | +-我的公司
    | +-项目
    | +-YourClasses.class
    +-lib
       +-dependency1.jar
       +-dependency2.jar

应用程序类应放置在嵌套BOOT-INF/classes目录中。依赖项应放置在嵌套BOOT-INF/lib目录中。

1.2. 可执行的战争文件结构

与 Spring Boot Loader 兼容的 war 文件应按以下方式构建：

例子.war
 |
 +-元信息
 | +-清单.MF
 +-组织
 | +-springframework
 | +-启动
 | +-装载机
 | +-<spring boot loader 类>
 +-WEB-INF
    +-类
    | +-com
    | +-我的公司
    | +-项目
    | +-YourClasses.class
    +-lib
    | +-dependency1.jar
    | +-dependency2.jar
    +-lib-提供
       +-servlet-api.jar
       +-dependency3.jar

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

1.3. 索引文件

Spring Boot Loader 兼容的 jar 和 war 档案可以在BOOT-INF/目录下包含其他索引文件。classpath.idx可以为 jars 和 wars 提供一个文件，它提供了将 jars 添加到类路径的顺序。该layers.idx文件只能用于 jar，它允许将 jar 拆分为逻辑层以创建 Docker/OCI 映像。

索引文件遵循与 YAML 兼容的语法，因此它们可以很容易地被第三方工具解析。但是，这些文件不会在内部被解析为 YAML，它们必须完全按照下面描述的格式编写才能使用。

1.4. 类路径索引

类路径索引文件可以在BOOT-INF/classpath.idx. 它提供了一个 jar 名称列表（包括目录），按照它们应该添加到类路径的顺序。每行必须以破折号空格 ( "-·") 开头，并且名称必须用双引号括起来。

例如，给定以下 jar：

例子.jar
 |
 +-元信息
 | +-...
 +-引导-INF
    +-类
    | +...
    +-lib
       +-dependency1.jar
       +-dependency2.jar

索引文件如下所示：

-“引导-INF/lib/dependency2.jar”
-“引导-INF/lib/dependency1.jar”

1.5。图层索引

图层索引文件可以在BOOT-INF/layers.idx. 它提供了层列表和应包含在其中的 jar 的部分。层是按照它们应该添加到 Docker/OCI 映像的顺序编写的。层名称写为带引号的字符串，前缀为破折号空格 ( "-·") 和冒号 ( ":") 后缀。层内容是文件或目录名称，以空格、破折号空格 ( "··-·") 为前缀的带引号的字符串编写。目录名以 结尾/，文件名不以 结尾。当使用目录名称时，这意味着该目录中的所有文件都在同一层中。

层索引的典型示例是：

- “依赖”：
  -“引导-INF/lib/dependency1.jar”
  -“引导-INF/lib/dependency2.jar”
- “应用”：
  -“引导-INF/类/”
  - “元信息/”

2. Spring Boot 的“JarFile”类

用于支持加载嵌套 jar 的核心类是org.springframework.boot.loader.jar.JarFile. 它允许您从标准 jar 文件或嵌套的子 jar 数据加载 jar 内容。首次加载时，每个位置都JarEntry映射到外 jar 的物理文件偏移量，如下例所示：

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

前面的示例显示了如何在at 位置A.class找到。 从嵌套的 jar 中实际上可以在at position找到，并且是在 position 。/BOOT-INF/classesmyapp.jar0063B.classmyapp.jar3452C.class3980

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

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

Spring Boot Loader 力求与现有代码和库保持兼容。 org.springframework.boot.loader.jar.JarFile扩展自java.util.jar.JarFile并应作为替代品使用。该getURL()方法返回一个URL打开与 Java 兼容java.net.JarURLConnection并可用于 Java 的连接的URLClassLoader.

3. 启动可执行罐子

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

有三个启动器子类（JarLauncher、WarLauncher和PropertiesLauncher）。它们的目的是.class从目录中的嵌套 jar 文件或 war 文件加载资源（文件等）（与那些显式在类路径上的文件相反）。在 和 的情况下JarLauncher，WarLauncher嵌套路径是固定的。 JarLauncher看着BOOT-INF/lib/，WarLauncher看着WEB-INF/lib/和WEB-INF/lib-provided/。如果你想要更多，你可以在这些位置添加额外的罐子。默认情况下，在您的应用程序存档中PropertiesLauncher查找。您可以通过设置一个名为or inBOOT-INF/lib/的环境变量来添加其他位置（这是一个逗号分隔的目录、档案或档案中的目录的列表）。LOADER_PATHloader.pathloader.properties

3.1。启动器清单

您需要指定一个适当Launcher的Main-Class属性作为META-INF/MANIFEST.MF. 您要启动的实际类（即包含main方法的类）应在Start-Class属性中指定。

以下示例显示了一个典型MANIFEST.MF的可执行 jar 文件：

主类：org.springframework.boot.loader.JarLauncher
开始类：com.mycompany.project.MyApplication

对于战争文件，它将如下所示：

主类：org.springframework.boot.loader.WarLauncher
开始类：com.mycompany.project.MyApplication
您无需Class-Path在清单文件中指定条目。类路径是从嵌套的 jar 推导出来的。

4.PropertiesLauncher 功能

PropertiesLauncher有一些可以通过外部属性（系统属性、环境变量、清单条目或loader.properties）启用的特殊功能。下表描述了这些属性：

钥匙 目的

loader.path

逗号分隔的类路径，例如lib,${HOME}/app/lib. 较早的条目优先，就像命令行中-classpath的常规条目一样。javac

loader.home

用于解析loader.path. 例如， given loader.path=lib, then${loader.home}/lib是一个类路径位置（以及该目录中的所有 jar 文件）。该属性还用于定位loader.properties文件，如下例所示/opt/app，它默认为${user.dir}.

loader.args

main 方法的默认参数（空格分隔）。

loader.main

要启动的主类的名称（例如，com.app.Application）。

loader.config.name

属性文件的名称（例如，launcher）。它默认为loader.

loader.config.location

属性文件的路径（例如，classpath:loader.properties）。它默认为loader.properties.

loader.system

布尔标志，指示应将所有属性添加到系统属性。它默认为false.

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

钥匙 清单条目 环境变量

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
构建插件会自动将Main-Class属性移动到构建Start-Classfat jar 时。如果您使用它，请使用Main-Class属性并省略指定要启动的类的名称Start-Class。

以下规则适用于使用PropertiesLauncher：

  • loader.properties在 中搜索loader.home，然后在类路径的根目录中搜索，然后在classpath:/BOOT-INF/classes. 使用具有该名称的文件存在的第一个位置。

  • loader.home仅在loader.config.location未指定时是附加属性文件的目录位置（覆盖默认值）。

  • loader.path可以包含目录（递归扫描 jar 和 zip 文件）、存档路径、存档中扫描 jar 文件的目录（例如，dependencies.jar!/lib）或通配符模式（用于默认 JVM 行为）。存档路径可以相对于loader.home文件系统中的任何位置或带有jar:file:前缀的任何位置。

  • loader.path（如果为空）默认为BOOT-INF/lib（表示本地目录或嵌套目录，如果从存档运行）。因此，其行为与未提供其他配置时PropertiesLauncher相同。JarLauncher

  • loader.path不能用来配置位置loader.properties（后者用来搜索的classpath是JVMPropertiesLauncher启动时的classpath）。

  • 占位符替换是从系统和环境变量以及使用前所有值的属性文件本身完成的。

  • 属性的搜索顺序（在多个地方查找是有意义的）是环境变量、系统属性、、loader.properties展开的存档清单和存档清单。

5. 可执行 Jar 限制

在使用 Spring Boot Loader 打包应用程序时，您需要考虑以下限制：

  • Zip 入口压缩：ZipEntry对于嵌套 jar 必须使用该ZipEntry.STORED方法保存。这是必需的，以便我们可以直接查找嵌套 jar 中的各个内容。嵌套 jar 文件本身的内容仍然可以压缩，外部 jar 中的任何其他条目也可以。

  • 系统类加载器：Thread.getContextClassLoader()加载类时应该使用启动的应用程序（大多数库和框架默认这样做）。尝试加载嵌套 jar 类ClassLoader.getSystemClassLoader()失败。 java.util.Logging总是使用系统类加载器。因此，您应该考虑使用不同的日志记录实现。

6. 替代单罐解决方案

如果上述限制意味着您无法使用 Spring Boot Loader，请考虑以下替代方案：

1. see XML Configuration