VIII. Spring Boot Maven插件

最新推荐文章于 2024-09-10 19:08:00 发布

无门关·平常是道

最新推荐文章于 2024-09-10 19:08:00 发布

阅读量5.7k

点赞数

分类专栏： SpringBoot 文章标签： spring SpringBoot 微服务

SpringBoot 专栏收录该内容

10 篇文章 1 订阅

订阅专栏

构建工具插件

Spring Boot为Maven和Gradle提供构建工具插件。该插件提供各种各样的特性，包括打包可执行jars。本节提供关于插件的更多详情及用于扩展一个不支持的构建系统所需的帮助信息。如果你是刚刚开始，那可能需要先阅读Part III, “Using Spring Boot”章节的“Chapter 13, Build systems”。

Spring Boot Maven插件

Spring Boot Maven插件为Maven提供Spring Boot支持，它允许你打包可执行jar或war存档，然后就地运行应用。为了使用它，你需要使用Maven 3.2 （或更高版本）。

注：参考Spring Boot Maven Plugin Site可以获取全部的插件文档。

包含该插件

想要使用Spring Boot Maven插件只需简单地在你的pom.xml的plugins部分包含相应的XML：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!-- ... -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>1.3.0.BUILD-SNAPSHOT</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

该配置会在Maven生命周期的package阶段重新打包一个jar或war。下面的示例显示在target目录下既有重新打包后的jar，也有原始的jar：

$ mvn package
$ ls target/*.jar
target/myproject-1.0.0.jar target/myproject-1.0.0.jar.original

如果不包含像上面那样的<execution/>，你可以自己运行该插件（但只有在package目标也被使用的情况）。例如：

$ mvn package spring-boot:repackage
$ ls target/*.jar
target/myproject-1.0.0.jar target/myproject-1.0.0.jar.original

如果使用一个里程碑或快照版本，你还需要添加正确的pluginRepository元素：

<pluginRepositories>
    <pluginRepository>
        <id>spring-snapshots</id>
        <url>http://repo.spring.io/snapshot</url>
    </pluginRepository>
    <pluginRepository>
        <id>spring-milestones</id>
        <url>http://repo.spring.io/milestone</url>
    </pluginRepository>
</pluginRepositories>

打包可执行jar和war文件

一旦spring-boot-maven-plugin被包含到你的pom.xml中，它就会自动尝试使用spring-boot:repackage目标重写存档以使它们能够执行。为了构建一个jar或war，你应该使用常规的packaging元素配置你的项目：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <!-- ... -->
    <packaging>jar</packaging>
    <!-- ... -->
</project>

生成的存档在package阶段会被Spring Boot增强。你想启动的main类即可以通过指定一个配置选项，也可以通过为manifest添加一个Main-Class属性这种常规的方式实现。如果你没有指定一个main类，该插件会搜索带有public static void main(String[] args)方法的类。

为了构建和运行一个项目的artifact，你可以输入以下命令：

$ mvn package
$ java -jar target/mymodule-0.0.1-SNAPSHOT.jar

为了构建一个即是可执行的，又能部署到一个外部容器的war文件，你需要标记内嵌容器依赖为”provided”，例如：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <!-- ... -->
    <packaging>war</packaging>
    <!-- ... -->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <scope>provided</scope>
        </dependency>
        <!-- ... -->
    </dependencies>
</project>

注：具体参考“Section 74.1, “Create a deployable war file”” 章节。

在插件信息页面有高级的配置选项和示例。

Spring Boot Gradle插件

Spring Boot Gradle插件为Gradle提供Spring Boot支持，它允许你打包可执行jar或war存档，运行Spring Boot应用，对于”神圣的”依赖可以在你的build.gradle文件中省略版本信息。

包含该插件

想要使用Spring Boot Gradle插件，你只需简单的包含一个buildscript依赖，并应用spring-boot插件：

buildscript {
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:1.3.0.BUILD-SNAPSHOT")
    }
}
apply plugin: 'spring-boot'

如果想使用一个里程碑或快照版本，你可以添加相应的repositories引用：

buildscript {
    repositories {
        maven.url "http://repo.spring.io/snapshot"
        maven.url "http://repo.spring.io/milestone"
    }
    // ...
}

声明不带版本的依赖

spring-boot插件会为你的构建注册一个自定义的Gradle ResolutionStrategy，它允许你在声明对”神圣”的artifacts的依赖时获取版本号。为了充分使用该功能，只需要想通常那样声明依赖，但将版本号设置为空：

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compile("org.thymeleaf:thymeleaf-spring4")
    compile("nz.net.ultraq.thymeleaf:thymeleaf-layout-dialect")
}

注：你声明的spring-boot Gradle插件的版本决定了”blessed”依赖的实际版本（确保可以重复构建）。你最好总是将spring-boot gradle插件版本设置为你想用的Spring Boot实际版本。提供的版本详细信息可以在附录中找到。

spring-boot插件对于没有指定版本的依赖只会提供一个版本。如果不想使用插件提供的版本，你可以像平常那样在声明依赖的时候指定版本。例如：

dependencies {
    compile("org.thymeleaf:thymeleaf-spring4:2.1.1.RELEASE")
}

自定义版本管理

如果你需要不同于Spring Boot的”blessed”依赖，有可能的话可以自定义ResolutionStrategy使用的版本。替代的版本元数据使用versionManagement配置。例如：

dependencies {
    versionManagement("com.mycorp:mycorp-versions:1.0.0.RELEASE@properties")
    compile("org.springframework.data:spring-data-hadoop")
}

版本信息需要作为一个.properties文件发布到一个仓库中。对于上面的示例，mycorp-versions.properties文件可能包含以下内容：

org.springframework.data\:spring-data-hadoop=2.0.0.RELEASE

属性文件优先于Spring Boot默认设置，如果有必要的话可以覆盖版本号。

默认排除规则

Gradle处理”exclude rules”的方式和Maven稍微有些不同，在使用starter POMs时这可能会引起无法预料的结果。特别地，当一个依赖可以通过不同的路径访问时，对该依赖声明的exclusions将不会生效。例如，如果一个starter POM声明以下内容：

<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>4.0.5.RELEASE</version>
        <exclusions>
            <exclusion>
                <groupId>commons-logging</groupId>
                <artifactId>commons-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>4.0.5.RELEASE</version>
    </dependency>
</dependencies>

commons-logging jar不会被Gradle排除，因为通过没有exclusion元素的spring-context可以传递性的拉取到它（spring-context → spring-core → commons-logging）。

为了确保正确的排除被实际应用，Spring Boot Gradle插件将自动添加排除规则。所有排除被定义在spring-boot-dependencies POM，并且针对”starter” POMs的隐式规则也会被添加。

如果不想自动应用排除规则，你可以使用以下配置：

springBoot {
    applyExcludeRules=false
}

打包可执行jar和war文件

一旦spring-boot插件被应用到你的项目，它将使用bootRepackage任务自动尝试重写存档以使它们能够执行。为了构建一个jar或war，你需要按通常的方式配置项目。

你想启动的main类既可以通过一个配置选项指定，也可以通过向manifest添加一个Main-Class属性。如果你没有指定main类，该插件会搜索带有public static void main(String[] args)方法的类。

为了构建和运行一个项目artifact，你可以输入以下内容：

$ gradle build
$ java -jar build/libs/mymodule-0.0.1-SNAPSHOT.jar

为了构建一个即能执行也可以部署到外部容器的war包，你需要将内嵌容器依赖标记为”providedRuntime”，比如：

...
apply plugin: 'war'

war {
    baseName = 'myapp'
    version =  '0.5.0'
}

repositories {
    jcenter()
    maven { url "http://repo.spring.io/libs-snapshot" }
}

configurations {
    providedRuntime
}

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    providedRuntime("org.springframework.boot:spring-boot-starter-tomcat")
    ...
}

注：具体参考“Section 74.1, “Create a deployable war file””。

就地（in-place）运行项目

为了在不先构建jar的情况下运行项目，你可以使用”bootRun”任务：

$ gradle bootRun

默认情况下，以这种方式运行项目可以让你的静态classpath资源（比如，默认位于src/main/resources下）在应用运行期间被重新加载。使静态资源可以重新加载意味着bootRun任务不会使用processResources任务的输出，比如，当调用bootRun时，你的应用将以资源未处理的形式来使用它们。

你可以禁止直接使用静态classpath资源。这意味着资源不再是可重新加载的，但processResources任务的输出将会被使用。想要这样做，只需将bootRun任务的addResources设为false：

bootRun {
    addResources = false
}

Spring Boot插件配置

Gradle插件自动扩展你的构建脚本DSL，它为脚本添加一个springBoot元素以此作为Boot插件的全局配置。你可以像配置其他Gradle扩展那样为springBoot设置相应的属性（下面有配置选项列表）。

springBoot {
    backupSource = false
}

Repackage配置

该插件添加了一个bootRepackage任务，你可以直接配置它，比如：

bootRepackage {
    mainClass = 'demo.Application'
}

下面是可用的配置选项：

名称	描述
enabled	布尔值，用于控制repackager的开关（如果你只想要Boot的其他特性而不是这个，那它就派上用场了）
mainClass	要运行的main类。如果没有指定，则使用project属性`mainClassName`。如果没有定义`mainClassName` id，则搜索存档以寻找一个合适的类。”合适”意味着一个唯一的，具有良好格式的`main()`方法的类（如果找到多个则构建会失败）。你也可以通过”run”任务（`main`属性）指定main类的名称，和/或将”startScripts”（`mainClassName`属性）作为”springBoot”配置的替代。
classifier	添加到存档的一个文件名字段（在扩展之前），这样最初保存的存档仍旧存放在最初的位置。在存档被重新打包（repackage）的情况下，该属性默认为null。默认值适用于多数情况，但如果你想在另一个项目中使用原jar作为依赖，最好使用一个扩展来定义该可执行jar
withJarTask	`Jar`任务的名称或值，用于定位要被repackage的存档
customConfiguration	自定义配置的名称，用于填充内嵌的lib目录（不指定该属性，你将获取所有编译和运行时依赖）

* 使用Gradle自定义配置进行Repackage

有时候不打包解析自compile，runtime和provided作用域的默认依赖可能更合适些。如果创建的可执行jar被原样运行，你需要将所有的依赖内嵌进该jar中；然而，如果目的是explode一个jar文件，并手动运行main类，你可能在CLASSPATH下已经有一些可用的库了。在这种情况下，你可以使用不同的依赖集重新打包（repackage）你的jar。

使用自定义的配置将自动禁用来自compile，runtime和provided作用域的依赖解析。自定义配置即可以定义为全局的（处于springBoot部分内），也可以定义为任务级的。

task clientJar(type: Jar) {
    appendix = 'client'
    from sourceSets.main.output
    exclude('**/*Something*')
}

task clientBoot(type: BootRepackage, dependsOn: clientJar) {
    withJarTask = clientJar
    customConfiguration = "mycustomconfiguration"
}

在以上示例中，我们创建了一个新的clientJar Jar任务从你编译后的源中打包一个自定义文件集。然后我们创建一个新的clientBoot BootRepackage任务，并让它使用clientJar任务和mycustomconfiguration。

configurations {
    mycustomconfiguration.exclude group: 'log4j'
}

dependencies {
    mycustomconfiguration configurations.runtime
}

在BootRepackage中引用的配置是一个正常的Gradle配置。在上面的示例中，我们创建了一个新的名叫mycustomconfiguration的配置，指示它来自一个runtime，并排除对log4j的依赖。如果clientBoot任务被执行，重新打包的jar将含有所有来自runtime作用域的依赖，除了log4j jars。

配置选项

可用的配置选项如下：

名称	描述
mainClass	可执行jar运行的main类
providedConfiguration	provided配置的名称（默认为providedRuntime）
backupSource	在重新打包之前，原先的存档是否备份（默认为true）
customConfiguration	自定义配置的名称
layout	存档类型，对应于内部依赖是如何制定的（默认基于存档类型进行推测）
requiresUnpack	一个依赖列表（格式为”groupId:artifactId”，为了运行，它们需要从fat jars中解压出来。）所有节点被打包进胖jar，但运行的时候它们将被自动解压

* 理解Gradle插件是如何工作的

当spring-boot被应用到你的Gradle项目，一个默认的名叫bootRepackage的任务被自动创建。bootRepackage任务依赖于Gradle assemble任务，当执行时，它会尝试找到所有限定符为空的jar artifacts（也就是说，tests和sources jars被自动跳过）。

由于bootRepackage查找’所有’创建jar artifacts的事实，Gradle任务执行的顺序就非常重要了。多数项目只创建一个单一的jar文件，所以通常这不是一个问题。然而，如果你正打算创建一个更复杂的，使用自定义jar和BootRepackage任务的项目setup，有几个方面需要考虑。

如果’仅仅’从项目创建自定义jar文件，你可以简单地禁用默认的jar和bootRepackage任务：

jar.enabled = false
bootRepackage.enabled = false

另一个选项是指示默认的bootRepackage任务只能使用一个默认的jar任务：

bootRepackage.withJarTask = jar

如果你有一个默认的项目setup，在该项目中，主（main）jar文件被创建和重新打包。并且，你仍旧想创建额外的自定义jars，你可以将自定义的repackage任务结合起来，然后使用dependsOn，这样bootJars任务就会在默认的bootRepackage任务执行以后运行：

task bootJars
bootJars.dependsOn = [clientBoot1,clientBoot2,clientBoot3]
build.dependsOn(bootJars)

上面所有方面经常用于避免一个已经创建的boot jar又被重新打包的情况。重新打包一个存在的boot jar不是什么大问题，但你可能会发现它包含不必要的依赖。

使用Gradle将artifacts发布到一个Maven仓库

如果你声明依赖但没有指定版本，且你想要将artifacts发布到一个Maven仓库，那你需要使用详细的Spring Boot依赖管理来配置Maven发布。通过配置它发布继承自spring-boot-starter-parent的poms或引入来自spring-boot-dependencies的依赖管理可以实现该需求。这种配置的具体细节取决于你如何使用Gradle及如何发布该artifacts的。

自定义Gradle，用于产生一个继承依赖管理的pom

下面示例展示了如何配置Gradle去产生一个继承自spring-boot-starter-parent的pom。请参考Gradle用户指南获取更多信息。

uploadArchives {
    repositories {
        mavenDeployer {
            pom {
                project {
                    parent {
                        groupId "org.springframework.boot"
                        artifactId "spring-boot-starter-parent"
                        version "1.3.0.BUILD-SNAPSHOT"
                    }
                }
            }
        }
    }
}

自定义Gradle，用于产生一个导入依赖管理的pom

以下示例展示了如何配置Gradle去产生一个导入spring-boot-dependencies提供的依赖管理的pom。请参考Gradle用户指南获取更多信息。

uploadArchives {
    repositories {
        mavenDeployer {
            pom {
                project {
                    dependencyManagement {
                        dependencies {
                            dependency {
                                groupId "org.springframework.boot"
                                artifactId "spring-boot-dependencies"
                                version "1.3.0.BUILD-SNAPSHOT"
                                type "pom"
                                scope "import"
                            }
                        }
                    }
                }
            }
        }
    }
}

对其他构建系统的支持

如果想使用除了Maven和Gradle之外的构建工具，你可能需要开发自己的插件。可执行jars需要遵循一个特定格式，并且一些实体需要以不压缩的方式写入（详情查看附录中的可执行jar格式章节）。

Spring Boot Maven和Gradle插件都利用spring-boot-loader-tools来实际地产生jars。如果需要，你也可以自由地直接使用该库。

重新打包存档

使用org.springframework.boot.loader.tools.Repackager可以将一个存在的存档重新打包，这样它就变成一个自包含的可执行存档。Repackager类需要提供单一的构造器参数，它引用一个存在的jar或war包。使用两个可用的repackage()方法中的一个来替换原始的文件或写入一个新的目标。在repackager运行前还可以设置各种配置。

内嵌的库

当重新打包一个存档时，你可以使用org.springframework.boot.loader.tools.Libraries接口来包含对依赖文件的引用。在这里我们不提供任何该Libraries接口的具体实现，因为它们通常跟具体的构建系统相关。

如果你的存档已经包含libraries，你可以使用Libraries.NONE。

查找main类

如果你没有使用Repackager.setMainClass()指定一个main类，该repackager将使用ASM去读取class文件，然后尝试查找一个合适的，具有public static void main(String[] args)方法的类。如果发现多个候选者，将会抛出异常。

repackage实现示例

这里是一个传统的repackage示例：

Repackager repackager = new Repackager(sourceJarFile);
repackager.setBackupSource(false);
repackager.repackage(new Libraries() {
            @Override
            public void doWithLibraries(LibraryCallback callback) throws IOException {
                // Build system specific implementation, callback for each dependency
                // callback.library(new Library(nestedFile, LibraryScope.COMPILE));
            }
        });