Maven 花式玩法之多模块项目

如果你有一个多模块项目,并且想将这些模块发布到不同的仓库或目标位置,你可以使用Maven的分发管理功能。

通过在父项目的pom.xml文件中配置<distributionManagement>元素,你可以指定不同模块的发布目标。

一、认识Maven多模块项目

Maven 多模块项目是指将一个大型项目拆分为多个模块进行管理和构建的项目结构。每个模块可以独立开发、测试和构建,同时也可以依赖其他模块。这种项目结构有助于提高项目的可维护性、可扩展性和复用性。

Maven 多模块项目的概念和结构包括五个方面:

graph LR A(Maven多模块项目概念和结构) B(父项目) C(子模块) D(目录结构) E(依赖管理) F(构建顺序) A ---> B A ---> C A ---> D A ---> E A ---> F style B fill:#FFC0CB,stroke:#FFC0CB,stroke-width:2px style C fill:#FFA07A,stroke:#FFA07A,stroke-width:2px style D fill:#FFFFE0,stroke:#FFFFE0,stroke-width:2px style E fill:#98FB98,stroke:#98FB98,stroke-width:2px style F fill:#B2FFFF,stroke:#B2FFFF,stroke-width:2px
  • 父项目(Parent Project) :通常是多模块项目的最上层,它定义了整个项目的基本配置共享的依赖管理。父项目会包含一个 pom.xml 文件,其中声明了子模块的列表和其他公共配置

  • 子模块(Module) :每个子模块代表项目中的一个独立单元,如一个模块、一个组件、一个子系统等。每个子模块都是一个独立的 Maven 项目,有自己的目录结构和 pom.xml 文件。子模块可以相互依赖,形成模块间的关系。

  • 目录结构Maven 多模块项目的目录结构如下所示:

  • 依赖管理 :父项目负责管理所有子模块的依赖关系。在父项目的 pom.xml 文件中,可以声明一组公共依赖和插件,并且子模块可以继承这些配置。这样可以确保子模块之间的依赖版本一致,减少重复配置的工作。

  • 构建顺序 :多模块项目的构建顺序由父项目的 pom.xml 文件中的 元素决定。Maven 会按照 <modules> 中声明的顺序依次构建各个子模块,确保构建过程中的依赖关系正确。

二、maven如何定义项目的发布策略

Maven 通过使用插件和配置文件来定义项目的发布策略。项目的发布策略包括了构建、版本管理、部署和发布等方面的规则和流程。

下面介绍一下 Maven 中常用的发布策略的定义方式:

graph LR A(Maven发布策略的定义方式) B(版本管理) C(构建配置) D(部署和发布) E(依赖管理) F(发布流程) A ---> B A ---> C A ---> D A ---> E A ---> F style B fill:#FFC0CB,stroke:#FFC0CB,stroke-width:2px style C fill:#FFA07A,stroke:#FFA07A,stroke-width:2px style D fill:#FFFFE0,stroke:#FFFFE0,stroke-width:2px style E fill:#98FB98,stroke:#98FB98,stroke-width:2px style F fill:#B2FFFF,stroke:#B2FFFF,stroke-width:2px

2.1 版本管理

Maven 使用语义化版本号(Semantic Versioning)来管理项目的版本。通过在项目的 pom.xml 文件中定义 <version> 元素,可以指定项目的版本号。根据版本号的规则,可以确定发布的策略,如何升级版本、何时发布稳定版本等。

  • 在项目的 pom.xml 文件中,指定项目的版本号:
xml 复制代码
<version>1.0.0</version>
  • 可以使用 Maven Release 插件来管理版本的发布和升级。例如,执行以下命令将项目版本升级为 1.0.1:
shell 复制代码
mvn release:update-versions -DautoVersionSubmodules=true -DdevelopmentVersion=1.0.1-SNAPSHOT

该命令可以在idea直接执行的

2.2 构建配置

Maven 使用插件来执行各种构建任务,如编译代码、运行测试、生成文档等。通过在项目的 pom.xml 文件中配置插件和执行目标(Goals),可以定义项目的构建策略。可以指定构建的生命周期阶段,以及在每个阶段执行的插件和目标。

  • 在项目的 pom.xml 文件中,配置构建插件和目标:
xml 复制代码
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.8.1</version>
      <configuration>
        <!-- 配置编译参数 -->
      </configuration>
    </plugin>
  </plugins>
</build>
  • 可以使用 Maven Surefire 插件执行项目的测试:
shell 复制代码
mvn test

2.3 部署和发布

Maven 提供了插件来支持项目的部署和发布到不同的目标环境,如本地仓库、远程仓库、应用服务器等。通过配置插件和目标,可以定义项目的部署策略,包括目标环境的地址、认证信息、部署方式等。

  • 在项目的 pom.xml 文件中,配置部署插件和目标:
xml 复制代码
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-deploy-plugin</artifactId>
      <version>3.0.0-M1</version>
      <configuration>
        <!-- 配置部署目标环境 -->
      </configuration>
    </plugin>
  </plugins>
</build>
  • 可以使用 Maven Deploy 插件将项目发布到远程仓库:
shell 复制代码
mvn deploy

2.4 依赖管理

Maven 使用依赖管理功能来管理项目的依赖库。通过在项目的 pom.xml 文件中定义 <dependencies> 元素,可以指定项目所依赖的外部库和其版本号。可以定义依赖的范围(如编译时依赖、测试时依赖等)、传递性依赖的规则等,以确保项目的构建和发布的稳定性和一致性。

  • 在项目的 pom.xml 文件中,定义项目的依赖库:
xml 复制代码
<dependencies>
  <dependency>
    <groupId>com.example</groupId>
    <artifactId>my-library</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
  </dependency>
</dependencies>
  • 可以使用 Maven Dependency 插件来分析项目的依赖关系:
shell 复制代码
mvn dependency:tree

2.5 发布流程

Maven 提供了插件和配置文件来定义项目的发布流程。可以使用插件来执行特定的操作,如打包、压缩、签名等。通过配置文件,可以指定发布的目标、发布前的准备工作、发布后的验证和清理等步骤,以确保发布过程的可靠性和一致性。

  • 在项目的 pom.xml 文件中,配置插件和目标来定义发布流程:
xml 复制代码
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
      <version>3.3.0</version>
      <configuration>
        <!-- 配置打包和发布的步骤 -->
      </configuration>
    </plugin>
  </plugins>
</build>
  • 可以使用 Maven Assembly 插件来生成发布所需的打包文件:
shell 复制代码
mvn assembly:assembly

三、使用Jenkins持续集成Maven项目

注意:使用 Jenkins 持续集成 Maven 项目,是所有的 Maven 项目都可以,不止是多模块的才行

以下是使用 Jenkins 持续集成 Maven 项目的一般步骤:

graph TD A[下载并安装Jenkins服务器] --> B[访问Jenkins的Web界面] B --> C[解锁Jenkins并创建管理员用户] B --> D[安装所需的插件] C --> E[配置Maven] D --> E E --> F[创建Jenkins Job] F --> G[配置代码仓库和认证信息] G --> H[配置构建触发器] H --> I[配置构建环境] I --> J[配置构建步骤] J --> K[配置构建后操作] K --> L[保存配置] L --> M[启动构建]

1、确保已经按照上述提到的步骤安装和配置了 Jenkins 服务器。

2、在 Jenkins 的主界面上,点击New Item创建一个新的Jenkins Job

3、输入Job的名称,并选择Freestyle project作为项目类型。

4、在配置页面的General部分,可以设置项目的描述和其他基本信息。

5、在配置页面的Source Code Management部分,选择你的代码仓库,如GitHub或Bitbucket,并配置相关的认证信息。可以选择使用Git、Subversion等版本控制工具。

6、在配置页面的Build Triggers部分,选择适当的构建触发器。常见的触发器包括定时触发器(如每天定时构建)、代码提交触发器(如有代码提交时触发构建)或轮询SCM触发器(定期轮询代码仓库以检查是否有新的提交)。

7、在配置页面的Build Environment部分,选择Maven。这将启用Maven构建环境。

8、配置Maven相关的参数,如Maven版本、Maven选项等。可以指定全局的Maven安装路径或使用自动安装。

9、在配置页面的Build部分,点击Add build step,选择Maven。这将添加一个Maven构建步骤。

10、配置Maven构建的命令,如clean、compile、test等。可以指定需要执行的Maven目标或自定义的命令。

11、在配置页面的Post-build Actions部分,选择适当的操作,如构建报告的存档、发送邮件通知等。可以根据需要添加多个后续操作。

12、点击配置页面底部的Save按钮保存配置。

13、在Jenkins的主界面上,找到你创建的Jenkins Job,并点击Build Now开始构建过程。Jenkins将按照配置的构建步骤执行Maven项目的构建。

14、构建完成后,可以在构建历史记录中查看构建结果和日志输出,进行故障排查和分析。

四、总结

Maven多模块的发布使得项目的管理、构建和部署更加灵活、高效和可维护。它提供了一种组织和管理复杂应用程序的有效方式,同时也促进了代码的重用和模块的解耦,提高了开发团队的效率和项目的质量。提高了代码结构清晰度、可维护性,加快了部署速度,并促进了代码的复用。

希望本文对您有所帮助。如果有任何错误或建议,请随时指正和提出。

同时,如果您觉得这篇文章有价值,请考虑点赞和收藏。这将激励我进一步改进和创作更多有用的内容。

感谢您的支持和理解!

相关推荐
kirito学长-Java几秒前
springboot/ssm网上宠物店系统Java代码编写web宠物用品商城项目
java·spring boot·后端
海绵波波1078 分钟前
flask后端开发(9):ORM模型外键+迁移ORM模型
后端·python·flask
余生H12 分钟前
前端Python应用指南(二)深入Flask:理解Flask的应用结构与模块化设计
前端·后端·python·flask·全栈
木头没有瓜15 分钟前
ruoyi 请求参数类型不匹配,参数[giftId]要求类型为:‘java.lang.Long‘,但输入值为:‘orderGiftUnionList
android·java·okhttp
奋斗的老史15 分钟前
Spring Retry + Redis Watch实现高并发乐观锁
java·redis·spring
high201117 分钟前
【Java 基础】-- ArrayList 和 Linkedlist
java·开发语言
老马啸西风24 分钟前
NLP 中文拼写检测纠正论文 C-LLM Learn to CSC Errors Character by Character
java
Cosmoshhhyyy1 小时前
LeetCode:3083. 字符串及其反转中是否存在同一子字符串(哈希 Java)
java·leetcode·哈希算法
AI人H哥会Java1 小时前
【Spring】基于XML的Spring容器配置——<bean>标签与属性解析
java·开发语言·spring boot·后端·架构