构建工具插件
3. Spring Boot AntLib 模块
Spring Boot AntLib 模块为 Apache Ant 提供了基本的 Spring Boot 支持。
您可以使用该模块创建可执行 jar。
要使用该模块，您需要声明一个额外的spring-boot命名空间中的build.xml，如以下示例所示：
<project xmlns:ivy="antlib:org.apache.ivy.ant"
xmlns:spring-boot="antlib:org.springframework.boot.ant"
name="myapp" default="build">
...
</project>您需要记住使用-lib选项，如以下示例所示：
$ ant -lib <directory containing spring-boot-antlib-3.2.12.jar>“使用 Spring Boot”部分包括一个更完整的示例将 Apache Ant 与spring-boot-antlib. |
3.1. Spring Boot Ant 任务
一旦spring-boot-antlibnamespace 的 Namespace 中，可以使用以下附加任务：
3.1.1. 使用 “exejar” 任务
您可以使用exejar任务来创建 Spring Boot 可执行 jar。
该任务支持以下属性：
| 属性 | 描述 | 必填 |
|---|---|---|
|
要创建的目标 jar 文件 |
是的 |
|
Java 类文件的根目录 |
是的 |
|
要运行的主应用程序类 |
不（默认值是找到的第一个类，它声明了 |
以下嵌套元素可用于任务：
| 元素 | 描述 |
|---|---|
|
一个或多个 Resource Collections，描述应添加到所创建 jar 文件内容的一组 Resources。 |
|
应添加到构成应用程序的运行时依赖项 Classpath 的 jar 库集中的一个或多个 Resource Collections。 |
3.1.2. 示例
本节介绍 Ant 任务的两个示例。
<spring-boot:exejar destfile="target/my-application.jar"
classes="target/classes" start-class="com.example.MyApplication">
<resources>
<fileset dir="src/main/resources" />
</resources>
<lib>
<fileset dir="lib" />
</lib>
</spring-boot:exejar><exejar destfile="target/my-application.jar" classes="target/classes">
<lib>
<fileset dir="lib" />
</lib>
</exejar>4. 支持其他构建系统
如果您想使用 Maven、Gradle 或 Ant 以外的构建工具，您可能需要开发自己的插件。 可执行 jar 需要遵循特定格式，并且某些条目需要以未压缩的形式编写（有关详细信息，请参阅附录中的“可执行 jar 格式”部分）。
Spring Boot Maven 和 Gradle 插件都使用spring-boot-loader-tools来实际生成 jar。
如果需要，您可以直接使用此库。
4.1. 重新打包存档
要重新打包现有存档以使其成为自包含的可执行存档，请使用org.springframework.boot.loader.tools.Repackager.
这Repackagerclass 接受一个引用现有 jar 或 war 存档的构造函数参数。
使用两个可用选项之一repackage()方法来替换原始文件或写入新目标。
在运行重新打包程序之前，还可以在重新打包程序上配置各种设置。
4.2. 嵌套库
重新打包存档时，您可以使用org.springframework.boot.loader.tools.Libraries接口。
我们不提供Libraries，因为它们通常是特定于 build system 的。
如果您的档案已包含库，则可以使用Libraries.NONE.
4.3. 查找主类
如果您不使用Repackager.setMainClass()为了指定主类，重新打包程序使用 ASM 读取类文件，并尝试查找具有public static void main(String[] args)方法。
如果找到多个候选者，则会引发异常。
4.4. Repackage 实现示例
以下示例显示了典型的 repackage 实现：
public class MyBuildTool {
public void build() throws IOException {
File sourceJarFile = ...
Repackager repackager = new Repackager(sourceJarFile);
repackager.setBackupSource(false);
repackager.repackage(this::getLibraries);
}
private void getLibraries(LibraryCallback callback) throws IOException {
// Build system specific implementation, callback for each dependency
for (File nestedJar : getCompileScopeJars()) {
callback.library(new Library(nestedJar, LibraryScope.COMPILE));
}
// ...
}
private List<File> getCompileScopeJars() {
return ...
}
}
class MyBuildTool {
@Throws(IOException::class)
fun build() {
val sourceJarFile: File? = ...
val repackager = Repackager(sourceJarFile)
repackager.setBackupSource(false)
repackager.repackage { callback: LibraryCallback -> getLibraries(callback) }
}
@Throws(IOException::class)
private fun getLibraries(callback: LibraryCallback) {
// Build system specific implementation, callback for each dependency
for (nestedJar in getCompileScopeJars()!!) {
callback.library(Library(nestedJar, LibraryScope.COMPILE))
}
// ...
}
private fun getCompileScopeJars(): List<File?>? {
return ...
}
}
5. 接下来要读什么
如果您对构建工具插件的工作原理感兴趣，可以查看spring-boot-tools模块。
附录中介绍了可执行 jar 格式的更多技术细节。
如果您有与构建相关的具体问题，请参阅“作方法”指南。