Spring Boot 构建工具插件

这篇具有很好参考价值的文章主要介绍了Spring Boot 构建工具插件。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

本文为官方文档直译版本。原文链接

引言

Spring Boot 为 Maven 和 Gradle 提供了构建工具插件。这些插件提供多种功能,包括打包可执行 jar。本节将提供有关这两个插件的更多详细信息,并在您需要扩展不支持的构建系统时提供一些帮助。如果你刚刚入门,不妨先阅读 “using.html” 部分的 “using.html”。

Spring Boot Maven Plugin

Spring Boot Maven Plugin 在 Maven 中提供 Spring Boot 支持,让您可以打包可执行 jar 或 war 存档并 “就地” 运行应用程序。要使用该插件,您必须使用 Maven 3.6.3 或更高版本。
如需了解更多信息,请参阅插件文档:

  • 参考资料(HTML 和 PDF)
  • API

Spring Boot Gradle Plugin

Spring Boot Gradle Plugin 在 Gradle 中提供对 Spring Boot 的支持,让你可以打包可执行的 jar 或 war 归档,运行 Spring Boot 应用程序,并使用 spring-boot-dependencies 提供的依赖关系管理。它需要 Gradle 7.x (7.5 或更高版本)或 8.x。欲了解更多信息,请参阅插件文档:

  • 参考资料(HTML 和 PDF)
  • API

Spring Boot AntLib 模块

Spring Boot AntLib 模块为 Apache Ant 提供基本的 Spring Boot 支持。您可以使用该模块创建可执行 jar。要使用该模块,需要在 build.xml 中声明一个额外的 spring-boot 命名空间,如下例所示:

<project xmlns:ivy="antlib:org.apache.ivy.ant"
    xmlns:spring-boot="antlib:org.springframework.boot.ant"
    name="myapp" default="build">
    ...
</project>

请记住使用 -lib 选项启动 Ant,如下例所示:

$ ant -lib <directory containing spring-boot-antlib-3.2.1.jar>

在 “使用 Spring Boot” 一节中,包含了一个将 Apache Ant 与 spring-boot-antlib 结合使用的更完整示例。

Spring Boot Ant 任务

一旦声明了 spring-boot-antlib 命名空间,就可以执行以下附加任务:

  • 使用 “exejar” 任务
  • 使用 “findmainclass” 任务

使用 “exejar” 任务

您可以使用 exejar 任务创建 Spring Boot 可执行 jar。该任务支持以下属性:

属性 描述 必填
destfile 要创建的目标 jar 文件 Yes
classes Java 类文件根目录 Yes
start-class 要运行的主程序类 No (默认情况是找到的第一个声明了主方法的类)

以下嵌套元素可与任务一起使用:

元素 描述
resources 一个或多个资源集,描述了应添加到已创建 jar 文件内容中的一组资源。
lib 一个或多个资源集,应添加到构成应用程序运行时依赖类路径的 jar 库集合中。

示例

本节展示两个 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>

使用 “findmainclass” 任务

exejar 内部使用 findmainclass 任务来查找声明 main 的类。如有必要,您也可以在构建过程中直接使用该任务。支持以下属性:

属性 描述 必填
classesroot Java 类文件根目录 Yes (除非指定了 _mainclass_)
mainclass 可用于短路主类搜索 No
property 应根据结果设置的 Ant 属性 No (如果未指定,结果将被记录)

例子

本节包含三个使用 findmainclass 的示例。

<findmainclass classesroot="target/classes" />
<findmainclass classesroot="target/classes" property="main-class" />
<findmainclass mainclass="com.example.MainClass" property="main-class" />

支持其它构建系统

如果想使用 Maven、Gradle 或 Ant 以外的构建工具,可能需要开发自己的插件。可执行 jar 需要遵循特定的格式,某些条目需要以未压缩的形式编写(详情请参见附录中的 “可执行 jar 格式” 部分)。
Spring Boot Maven 和 Gradle 插件都使用 spring-boot-loader-tools 来实际生成 jar。如果需要,可以直接使用该库。

重新包装档案

要重新打包现有存档,使其成为独立的可执行存档,请使用 org.springframework.boot.loader.tools.RepackagerRepackager 类需要一个构造函数参数,该参数指向现有的 jar 或 war 压缩包。使用两个可用的 repackage() 方法之一替换原始文件或写入新目标。在运行 Repackager 之前,还可以对其进行各种设置。

嵌套库

重新打包归档文件时,您可以使用 org.springframework.boot.loader.tools.Libraries 接口来引用依赖文件。我们在此不提供任何 Libraries 的具体实现,因为它们通常是特定于构建系统的。
如果您的存档已包含库,您可以使用 Libraries.NONE

查找主类

如果不使用 Repackager.setMainClass() 指定主类,重新打包程序会使用 ASM 读取类文件,并尝试使用 public static void main(String[] args) 方法查找合适的类。如果找到的候选类超过一个,就会出现异常。

重新打包实现例子

下面的示例展示了一个典型的重新打包实现过程:文章来源地址https://www.toymoban.com/news/detail-813718.html

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

}

到了这里,关于Spring Boot 构建工具插件的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 微信小程序的授权登录-Java 后端 (Spring boot)

    微信开发文档链接:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html 一个可以测试的微信小程序 此微信小程序的APPID和APPscret(至开发者后台获取) 从时序图我们可以了解到流程大致分为两步: 小程序端获取code后传给Java后台 Java后台获取code后向微信后台接口

    2024年02月09日
    浏览(51)
  • Spring Boot:轻松构建Java应用程序

    Spring Boot 是一个用于简化Spring应用程序开发的框架。通过自动配置和提供各种生产级功能,Spring Boot帮助开发者更快速、更简单地构建基于Spring的应用程序。在这篇博客中,我们将探讨Spring Boot的特点以及如何开始使用它。 Spring Boot 的主要优势在于它简化了Spring应用程序的开

    2024年02月01日
    浏览(43)
  • “从零开始学习Spring Boot:快速搭建Java后端开发环境“

    标题:从零开始学习Spring Boot:快速搭建Java后端开发环境 摘要:本文将介绍如何从零开始学习Spring Boot,并详细讲解如何快速搭建Java后端开发环境。通过本文的指导,您将能够快速搭建一个基于Spring Boot的Java后端开发环境并开始编写代码。 正文: 一、准备工作 在开始之前,

    2024年02月15日
    浏览(55)
  • 入门Spring Boot:快速构建Java应用的利器

    Spring Boot是由Pivotal团队开发的开源框架,它基于Spring框架,旨在简化Java应用程序的开发过程。它提供了一种约定大于配置的方式,通过自动配置和起步依赖(Starter Dependencies)来消除繁琐的配置,从而使开发者能够更快地构建独立、可执行的、生产级的Spring应用。 与传统的

    2024年02月07日
    浏览(46)
  • 精通Spring Boot单元测试:构建健壮的Java应用

    在当今软件开发领域,单元测试已经成为确保应用质量和可维护性的关键步骤。特别是在Java生态系统中,Spring Boot框架作为一种广泛应用的解决方案,其对于单元测试的支持更是让开发者受益匪浅。本博客的目标是为开发者提供一份清晰易懂的指南,帮助他们利用Spring Boot框

    2024年03月15日
    浏览(60)
  • Spring Boot的魔法:构建高效Java应用的秘诀

    🎉欢迎来到架构设计专栏~Spring Boot的魔法:构建高效Java应用的秘诀 ☆* o(≧▽≦)o *☆嗨~我是IT·陈寒🍹 ✨博客主页:IT·陈寒的博客 🎈该系列文章专栏:架构设计 📜其他专栏:Java学习路线 Java面试技巧 Java实战项目 AIGC人工智能 数据结构学习 🍹文章作者技术和水平有限,

    2024年02月08日
    浏览(49)
  • 构建现代化的Java应用: 深入探讨Spring Boot实际应用

    Spring Boot 是一个快速构建基于 Spring 框架的应用程序的框架。它提供了自动配置、代码生成器和快速开发工具,使得创建现代化的 Java 应用程序变得非常容易。在这里,我们将深入探讨 Spring Boot 实际应用的一些关键方面。 1. 数据库访问: 2. Web 应用程序开发: 3. 安全性: 4

    2024年02月02日
    浏览(67)
  • “深入了解Spring Boot:构建高效、可扩展的Java应用程序“

    标题:深入了解Spring Boot:构建高效、可扩展的Java应用程序 摘要:Spring Boot是一款快速构建Java应用程序的开发框架,它基于Spring框架,提供了一系列的自动化配置和约定,使得开发者能够更快速、更高效地构建出高质量的应用程序。本文将深入探讨Spring Boot的核心特性和使用

    2024年02月14日
    浏览(54)
  • 构建现代化的Java应用:深入探讨Spring Boot实际应用

            Spring Boot作为Spring框架的一部分,是一款用于简化Java应用开发的框架。它通过提供约定大于配置的原则,使得开发者能够更加迅速、高效地搭建和部署应用。本文将深入探讨Spring Boot的实际应用场景,以及一些最佳实践,助力开发者更好地利用这一现代化的Java开发

    2024年02月03日
    浏览(77)
  • “深入理解Spring Boot:构建高效、可扩展的Java应用程序“

    标题:深入理解Spring Boot:构建高效、可扩展的Java应用程序 摘要:Spring Boot是一个用于构建Java应用程序的开源框架,它提供了一种简单且高效的方式来创建独立的、生产级别的应用程序。本文将深入探讨Spring Boot的核心概念和特性,并通过示例代码展示如何使用Spring Boot构建

    2024年02月15日
    浏览(61)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包