From 5782cb1851aed29ec4924dee86d7c78c5a2b6943 Mon Sep 17 00:00:00 2001 From: Guide Date: Fri, 15 Sep 2023 21:14:19 +0800 Subject: [PATCH] =?UTF-8?q?[docs=20add]Maven=E6=9C=80=E4=BD=B3=E5=AE=9E?= =?UTF-8?q?=E8=B7=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 3 +- docs/.vuepress/sidebar/index.ts | 2 +- .../zhishixingqiu-two-years.md | 4 +- docs/home.md | 3 +- docs/java/basis/reflection.md | 2 +- .../java-collection-precautions-for-use.md | 2 - docs/tools/maven/maven-best-practices.md | 233 ++++++++++++++++++ 7 files changed, 240 insertions(+), 9 deletions(-) create mode 100644 docs/tools/maven/maven-best-practices.md diff --git a/README.md b/README.md index 015bce2b..54b0010f 100755 --- a/README.md +++ b/README.md @@ -252,7 +252,8 @@ JVM 这部分内容主要参考 [JVM 虚拟机规范-Java8 ](https://docs.oracle ### Maven -[Maven 核心概念总结](./docs/tools/maven/maven-core-concepts.md) +- [Maven 核心概念总结](./docs/tools/maven/maven-core-concepts.md) +- [Maven 最佳实践](./docs/tools/maven/maven-best-practices.md) ### Gradle diff --git a/docs/.vuepress/sidebar/index.ts b/docs/.vuepress/sidebar/index.ts index 38f6f395..39397643 100644 --- a/docs/.vuepress/sidebar/index.ts +++ b/docs/.vuepress/sidebar/index.ts @@ -354,7 +354,7 @@ export default sidebar({ text: "Maven", icon: "configuration", prefix: "maven/", - children: ["maven-core-concepts"], + children: ["maven-core-concepts", "maven-best-practices"], }, { text: "Gradle", diff --git a/docs/about-the-author/zhishixingqiu-two-years.md b/docs/about-the-author/zhishixingqiu-two-years.md index bef5b48e..2c2967e0 100644 --- a/docs/about-the-author/zhishixingqiu-two-years.md +++ b/docs/about-the-author/zhishixingqiu-two-years.md @@ -143,12 +143,10 @@ JavaGuide 知识星球优质主题汇总传送门： 这篇文章。 ```java Class targetClass = Class.forName("cn.javaguide.TargetObject"); diff --git a/docs/java/collection/java-collection-precautions-for-use.md b/docs/java/collection/java-collection-precautions-for-use.md index be6af5f5..1f4963b3 100644 --- a/docs/java/collection/java-collection-precautions-for-use.md +++ b/docs/java/collection/java-collection-precautions-for-use.md @@ -213,8 +213,6 @@ public int indexOf(Object o) { ``` -我们的 `List` 有 N 个元素，那时间复杂度就接近是 O (n^2)。 - ## 集合转数组 《阿里巴巴 Java 开发手册》的描述如下： diff --git a/docs/tools/maven/maven-best-practices.md b/docs/tools/maven/maven-best-practices.md new file mode 100644 index 00000000..fbd60856 --- /dev/null +++ b/docs/tools/maven/maven-best-practices.md @@ -0,0 +1,233 @@ +--- +title: Maven最佳实践 +category: 开发工具 +head: + - - meta + - name: keywords + content: Maven坐标,Maven仓库,Maven生命周期,Maven多模块管理 + - - meta + - name: description + content: Maven 是一种广泛使用的 Java 项目构建自动化工具。它简化了构建过程并帮助管理依赖关系，使开发人员的工作更轻松。在这篇博文中，我们将讨论一些最佳实践、提示和技巧，以优化我们在项目中对 Maven 的使用并改善我们的开发体验。 +--- + +> 本文由 JavaGuide 翻译并完善，原文地址： 。 + +Maven 是一种广泛使用的 Java 项目构建自动化工具。它简化了构建过程并帮助管理依赖关系，使开发人员的工作更轻松。Maven 详细介绍可以参考我写的这篇 [Maven 核心概念总结](./maven-core-concepts.md) 。 + +这篇文章不会涉及到 Maven 概念的介绍，主要讨论一些最佳实践、建议和技巧，以优化我们在项目中对 Maven 的使用并改善我们的开发体验。 + +## Maven 标准目录结构 + +Maven 遵循标准目录结构来保持项目之间的一致性。遵循这种结构可以让其他开发人员更轻松地理解我们的项目。 + +Maven 项目的标准目录结构如下： + +```groovy +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 来编译你的项目，你可以在``标签下添加以下的代码片段： + +```xml + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.1 + + 1.8 + 1.8 + + + + +``` + +这样，Maven 就会使用 Java8 的编译器来编译你的项目。如果你想要使用其他版本的 JDK，你只需要修改``和``标签的值即可。例如，如果你想要使用 Java11，你可以将它们的值改为 11。 + +## 有效管理依赖关系 + +Maven 的依赖管理系统是其最强大的功能之一。在顶层 pom 文件中，通过标签 `dependencyManagement` 定义公共的依赖关系，这有助于避免冲突并确保所有模块使用相同版本的依赖项。 + +例如，假设我们有一个父模块和两个子模块 A 和 B，我们想要在所有模块中使用 JUnit 5.7.2 作为测试框架。我们可以在父模块的`pom.xml`文件中使用``标签来定义 JUnit 的版本： + +```xml + + + + org.junit.jupiter + junit-jupiter + 5.7.2 + test + + + +``` + +在子模块 A 和 B 的 `pom.xml` 文件中，我们只需要引用 JUnit 的 `groupId` 和 `artifactId` 即可: + +```xml + + + org.junit.jupiter + junit-jupiter + + +``` + +## 针对不同环境使用配置文件 + +Maven 配置文件允许我们配置不同环境的构建设置，例如开发、测试和生产。在 `pom.xml` 文件中定义配置文件并使用命令行参数激活它们： + +```xml + + + development + + true + + + dev + + + + production + + prod + + + +``` + +使用命令行激活配置文件： + +```bash +mvn clean install -P production +``` + +## 保持 pom.xml 干净且井然有序 + +组织良好的 `pom.xml` 文件更易于维护和理解。以下是维护干净的 `pom.xml` 的一些技巧： + +- 将相似的依赖项和插件组合在一起。 +- 使用注释来描述特定依赖项或插件的用途。 +- 将插件和依赖项的版本号保留在 `` 标签内以便于管理。 + +```xml + + 5.7.0 + 3.9.0 + +``` + +## 使用 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，请在项目目录中运行以下命令： + +```bash +mvn wrapper:wrapper +``` + +此命令会在我们的项目中生成 Maven Wrapper 文件。现在我们可以使用 `./mvnw` （或 Windows 上的 `./mvnw.cmd`）而不是 `mvn` 来执行 Maven 命令。 + +## 通过持续集成实现构建自动化 + +将 Maven 项目与持续集成 (CI) 系统（例如 Jenkins 或 GitHub Actions）集成，可确保自动构建、测试和部署我们的代码。CI 有助于及早发现问题并在整个团队中提供一致的构建流程。以下是 Maven 项目的简单 GitHub Actions 工作流程示例： + +```groovy +name: Java CI with Maven + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up JDK 11 + uses: actions/setup-java@v2 + with: + java-version: '11' + distribution: 'adopt' + + - name: Build with Maven + run: ./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 使用示例： + +```xml + + + + org.jacoco + jacoco-maven-plugin + 0.8.8 + + + + prepare-agent + + + + generate-code-coverage-report + test + + report + + + + + + +``` + +如果这些已有的插件无法满足我们的需求，我们还可以自定义插件。 + +探索可用的插件并在 `pom.xml` 文件中配置它们以增强我们的开发过程。 + +## 总结 + +Maven 是一个强大的工具，可以简化 Java 项目的构建过程和依赖关系管理。通过遵循这些最佳实践和技巧，我们可以优化 Maven 的使用并改善我们的 Java 开发体验。请记住使用标准目录结构，有效管理依赖关系，利用不同环境的配置文件，并将项目与持续集成系统集成，以确保构建一致。 \ No newline at end of file