Maven最佳实践

server/2024/11/23 17:15:37/

Maven 是一种广泛使用的 Java 项目构建自动化工具。它简化了构建过程并帮助管理依赖关系,使开发人员的工作更轻松。

这篇文章不会涉及到 Maven 概念的介绍,主要讨论一些最佳实践、建议和技巧,以优化我们在项目中对 Maven 的使用并改善我们的开发体验。

Maven 标准目录结构


Maven 遵循标准目录结构来保持项目之间的一致性。遵循这种结构可以让其他开发人员更轻松地理解我们的项目。

Maven 项目的标准目录结构如下:

java">src/main/java/resources/test/java/resources/
pom.xml
  • src/main/java:源代码目录
  • src/main/resources:资源文件目录
  • src/test/java:测试代码目录
  • src/test/resources:测试资源文件目录

这只是一个最简单的 Maven 项目目录示例。实际项目中,我们还会根据项目规范去做进一步的细分。

指定 Maven 编译器插件


默认情况下,Maven 使用 Java5 编译我们的项目。要使用不同的 JDK 版本,请在 pom.xml 文件中配置 Maven 编译器插件。

例如,如果你想要使用 Java8 来编译你的项目,你可以在<build>标签下添加以下的代码片段:

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.8.1</version><configuration><source>1.8</source><target>1.8</target></configuration></plugin></plugins>
</build>

这样,Maven 就会使用 Java8 的编译器来编译你的项目。如果你想要使用其他版本的 JDK,你只需要修改<source><target>标签的值即可。例如,如果你想要使用 Java11,你可以将它们的值改为 11。

有效管理依赖关系


Maven 的依赖管理系统是其最强大的功能之一。在顶层 pom 文件中,通过标签 dependencyManagement 定义公共的依赖关系,这有助于避免冲突并确保所有模块使用相同版本的依赖项。

例如,假设我们有一个父模块和两个子模块 A 和 B,我们想要在所有模块中使用 JUnit 5.7.2 作为测试框架。我们可以在父模块的pom.xml文件中使用<dependencyManagement>标签来定义 JUnit 的版本:

<dependencyManagement><dependencies><dependency><groupId>org.junit.jupiter</groupId><artifactId>junit-jupiter</artifactId><version>5.7.2</version><scope>test</scope></dependency></dependencies>
</dependencyManagement>

在子模块 A 和 B 的 pom.xml 文件中,我们只需要引用 JUnit 的 groupId 和 artifactId 即可:

<dependencies><dependency><groupId>org.junit.jupiter</groupId><artifactId>junit-jupiter</artifactId></dependency>
</dependencies>

针对不同环境使用配置文件


Maven 配置文件允许我们配置不同环境的构建设置,例如开发、测试和生产。在 pom.xml 文件中定义配置文件并使用命令行参数激活它们:

<profiles><profile><id>development</id><activation><activeByDefault>true</activeByDefault></activation><properties><environment>dev</environment></properties></profile><profile><id>production</id><properties><environment>prod</environment></properties></profile>
</profiles>

使用命令行激活配置文件:

mvn clean install -P production

保持 pom.xml 干净且井然有序


组织良好的 pom.xml 文件更易于维护和理解。以下是维护干净的 pom.xml 的一些技巧:

  • 将相似的依赖项和插件组合在一起。
  • 使用注释来描述特定依赖项或插件的用途。
  • 将插件和依赖项的版本号保留在 <properties> 标签内以便于管理。
<properties><junit.version>5.7.0</junit.version><mockito.version>3.9.0</mockito.version>
</properties>

使用 Maven Wrapper


Maven Wrapper 是一个用于管理和使用 Maven 的工具,它允许在没有预先安装 Maven 的情况下运行和构建 Maven 项目。

Maven 官方文档是这样介绍 Maven Wrapper 的:

The Maven Wrapper is an easy way to ensure a user of your Maven build has everything necessary to run your Maven build.

Maven Wrapper 是一种简单的方法,可以确保 Maven 构建的用户拥有运行 Maven 构建所需的一切。

Maven Wrapper 可以确保构建过程使用正确的 Maven 版本,非常方便。要使用 Maven Wrapper,请在项目目录中运行以下命令:

mvn wrapper:wrapper

此命令会在我们的项目中生成 Maven Wrapper 文件。现在我们可以使用 ./mvnw (或 Windows 上的 ./mvnw.cmd)而不是 mvn 来执行 Maven 命令。

通过持续集成实现构建自动化


将 Maven 项目与持续集成 (CI) 系统(例如 Jenkins 或 GitHub Actions)集成,可确保自动构建、测试和部署我们的代码。CI 有助于及早发现问题并在整个团队中提供一致的构建流程。以下是 Maven 项目的简单 GitHub Actions 工作流程示例:

name: Java CI with Mavenon: [push]jobs:build:runs-on: ubuntu-lateststeps:- name: Checkout codeuses: actions/checkout@v2- name: Set up JDK 11uses: actions/setup-java@v2with:java-version: '11'distribution: 'adopt'- name: Build with Mavenrun: ./mvnw clean install

利用 Maven 插件获得附加功能


有许多 Maven 插件可用于扩展 Maven 的功能。一些流行的插件包括(前三个是 Maven 自带的插件,后三个是第三方提供的插件):

  • maven-surefire-plugin:配置并执行单元测试。
  • maven-failsafe-plugin:配置并执行集成测试。
  • maven-javadoc-plugin:生成 Javadoc 格式的项目文档。
  • maven-checkstyle-plugin:强制执行编码标准和最佳实践。
  • jacoco-maven-plugin: 单测覆盖率。
  • sonar-maven-plugin:分析代码质量。
  • ……

jacoco-maven-plugin 使用示例:

<build><plugins><plugin><groupId>org.jacoco</groupId><artifactId>jacoco-maven-plugin</artifactId><version>0.8.8</version><executions><execution><goals><goal>prepare-agent</goal></goals></execution><execution><id>generate-code-coverage-report</id><phase>test</phase><goals><goal>report</goal></goals></execution></executions></plugin></plugins>
</build>

如果这些已有的插件无法满足我们的需求,我们还可以自定义插件。

探索可用的插件并在 pom.xml 文件中配置它们以增强我们的开发过程。

总结


Maven 是一个强大的工具,可以简化 Java 项目的构建过程和依赖关系管理。通过遵循这些最佳实践和技巧,我们可以优化 Maven 的使用并改善我们的 Java 开发体验。请记住使用标准目录结构,有效管理依赖关系,利用不同环境的配置文件,并将项目与持续集成系统集成,以确保构建一致。


http://www.ppmy.cn/server/144312.html

相关文章

✅✅✅【Vue.js】sd.js基于jQuery Ajax最新原生完整版for凯哥API版本

api.js //封装ajax方法 import $g from "../sg";//vue项目使用 import $ from jquery;//(提示&#xff1a;原生开发页面请前往https://jquery.com下载最新版jQuery) import { Message } from "element-ui";//element项目使用 // import axios from "…

SpringDataNeo4j使用详解

SDN快速入门 Spring Data Neo4j简称SDN&#xff0c;是Spring对Neo4j数据库操作的封装&#xff0c;其底层基于neo4j-java-driver实现。 我们使用的版本为&#xff1a;6.2.3&#xff0c;官方文档&#xff1a; 下面我们将基于项目中的运输路线业务进行学习&#xff0c;例如&#…

Springboot之登录模块探索(含Token,验证码,网络安全等知识)

简介 登录模块很简单&#xff0c;前端发送账号密码的表单&#xff0c;后端接收验证后即可~ 淦&#xff01;可是我想多了&#xff0c;于是有了以下几个问题&#xff08;里面还包含网络安全问题&#xff09;&#xff1a; 1.登录时的验证码 2.自动登录的实现 3.怎么维护前后端…

Shell脚本基础(4):条件判断

内容预览 ≧∀≦ゞ Shell脚本基础&#xff08;4&#xff09;&#xff1a;条件判断声明导语基本的if语句结构数值比较运算符文件测试运算符扩展&#xff1a;使用elif和else使用&&和||结合条件判断小结 Shell脚本基础&#xff08;4&#xff09;&#xff1a;条件判断 声明…

ElasticSearch学习篇17_《检索技术核心20讲》最邻近检索-局部敏感哈希、乘积量化PQ思路

目录 场景在搜索引擎和推荐引擎中&#xff0c;对相似文章去重是一个非常重要的环节&#xff0c;另外是拍照识花、摇一摇搜歌等场景都可以使用它快速检索。 基于敏感性哈希的检索更擅长处理字面上的相似而不是语义上的相似。 向量空间模型ANN检索加速思路 局部敏感哈希编码 随…

linux之调度管理(11)-cpu动态调频总体架构

一、cpufreq的背景 随着技术的发展&#xff0c;当前soc中的cpu主频一般都超过了1Ghz&#xff0c;而cpu的主频越高&#xff0c;其消耗的功耗也越大&#xff0c;这主要体现在以下两个方面&#xff1a; &#xff08;1&#xff09;cpu的运行频率越高&#xff0c;则晶体管在单位时间…

macOS 无法安装第三方app,启用任何来源的方法

升级新版本 MacOS 后&#xff0c;安装下载的软件时&#xff0c;不能在 ”安全性与隐私” 中找不到 ”任何来源” 选项。 1. 允许展示任何来源 点击 启动器 (Launchpad) – 其他 (Other) – 终端 (Terminal)&#xff1a; 打开终端后&#xff0c;输入以下代码回车&#xff1a; …

Qt 实现网络数据报文大小端数据的收发

1.大小端数据简介 大小端&#xff08;Endianness&#xff09;是计算机体系结构的一个术语&#xff0c;它描述了多字节数据在内存中的存储顺序。以下是大小端的定义和它们的特点&#xff1a; 大端&#xff08;Big-Endian&#xff09; 在大端模式中&#xff0c;一个字的最高有效…