Maven的使用

最新推荐文章于 2024-06-20 08:34:47 发布

罗辑的

最新推荐文章于 2024-06-20 08:34:47 发布

阅读量395

点赞数

文章标签： maven java

本文链接：https://blog.csdn.net/l965118033/article/details/128458914

版权

一、基础概念

1. 坐标

Maven的所有构件均通过坐标进行组织和管理。Maven的坐标通过5个元素进行定义，其中groupId、artifactId、version是必须的，packaging是可选的（默认为jar），classifier是不能直接定义的。
Maven使用groupId、artifactId、version唯一确定坐标，每个坐标都唯一的指向一个Maven项目，包名应与groupId+artifactId相吻合。

1.1 groupId

项目组织唯一的标识符，一般为反写的公司网址+项目名，跟Java包名类似，通常与域名反向一一对应。

1.2 artifactId

项目的唯一的标识符，一般为项目名+模块名，定义当前Maven项目的一个模块，默认情况下，Maven生成的构件，其文件名会以artifactId开头，如 hibernate-core-3.6.5.Final.jar。

1.3 version

定义项目版本号：x.x.x+版本类型

第一个x表示大版本号
第二个x表示分支版本号
第三个x表示小版本号（可省略）

常见版本类型：

SNAPSHOT快照
ALPHA内部测试
BEAT公测
RELEASE稳定
GA正式发布

1.4 packaging

定义项目打包方式。如jar、war、pom、zip等，默认为jar。

1.5 classifier

定义项目的附属构件，如hibernate-core-3.6.6.Final-sources.jar，hibernate-core-3.6.6.Final-javadoc.jar，其中sources和javadoc就是这两个附属构件的classifier。classifier不能直接定义，通常由附加的插件帮助生成。

2. 生命周期

Maven有三套相互独立的生命周期，分别是clean、default和site。每个生命周期包含一些阶段（phase），阶段是有顺序的，后面的阶段依赖于前面的阶段。

2.1 clean生命周期

清理项目，包含三个phase：

pre-clean 执行清理前需要完成的工作
clean 清理上一次构建生成的文件
post-clean 执行清理后需要完成的工作

2.2 default生命周期

构建项目，重要的phase如下：

validate 验证工程是否正确，所有需要的资源是否可用
initialize
generate-sources
process-sources
generate-resources
process-resources 复制和处理资源文件到target目录，准备打包
**compile**** 编译项目的源代码**
process-classes
generate-test-sources
process-test-sources
generate-test-resources
process-test-resources
**test-compile**** 编译测试源代码**
process-test-classes
**test**** 使用合适的单元测试框架来测试已编译的源代码**
prepare-package
**package**** 把已编译的代码打包成可发布的格式，比如****jar**
pre-integration-test
integration-test 如有需要，将包处理和发布到一个能够进行集成测试的环境
post-integration-test
verify 运行所有检查，验证包是否有效且达到质量标准
**install**** 将打好的包安装到本地仓库，供其他项目使用**
deploy 将打好的包安装到远程仓库，供其他项目使用

2.3 site生命周期

建立和发布项目站点，phase如下：

pre-site 生成项目站点之前需要完成的工作
site 生成项目站点文档
post-site 生成项目站点之后需要完成的工作
site-deploy 将项目站点发布到服务器

3. 依赖相关

3.1 依赖范围

执行不同的Maven命令，比如mvn package、mvn test、mvn install 等，会使用不同的 classpath。
Maven对应的有三套classpath：编译、测试、运行。scope选项的值，决定了该依赖构件会被引入到哪一个classpath中。
**scope**标签：

compile 默认，编译、测试、运行均有效[会传递]
provided在编译和测试时有效，如servletAPI可以加入[不传递]
runtime在测试和运行时有效，如JDBCAPI可以加入
test在测试时有效，如junit可以加入
system在编译和测试时有效，与本机系统相关联，移植性差，在系统中以外部jar包的形式引入，不会在仓库中查找
import导入，只能用在dependecyManagement中，表示从其他pom中导入dependecy的配置

3.2 依赖传递

如果C依赖B、B依赖A，则C→B→A。那么此时C也会依赖A且会包含A中的依赖,这就是传递依赖。消除传递依赖：需要使用<exclusions>标签。

3.3 依赖冲突

当多个传递性依赖中有对同一构件不同版本的依赖时，依赖传递原则：

短路径优先

假如有以下依赖：A -> B -> C ->X(版本 1.0) 和 A -> D -> X(版本 2.0)，则优先解析较短路径的 X(版本 2.0)。

先声明优先

若路径长度相同，则谁先声明，谁被解析。

3.4 依赖排除

使用依赖排除 <exclusions>元素，显示排除短路径依赖。

3.5 依赖归类

通常在项目中，我们会同时依赖同一个构件的不同模块，如spring-orm-3.2.0、spring-context-3.2.0，且多个模块版本相同。为了维护和升级方便，我们可以对其同一管理，这时可以使用到Maven属性，类似于变量的概念。

<properties>
    <springframework.version>3.2.0.RELEASE</springframework.version>
</properties>

<dependencies>
  
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>${springframework.version}</version>
    </dependency>
  
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${springframework.version}</version>
    </dependency>
  
</dependencies>

4. 聚合和继承

4.1 聚合

在一个项目中，分模块使用了Maven，那么可能在这个项目中会有五六个，或者更多的Maven项目存在。如果此时需要编译或测试要怎么办呢，进入每个Maven项目中进行mvn compile么，那就要执行五六次的compile命令，十分繁琐，这里就可以用Maven的聚合来解决这个问题。

<modules>
   <module>A</module>
   <module>B</module>
   <module>C</module>
</modules>

4.2 继承

如果多个Maven项目具有相同的依赖时或配置时，那么应该如何处理呢？这里就用到继承的概念，在Maven中使用<parent>标签来进行继承。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.xxx</groupId>
    <artifactId>parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>


    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <junit.version>4.12</junit.version>
        <commons-io.version>2.4</commons-io.version>
    </properties>

  
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <!-- 在这里声明的依赖可以被子项目继承引用 -->
        <dependencies>
            <dependency>
                <groupId>commons-io</groupId>
                <artifactId>commons-io</artifactId>
                <version>${commons-io.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!-- 在parent标签中使用父项目的坐标进行配置 -->
    <parent>
          <groupId>com.xxx</groupId>
          <artifactId>parent</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

  
    <groupId>com.xxx</groupId>
    <artifactId>child</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 此处使用依赖时，就不需声明版本 -->
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
        </dependency>
    </dependencies>
  
</project>

5. 常用标签

<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <!-- 当前pom的版本-->
    <modelVersion>1.0.0</modelVersion>

    <!--坐标-->
    <groupId>com.xxx</groupId>
    <artifactId>xxx-cloud</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <!-- 默认是jar，其他war zip pom等 -->
    <packaging>jar</packaging>

    <!--项目描述名 -->
    <name>xxx-xxx</name>
    <!-- 项目描述 -->
    <description>xxx</description>
    <!-- 项目地址 -->
    <url>https://git.xxx.com</url>

    <!-- 配置参数 -->
    <properties>
        <!-- 这里配置项目编译编码为UTF-8-->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <!-- 开发人员信息 -->
    <developers></developers>

    <!-- 许可信息 -->
    <licenses></licenses>
    <!-- 组织信息 -->
    <organization></organization>
    <!-- 依赖集，用于配置依赖 -->
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>

            <!-- 依赖范围：这个jar包只在范围内生效，范围外引用会报错，这里让junit只在test时被依赖。
                            其他一些情况，如：servlet-api.jar，在编译阶段需要引用，而在服务器运行阶段则不需要引用，就可以使用scope-->
            <scope>test</scope>

            <!-- 默认为false，子项目将会继承，true时子项目需要显式引用 -->
            <optional>false</optional>

            <!-- 排除依赖列表：用于去除传递依赖等-->
            <exclusions>
                <exclusion></exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <!-- 依赖管理
            为依赖进行统一管理，如果在父项目中声明此标签时，在子项目中不需声明，确保父子项目依赖版本一致；
            如子项目需要不同版本的依赖，只需在子项目中进行声明即可，将会覆盖父项目中的声明。
     -->
    <dependencyManagement>
         <dependencies>
              <dependency></dependency>
         </dependencies>
    </dependencyManagement>


    <!--配置构建时的属性-->
    <build>
        <plugins></plugins>
    </build>

    <!-- 指定父模块 -->
    <parent></parent>

    <!-- 用于聚合编译多个maven模块 -->
    <modules></modules>
  
</project>

6. 常用命令

mvn -v查看maven版本及其他相关信息
mvn compile编译maven项目，并生成target文件夹
mvn test运行test目录下的测试文件，即测试
mvn package将项目打包，默认打包为jar格式，也可以打包成war格式用于服务器运行
mvn install将打包的jar文件安装到maven本地仓库
mvn clean删除targert，相当于清除缓存

二、使用规范

1. 依赖版本定义

所有的子项目中，不能使用指定依赖版本，所有依赖在父级pom中使用dependencyManagement声明，在properties中统一维护版本。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>1.0.0</modelVersion>

    <groupId>com.xxx</groupId>
    <artifactId>cloud</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <properties>
        <commons-io.version>2.4</commons-io.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>commons-io</groupId>
                <artifactId>commons-io</artifactId>
                <version>${commons-io.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
          <groupId>com.xxx</groupId>
          <artifactId>cloud</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
  
    <groupId>com.xxx</groupId>
    <artifactId>aaa</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
        </dependency>
    </dependencies>
  
</project>