支持其他构建系统

如果您想使用 Maven、Gradle 或 Ant 之外的构建工具,您可能需要开发自己的插件。可执行 jar 需要遵循特定格式,并且某些条目需要以未压缩的形式写入(详情请参见附录中的可执行 jar 格式一节)。

Spring Boot 的 Maven 和 Gradle 插件都使用 spring-boot-loader-tools 库来实际生成 jar。如果需要,您可以直接使用此库。

重新打包归档

要将现有归档重新打包成一个自包含的可执行归档,请使用 RepackagerRepackager 类接受一个构造函数参数,该参数指向现有的 jar 或 war 归档。使用两个可用的 repackage() 方法之一来替换原始文件或写入新目标位置。在运行 repackager 之前,还可以配置各种设置。

嵌套库

重新打包归档时,您可以使用 Libraries 接口来包含对依赖文件的引用。由于具体的实现通常取决于构建系统,我们在此不提供 Libraries 的具体实现。

如果您的归档已经包含库,您可以使用 Libraries.NONE

查找主类

如果您不使用 Repackager.setMainClass() 来指定主类,repackager 会使用 ASM 读取类文件并尝试查找具有 public static void main(String[] args) 方法的合适类。如果找到多个候选类,则会抛出异常。

Repackage 实现示例

以下示例展示了一个典型的 repackage 实现

  • Java

  • Kotlin

import java.io.File;
import java.io.IOException;
import java.util.List;

import org.springframework.boot.loader.tools.Library;
import org.springframework.boot.loader.tools.LibraryCallback;
import org.springframework.boot.loader.tools.LibraryScope;
import org.springframework.boot.loader.tools.Repackager;

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 ...
	}

}
import org.springframework.boot.loader.tools.Library
import org.springframework.boot.loader.tools.LibraryCallback
import org.springframework.boot.loader.tools.LibraryScope
import org.springframework.boot.loader.tools.Repackager
import java.io.File
import java.io.IOException

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  ...
	}

}