写点什么

高效开发 Maven 架构设计图解 / 掌握项目工程自动化技巧 (精通篇一)

作者:肖哥弹架构
  • 2024-10-06
    河北
  • 本文字数:9489 字

    阅读完需:约 31 分钟

高效开发Maven架构设计图解/掌握项目工程自动化技巧(精通篇一)


Maven 是一个项目管理和构建自动化工具,主要服务于基于 Java 的项目。它使用一个名为 POM(Project Object Model)的 XML 文件来描述项目的构建过程、依赖、插件等信息。


肖哥弹架构 跟大家“弹弹” 高并发锁, 关注公号回复 'mvcc' 获得手写数据库事务代码

欢迎 点赞,关注,评论。

关注公号 Solomon 肖哥弹架构获取更多精彩内容

历史热点文章

0、基本操作

安装 Maven

wget http://apache.mirrors.tds.net/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gztar -xzf apache-maven-3.6.3-bin.tar.gzcd apache-maven-3.6.3
复制代码
配置环境变量
export M2_HOME=/path/to/mavenexport M2=$M2_HOME/binexport PATH=$M2:$PATH
复制代码

1、maven 框架设计

Maven 图说明

  • Maven 项目:是使用 Maven 构建的软件项目。

  • 项目对象模型 POM:是 Maven 项目的核心,它是一个 XML 文件,描述了项目的构建过程、依赖、插件等信息。

  • 坐标:包括 GroupId、ArtifactId 和 Version,它们是 Maven 项目的唯一标识。

  • 依赖:项目所依赖的外部库和模块。

  • 插件:用于项目构建过程中的特定任务,例如编译、测试、打包。

  • 构建配置:定义了项目的构建过程和细节。

  • 构建生命周期:Maven 的构建生命周期定义了项目构建的一系列阶段,如编译、测试、打包、部署等。

  • 编译(compile) :将源代码编译成字节码。

  • 测试(test) :运行测试用例。

  • 打包(package) :将编译后的代码打包成 JAR、WAR 等格式。

  • 部署(deploy) :将最终的包部署到远程仓库或其他服务器上。

  • 清理(clean) :清理项目生成的所有生成物。

  • 目标:Maven 插件可以定义多个目标,每个目标都是一个任务,可以在构建生命周期中执行。

  • 依赖树:Maven 解析项目的依赖关系,构建依赖树。

  • 仓库:存储项目依赖的库和插件的服务器,分为本地仓库和远程仓库。

  • 本地仓库:存储所有项目依赖的本地文件夹。

  • 远程仓库:中央仓库或其他私有仓库,用于下载和上传依赖。


2、Maven settings配置相关组件和模块

  • settings.xml: Maven 的主要配置文件。

  • 本地仓库: 存储所有下载的依赖和插件的本地目录。

  • 交互模式: 控制 Maven 是否需要用户交互。

  • 插件注册表: 控制是否使用插件注册表。

  • 离线模式: 当无法访问外部网络时使用。

  • 插件组 : 定义一组插件组的 ID,这可以用来改变插件的查找顺序。

  • 服务器认证信息: 存储用于访问服务器的认证信息。

  • 镜像: 定义远程仓库的镜像地址。

  • 代理服务器: 定义网络代理的配置。

  • 配置文件: 定义一组配置文件,用于不同的构建环境。

  • 激活配置文件: 定义在构建时应该激活的配置文件。

2.1 模块介绍

在 Maven 中,settings.xml 文件主要关联和影响以下 Maven 的组件和模块:

2.1.1 本地仓库(Local Repository) :

settings.xml 中的 <localRepository/> 标签用于定义本地仓库的位置。如果未指定,Maven 默认使用 ~/.m2/repository(用户主目录下的 .m2 文件夹内的 repository)。


  • 作用:定义本地仓库的位置,用于存储所有下载的依赖和插件。

  • 默认值~/.m2/repository(用户主目录下的 .m2 文件夹内的 repository)。


<!-- 定义本地仓库的位置 --><localRepository>/path/to/local/repo</localRepository>
复制代码
2.1.2 交互模式(Interactive Mode) :

<interactiveMode/> 标签控制 Maven 是否在需要输入时(如输入密码)以交互模式运行。


  • 作用:控制 Maven 是否在需要输入时(如输入密码)以交互模式运行。


<!-- 控制 Maven 是否在需要输入时以交互模式运行 --><interactiveMode>true</interactiveMode>
复制代码
2.1.3 插件注册表(Plugin Registry) :

<usePluginRegistry/> 标签决定是否使用插件注册表,这可以加速构建过程。


  • 作用:决定是否使用插件注册表,这可以加速构建过程。


<!-- 决定是否使用插件注册表 --><usePluginRegistry>true</usePluginRegistry>
复制代码
2.1.4 离线模式(Offline Mode) :

<offline/> 标签用于设置 Maven 是否运行在离线模式。


  • 作用:用于设置 Maven 是否运行在离线模式。


<!-- 设置 Maven 是否运行在离线模式 --><offline>true</offline>
复制代码
2.1.5 服务器(Servers) :

<servers/> 标签用于配置服务器信息,这包括用于部署到远程仓库的认证信息。


  • 作用:用于配置服务器信息,这包括用于部署到远程仓库的认证信息。


<!-- 配置服务器信息,包括用于部署到远程仓库的认证信息 --><servers>  <!-- 服务器配置 -->  <server>    <!-- 服务器的唯一标识 -->    <id>server1</id>    <!-- 服务器的用户名 -->    <username>myusername</username>    <!-- 服务器的密码 -->    <password>mypassword</password>  </server></servers>
复制代码
2.1.6 镜像(Mirrors) :

<mirrors/> 标签定义了仓库镜像,允许用户通过更快的镜像访问远程仓库。


  • 作用:定义了仓库镜像,允许用户通过更快的镜像访问远程仓库。


<!-- 定义仓库镜像,允许用户通过更快的镜像访问远程仓库 --><mirrors>  <!-- 镜像配置 -->  <mirror>    <!-- 镜像的唯一标识 -->    <id>mymirror</id>    <!-- 指定被镜像的仓库 -->    <mirrorOf>central</mirrorOf>    <!-- 镜像的名称 -->    <name>My Mirror</name>    <!-- 镜像的URL -->    <url>http://mymirror.com/maven/</url>   </mirror></mirrors>
复制代码
2.1.7 代理(Proxies) :

<proxies/> 标签配置代理服务器的信息,用于在存在网络代理的环境中访问外部资源。


  • 作用:配置代理服务器的信息,用于在存在网络代理的环境中访问外部资源。

  • 代理与镜像区别


  • 镜像(Mirrors)

  • 目的:提高下载速度和可用性。镜像是远程仓库的本地副本,通常用于提供一个更快的访问路径到一个远程仓库,特别是当远程仓库很慢或者不可用时。

  • 工作方式:Maven 会从配置的镜像地址去尝试下载所需的构件(Artifacts)和插件。如果镜像上有这个构件,Maven 就会从镜像下载,否则它会回退到原始仓库地址。

  • 使用场景:当你位于一个访问中央仓库(或其他远程仓库)较慢或者有网络限制的地区时,使用镜像可以显著提高构建速度。

  • 代理(Proxies)

  • 目的:当你需要通过一个网络代理来访问外部网络时,配置代理使 Maven 能够通过这个代理服务器进行所有的外部 HTTP 请求。

  • 工作方式:Maven 配置了代理后,所有的 Maven 网络请求(包括从远程仓库下载构件和上传构件到远程仓库)都会通过指定的代理服务器进行。

  • 使用场景:在公司内网或者某些需要通过 HTTP 代理访问外网的环境,配置代理使得 Maven 能够正确地访问远程仓库。

  • 区别总结

  • 镜像是远程仓库的替代地址,用于加速下载过程。

  • 代理是网络中介,用于在受限制的网络环境中访问外部网络。


<!-- 配置代理服务器的信息 --><proxies>  <!-- 代理配置 -->  <proxy>    <!-- 代理的唯一标识 -->    <id>myproxy</id>    <!-- 是否激活代理 -->    <active>true</active>    <!-- 代理协议 -->    <protocol>http</protocol>    <!-- 代理服务器地址 -->    <host>proxy.somewhere.com</host>    <!-- 代理服务器端口 -->    <port>8080</port>    <!-- 代理服务器用户名 -->    <username>proxyuser</username>    <!-- 代理服务器密码 -->    <password>somepassword</password>    <!-- 指定不通过代理访问的主机 -->    <nonProxyHosts>*.google.com|*.apache.org</nonProxyHosts>  </proxy></proxies>
复制代码
2.1.8 插件组(Plugin Groups) :

<pluginGroups/> 标签定义了一组插件组的 ID,这可以用来改变插件的查找顺序。


  • 作用:定义了一组插件组的 ID,这可以用来改变插件的查找顺序。


<!-- 定义插件组的ID --><pluginGroups>  <!-- 插件组ID -->  <pluginGroup>my.custom.plugins</pluginGroup></pluginGroups>
复制代码
2.1.9 配置文件(Profiles) :

<profiles/> 标签定义了一组配置文件,每个配置文件可以包含特定的构建设置、激活条件、属性、仓库等,如下图。



  • 作用:定义了一组配置文件,每个配置文件可以包含特定的构建设置、激活条件、属性、仓库等。


<!-- 定义一组配置文件 --><profiles>  <!-- 配置文件项 -->  <profile>    <!-- 配置文件的唯一标识 -->    <id>dev</id>    <!-- 配置文件的激活条件 -->    <activation>      <!-- 是否默认激活 -->      <activeByDefault>true</activeByDefault>      <!-- JDK版本限制 -->      <jdk>1.8</jdk>      <!-- 操作系统限制 -->      <os>        <name>Windows</name>        <family>Windows</family>        <arch>x86_64</arch>        <version>10.0</version>      </os>    </activation>    <!-- 配置文件特有的属性 -->    <properties>      <maven.compiler.source>1.8</maven.compiler.source>      <maven.compiler.target>1.8</maven.compiler.target>    </properties>    <!-- 配置文件特有的仓库列表 -->    <repositories>      <!-- 仓库配置 -->      <repository>        <!-- 仓库的唯一标识 -->        <id>central</id>        <!-- 仓库的名称 -->        <name>Central Repository</name>        <!-- 仓库的URL -->        <url>https://repo.maven.apache.org/maven2</url>         <!-- 仓库的布局 -->        <layout>default</layout>        <!-- 快照版本设置 -->        <snapshots>          <!-- 是否启用快照版本 -->          <enabled>true</enabled>        </snapshots>        <!-- 正式发布版本设置 -->        <releases>          <!-- 是否启用正式发布版本 -->          <enabled>true</enabled>        </releases>      </repository>    </repositories>    <!-- 配置文件特有的插件仓库列表 -->    <pluginRepositories>      <!-- 插件仓库配置 -->      <pluginRepository>        <!-- 插件仓库的唯一标识 -->        <id>central</id>        <!-- 插件仓库的名称 -->        <name>Central Repository</name>        <!-- 插件仓库的URL -->        <url>https://repo.maven.apache.org/maven2</url>         <!-- 插件仓库的布局 -->        <layout>default</layout>        <!-- 插件快照版本设置 -->        <snapshots>          <!-- 是否启用插件快照版本 -->          <enabled>true</enabled>        </snapshots>        <!-- 插件正式发布版本设置 -->        <releases>          <!-- 是否启用插件正式发布版本 -->          <enabled>true</enabled>        </releases>      </pluginRepository>    </pluginRepositories>  </profile></profiles>
复制代码
2.1.10 激活配置文件(Active Profiles) :

<activeProfiles/> 标签定义了在 Maven 构建期间应该激活的配置文件列表。


  • 作用:定义了在 Maven 构建期间应该激活的配置文件列表。


<!-- 定义在 Maven 构建期间应该激活的配置文件列表 --><activeProfiles>  <!-- 激活的配置文件名称 -->  <activeProfile>dev</activeProfile></activeProfiles>
复制代码
2.1.11 属性(Properties) :

<properties/> 标签内,可以定义一些通用属性,这些属性可以在 POM 文件或构建脚本中使用。


  • 作用:定义一些通用属性,这些属性可以在 POM 文件或构建脚本中使用。


<!-- 定义一些通用属性 --><properties>  <!-- 属性名和属性值 -->  <property.name>value</property.name></properties>
复制代码
2.1.12 仓库管理(Repositories & PluginRepositories) :
  • 作用:在 <profiles/> 下的 <repositories/><pluginRepositories/> 标签定义了配置文件特定的仓库源,用于解析项目依赖和插件。


<!-- 配置文件特定的仓库源 --><profiles>  <!-- 配置文件项 -->  <profile>    ...    <!-- 配置文件特有的仓库列表 -->    <repositories>      <!-- 仓库配置 -->      <repository>        <!-- 仓库的唯一标识 -->        <id>central</id>        <!-- 仓库的名称 -->        <name>Central Repository</name>        <!-- 仓库的URL -->        <url>https://repo.maven.apache.org/maven2</url>         <!-- 仓库的布局 -->        <layout>default</layout>        <!-- 快照版本设置 -->        <snapshots>          <!-- 是否启用快照版本 -->          <enabled>true</enabled>        </snapshots>        <!-- 正式发布版本设置 -->        <releases>          <!-- 是否启用正式发布版本 -->          <enabled>true</enabled>        </releases>      </repository>    </repositories>    <!-- 配置文件特有的插件仓库列表 -->    <pluginRepositories>      <!-- 插件仓库配置 -->      <pluginRepository>        <!-- 插件仓库的唯一标识 -->        <id>central</id>        <!-- 插件仓库的名称 -->        <name>Central Repository</name>        <!-- 插件仓库的URL -->        <url>https://repo.maven.apache.org/maven2</url>         <!-- 插件仓库的布局 -->        <layout>default</layout>        <!-- 插件快照版本设置 -->        <snapshots>          <!-- 是否启用插件快照版本 -->          <enabled>true</enabled>        </snapshots>        <!-- 插件正式发布版本设置 -->        <releases>          <!-- 是否启用插件正式发布版本 -->          <enabled>true</enabled>        </releases>      </pluginRepository>    </pluginRepositories>    ...  </profile></profiles>
复制代码
2.1.13 构建生命周期(Build Lifecycle) :

尽管 settings.xml 不直接定义构建生命周期,但它通过配置(如代理、镜像等)影响构建过程,代理、镜像看上面内容。

2.1.14 依赖管理和解析(Dependency Management and Resolution) :

Maven 使用 settings.xml 中定义的镜像和仓库设置来解析和下载项目依赖;镜像与仓库看上面内容。

2.2 模块整体配置案例说明

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">    <!-- 本地仓库路径 -->  <localRepository>/path/to/local/repo</localRepository>  <!-- 控制 Maven 是否在需要输入时以交互模式运行 -->  <interactiveMode>true</interactiveMode>  <!-- 决定是否使用插件注册表,这可以加速构建过程 -->  <usePluginRegistry>true</usePluginRegistry>  <!-- 设置 Maven 是否运行在离线模式 -->  <offline>false</offline>    <!-- 服务器认证信息,用于部署到远程仓库 -->  <servers>    <server>      <!-- 服务器的唯一标识 -->      <id>server1</id>      <!-- 服务器的用户名 -->      <username>myusername</username>      <!-- 服务器的密码 -->      <password>mypassword</password>    </server>  </servers>    <!-- 定义仓库镜像,允许用户通过更快的镜像访问远程仓库 -->  <mirrors>    <mirror>      <!-- 镜像的唯一标识 -->      <id>mymirror</id>      <!-- 指定被镜像的仓库 -->      <mirrorOf>central</mirrorOf>      <!-- 镜像的名称 -->      <name>My Mirror</name>      <!-- 镜像的URL -->      <url>http://mymirror.com/maven/</url>    </mirror>  </mirrors>    <!-- 配置代理服务器的信息,用于在存在网络代理的环境中访问外部资源 -->  <proxies>    <proxy>      <!-- 代理的唯一标识 -->      <id>myproxy</id>      <!-- 是否激活代理 -->      <active>true</active>      <!-- 代理协议 -->      <protocol>http</protocol>      <!-- 代理服务器地址 -->      <host>proxy.somewhere.com</host>      <!-- 代理服务器端口 -->      <port>8080</port>      <!-- 代理服务器用户名 -->      <username>proxyuser</username>      <!-- 代理服务器密码 -->      <password>somepassword</password>      <!-- 指定不通过代理访问的主机 -->      <nonProxyHosts>*.google.com|*.apache.org</nonProxyHosts>    </proxy>  </proxies>    <!-- 定义一组插件组的ID,这可以用来改变插件的查找顺序 -->  <pluginGroups>    <pluginGroup>my.custom.plugins</pluginGroup>  </pluginGroups>    <!-- 定义一组配置文件,每个配置文件可以包含特定的构建设置、激活条件、属性、仓库等 -->  <profiles>    <profile>      <!-- 配置文件的唯一标识 -->      <id>dev</id>      <!-- 配置文件的激活条件 -->      <activation>        <!-- 是否默认激活 -->        <activeByDefault>true</activeByDefault>        <!-- JDK版本限制 -->        <jdk>1.8</jdk>        <!-- 操作系统限制 -->        <os>          <name>Windows</name>          <family>Windows</family>          <arch>x86_64</arch>          <version>10.0</version>        </os>      </activation>      <!-- 配置文件特有的属性 -->      <properties>        <maven.compiler.source>1.8</maven.compiler.source>        <maven.compiler.target>1.8</maven.compiler.target>      </properties>      <!-- 配置文件特有的仓库列表 -->      <repositories>        <repository>          <!-- 仓库的唯一标识 -->          <id>central</id>          <!-- 仓库的名称 -->          <name>Central Repository</name>          <!-- 仓库的URL -->          <url>https://repo.maven.apache.org/maven2</url>          <!-- 仓库的布局 -->          <layout>default</layout>          <!-- 快照版本设置 -->          <snapshots>            <!-- 是否启用快照版本 -->            <enabled>true</enabled>          </snapshots>          <!-- 正式发布版本设置 -->          <releases>            <!-- 是否启用正式发布版本 -->            <enabled>true</enabled>          </releases>        </repository>      </repositories>      <!-- 配置文件特有的插件仓库列表 -->      <pluginRepositories>        <pluginRepository>          <!-- 插件仓库的唯一标识 -->          <id>central</id>          <!-- 插件仓库的名称 -->          <name>Central Repository</name>          <!-- 插件仓库的URL -->          <url>https://repo.maven.apache.org/maven2</url>          <!-- 插件仓库的布局 -->          <layout>default</layout>          <!-- 插件快照版本设置 -->          <snapshots>            <!-- 是否启用插件快照版本 -->            <enabled>true</enabled>          </snapshots>          <!-- 插件正式发布版本设置 -->          <releases>            <!-- 是否启用插件正式发布版本 -->            <enabled>true</enabled>          </releases>        </pluginRepository>      </pluginRepositories>    </profile>  </profiles>    <!-- 定义在 Maven 构建期间应该激活的配置文件列表 -->  <activeProfiles>    <activeProfile>dev</activeProfile>  </activeProfiles></settings>
复制代码

3、Maven Wrapper

Maven Wrapper 是一个用于在多环境(如不同的开发机器、持续集成服务器等)中提供一致的 Maven 版本经验的工具。它允许项目包含一个特定版本的 Maven 可执行文件,这样即使用户本地没有安装 Maven,也可以使用项目指定的 Maven 版本来构建项目。

3.0 目录结构

当您在项目中添加 Maven Wrapper 后,它会在项目的根目录下创建一个 .mvn 目录,其中包含 wrapper 目录。以下是添加 Maven Wrapper 后生成的目录结构:


<project-root-directory>└── .mvn    └── wrapper        ├── maven-wrapper.jar        ├── maven-wrapper.properties        └── (on Windows)            └── maven-wrapper.cmd        └── (on Unix/Linux/Mac)            └── maven-wrapper.sh
复制代码
目录结构说明
  • .mvn: Maven Wrapper 专用目录,通常被添加到 .gitignore 文件中,以避免将 Maven Wrapper 下载的 Maven 归档文件纳入版本控制。

  • wrapper: 包含 Wrapper 脚本和配置文件的目录。

  • maven-wrapper.jar: Maven Wrapper 的 Java 程序,用于启动构建过程。

  • maven-wrapper.properties: 配置文件,指定了 Maven 归档文件的 URL 和其他配置信息。

  • maven-wrapper.cmd: Windows 系统上的 Wrapper 启动脚本。

  • maven-wrapper.sh: Unix、Linux 和 macOS 系统上的 Wrapper 启动脚本。

使用 Maven Wrapper 构建项目

使用以下命令使用 Maven Wrapper 来构建项目:


# 在 Unix、Linux 或 macOS 上./mvnw clean install
# 在 Windows 上mvnw.cmd clean install
复制代码


这些脚本(mvnwmvnw.cmd)是 Maven Wrapper 的启动器,它们会检查 maven-wrapper.properties 文件中指定的 Maven 版本,如果本地不存在该版本的 Maven,则会先下载并安装。以下是安装和使用 Maven Wrapper 的详细步骤:

3.1 安装 Maven Wrapper

  1. 下载 Maven Wrapper 脚本前往 Maven Wrapper 官方页面 下载 mvnwmvnw.cmd 脚本,以及 maven-wrapper.properties 配置文件。

  2. 使用 Maven 命令安装在项目根目录下,运行以下命令来初始化 Maven Wrapper:


mvn -N wrapper
复制代码


这个命令会下载 Wrapper 脚本和配置文件到项目的 .mvn/wrapper 目录。


  1. 配置 Gradle Wrapper(如果使用 Gradle)如果项目使用 Gradle,可以在项目的 build.gradle 文件中添加以下配置:


wrapper {    gradleVersion = '7.0'}
复制代码


然后运行以下命令生成 Wrapper:


gradle wrapper
复制代码

3.2 使用 Maven Wrapper

  1. 构建项目使用以下命令使用 Wrapper 构建项目:


./mvnw clean install
复制代码


在 Windows 上,使用:


mvnw.cmd clean install
复制代码


这些命令会调用项目自带的 Maven 版本来执行构建。


  1. 查看和修改 Maven 版本maven-wrapper.properties 文件中指定了 Maven 的版本。如果需要修改 Maven 的版本,可以编辑此文件:


distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
复制代码


修改 distributionUrl 来指定不同的 Maven 发行版。


  1. 为 Wrapper 下载 Maven 如果这是第一次使用 Wrapper,或者本地没有指定版本的 Maven,运行 mvnw 命令时,Wrapper 会自动下载配置文件中指定的 Maven 版本。

  2. 分发项目在将项目分发给其他开发者或部署到 CI 服务器时,不需要包含 Maven 安装程序,但需要包含 .mvn/wrapper 目录和脚本。

3.3 Maven Wrapper 的优势

  • 版本一致性:确保所有开发者和构建环境使用相同的 Maven 版本。

  • 离线支持:一旦下载,即使在离线状态下也可以使用 Maven Wrapper 构建项目。

  • 简化环境配置:新成员不需要单独安装 Maven,可以快速开始项目构建。


Maven Wrapper 是一个非常有用的工具,可以提高项目构建的可靠性和便携性。


其他内容在第二篇文章《高效开发 Maven 架构设计图解/掌握项目工程自动化技巧(精通篇一)》中。。。

发布于: 刚刚阅读数: 5
用户头像

智慧属心窍之锁 2019-05-27 加入

擅长于通信协议、微服务架构、框架设计、消息队列、服务治理、PAAS、SAAS、ACE\ACP、大模型

评论

发布
暂无评论
高效开发Maven架构设计图解/掌握项目工程自动化技巧(精通篇一)_maven_肖哥弹架构_InfoQ写作社区