Hefery 的个人网站

Hefery's Personal Website

Contact:hefery@126.com
  menu
73 文章
0 浏览
0 当前访客
ღゝ◡╹)ノ❤️

Maven—必知必会

Maven理论

Maven简介

Maven:项目管理工具,它包含了一个项目对象模型 (POM:Project Object Model),一组标准集合,一个项目生命周期(Project Lifecycle),一个依赖管理系统(Dependency Management System),和用来运行定义在生命周期阶段(phase)中插件(plugin)目标(goal)的逻辑

作用:

  • 依赖管理:对项目所依赖的 jar 包进行统一管理
  • 项目构建:编译、测试、运行、打包、安装 ,部署

通过读取 pom.xml 文件的坐标,再到仓库中找到 jar 包,会不会很慢?
通过 pom.xml 文件配置要引入的 jar 包的坐标,再读取坐标并到仓库中加载 jar 包,这样我们就可以直接使用 jar 包了,为了解决这个过程中速度慢的问题,maven 中也有索引的概念,通过建立索引,可以大大提高加载 jar 包的速度,使得我们认为 jar 包基本跟放在本地的工程文件中再读取出来的速度是一样的。这个过程就好比我们查阅字典时,为了能够加快查找到内容,书前面的目录就好比是索引,有了这个目录我们就可以方便找到内容了,一样的在 maven 仓库中有了索引,我们就可以认为可以快速找到 jar 包

POM体系

maven 工程都有一个 pom.xml 文件,通过 pom.xml 文件定义项目的坐标、项目依赖、项目信息、
插件目标等

  • <project > :文件的根节点,对当前工程进行配置、管理

  • <modelversion> : pom.xml 使用的对象模型版本,当前 pom.xml 所采用的标签结构

  • <packaging > :打包方式

    • jar:执行 package 会打成 jar 包
    • war:执行 package 会打成 war 包
    • pom :用于 maven 工程的继承,父工程设置为 pom
  • <name> :工程名称

  • <description> :工程描述

  • <properties>:工程属性

  • <dependencyManagement>:继承自该工程的所有子项目的默认依赖信息

  • <dependencies> :工程依赖构件配置,配置项目依赖构件的坐标

  • <dependencie>:Maven坐标

    • <groupId>:项目域名
    • <artifactId>:模块名称
    • <version>:产品版本号
      • SNAPSHOT:快照版本,正在迭代过程中,不稳定的版本
      • RELEASE:正式版本
    • <scope>:范围
      • compile:编译范围,指 A 在编译时依赖 B,此范围为默认依赖范围。编译范围的依赖会用在
        编译、测试、运行,由于运行时需要所以编译范围的依赖会被打包
      • provided:provided 依赖只有在当 JDK 或者一个容器已提供该依赖之后才使用, provided 依
        赖在编译和测试时需要,在运行时不需要,比如:servlet api 被 tomcat 容器提供
      • runtime:runtime 依赖在运行和测试系统的时候需要,但在编译的时候不需要。比如:jdbc
        的驱动包。由于运行时需要所以 runtime 范围的依赖会被打包
      • test:test 范围依赖 在编译和运行时都不需要,它们只有在测试编译和测试运行阶段可用,
        比如:junit。由于运行时不需要所以 test范围依赖不会被打包
      • system:system 范围依赖与 provided 类似,但是你必须显式的提供一个对于本地系统中 JAR
        文件的路径,需要指定 systemPath 磁盘路径,system依赖不推荐使用
  • <build> :项目构建配置,配置编译、运行插件等

查找:Maven本地仓库路径\groupld\artifactld\version\artifactld-version.jar

基础配置
<?xml version="1.0" encoding="UTF-8"?>
<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">
  
        <!-- 模型版本。maven2.0 必须是这样写,现在是 maven2 唯一支持的版本 -->  
        <modelVersion>4.0.0</modelVersion>  
  
        <!-- 项目的域名,配置时生成的路径也是由此生成,将项目打成 jar 包放本地:/com/winner/trade -->  
        <groupId>com.winner.trade</groupId>  
  
        <!-- 模块的名称,本项目的唯一ID,一个groupId下面可能多个项目,就靠 artifactId 来区分 -->  
        <artifactId>trade-core</artifactId>  
  
        <!-- 项目目前的版本号 -->  
        <version>1.0.0-SNAPSHOT</version>  
  
        <!--打包方式:pom、jar、maven-plugin、war,默认为jar -->  
        <packaging>jar</packaging>  
  
        <!-- 帮助定义构件输出的一些附属构件,附属构件与主构件对应,有时候需要加上classifier才能唯一的确定该构件 不能直接定义项目的classifer,因为附属构件不是项目直接默认生成的,而是由附加的插件帮助生成的 -->  
        <classifier>...</classifier>  
  
        <!-- 引入依赖 -->  
        <dependencies>  
  
            <!-- 每个dependency都对应这一个jar包 -->  
            <dependency>  
  
                <!-- 通过groupId、artifactId、version这三个元素值(坐标)来检索该构件-->
                <groupId>com.winner.trade</groupId>  
                <artifactId>trade-test</artifactId>  
                <version>1.0.0-SNAPSHOT</version>  
  
                <!-- 程序对外部的依赖会随着程序的所处阶段和应用场景而变化,所以依赖关系有作用域限制 -->  
                <!-- 
			scope包含如下的取值:
				compile(编译)
				provided(已提供)
				runtime(运行时)
				test(测试)
				system(系统) 
		-->  
                <scope>test</scope>  
  
                <!-- 设置依赖是否可选,默认false -->  
                <optional>false</optional>  
  
                <!-- 屏蔽依赖关系 -->  
                <exclusions>  
                    <exclusion>  
                        <groupId>org.slf4j</groupId>  
                        <artifactId>slf4j-api</artifactId>  
                    </exclusion>  
                </exclusions>  
  
            </dependency>  
  
        </dependencies>  
  
        <!-- 为 pom 定义一些常量,在 pom 中的其它地方可以直接引用 使用方式:${file.encoding} -->  
        <properties>  
            <file.encoding>UTF-8</file.encoding>  
            <java.source.version>1.5</java.source.version>  
            <java.target.version>1.5</java.target.version>  
        </properties>  
  
        ...  
</project>  
构建配置
<build>  
  
        <!-- 产生的构件的文件名,默认值是${artifactId}-${version} -->  
        <finalName>myPorjectName</finalName>  
  
        <!-- 构建产生的所有文件存放的目录,默认为${basedir}/target,即项目根目录下的target -->  
        <directory>${basedir}/target</directory>  
  
        <!-- 当项目没有规定目标(Maven2叫做阶段(phase))时的默认值 -->  
        <!-- 必须跟命令行上的参数相同例如jar:jar,或者与某个阶段(phase)相同例如install、compile等 -->  
        <defaultGoal>install</defaultGoal>  
  
        <!-- 当filtering开关打开时,使用到的过滤器属性文件列表 -->  
        <!-- 项目配置信息中诸如${spring.version}之类的占位符会被属性文件中的实际值替换掉 -->  
        <filters>  
            <filter>../filter.properties</filter>  
        </filters>  
  
        <!-- 项目相关的所有资源路径列表,和项目相关的配置文件、属性文件被包含在最终的打包文件里 -->  
        <resources>  
            <resource>  
  
                <!-- 描述了资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory}) -->  
                <!-- 举个例子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为org/apache/maven/messages -->  
                <!-- 然而,如果你只是想把资源放到源码目录结构里,就不需要该配置 -->  
                <targetPath>resources</targetPath>  
  
                <!-- 是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素里列出 -->  
                <filtering>true</filtering>  
  
                <!-- 描述存放资源的目录,该路径相对POM路径 -->  
                <directory>src/main/resources</directory>  
  
                <!-- 包含的模式列表 -->  
                <includes>  
                    <include>**/*.properties</include>  
                    <include>**/*.xml</include>  
                </includes>  
  
                <!-- 排除的模式列表 如果<include>与<exclude>划定的范围存在冲突,以<exclude>为准 -->  
                <excludes>  
                    <exclude>jdbc.properties</exclude>  
                </excludes>  
  
            </resource>  
        </resources>  
  
        <!-- 单元测试相关的所有资源路径,配制方法与resources类似 -->  
        <testResources>  
            <testResource>  
                <targetPath />  
                <filtering />  
                <directory />  
                <includes />  
                <excludes />  
            </testResource>  
        </testResources>  
  
        <!-- 项目源码目录,当构建项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径  -->  
        <sourceDirectory>${basedir}\src\main\java</sourceDirectory>  
  
        <!-- 项目脚本源码目录,该目录和源码目录不同, <!-- 绝大多数情况下,该目录下的内容会被拷贝到输出目录(因为脚本是被解释的,而不是被编译的) -->  
        <scriptSourceDirectory>${basedir}\src\main\scripts  
        </scriptSourceDirectory>  
  
        <!-- 项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径 -->  
        <testSourceDirectory>${basedir}\src\test\java</testSourceDirectory>  
  
        <!-- 被编译过的应用程序class文件存放的目录 -->  
        <outputDirectory>${basedir}\target\classes</outputDirectory>  
  
        <!-- 被编译过的测试class文件存放的目录 -->  
        <testOutputDirectory>${basedir}\target\test-classes  
        </testOutputDirectory>  
  
        <!-- 项目的一系列构建扩展,它们是一系列build过程中要使用的产品,会包含在running bulid‘s classpath里面 -->  
        <!-- 他们可以开启extensions,也可以通过提供条件来激活plugins -->  
        <!-- 简单来讲,extensions是在build过程被激活的产品 -->  
        <extensions>  
  
            <!-- 例如,通常情况下,程序开发完成后部署到线上Linux服务器,可能需要经历打包 -->  
            <!-- 将包文件传到服务器、SSH连上服务器、敲命令启动程序等一系列繁琐的步骤 -->  
            <!-- 实际上这些步骤都可以通过Maven的一个插件 wagon-maven-plugin 来自动完成 -->  
            <!-- 下面的扩展插件wagon-ssh用于通过SSH的方式连接远程服务器 -->  
            <!-- 类似的还有支持ftp方式的wagon-ftp插件 -->  
            <extension>  
                <groupId>org.apache.maven.wagon</groupId>  
                <artifactId>wagon-ssh</artifactId>  
                <version>2.8</version>  
            </extension>  
  
        </extensions>  
  
        <!-- 使用的插件列表 -->  
        <plugins>  
            <plugin>  
                <groupId></groupId>  
                <artifactId>maven-assembly-plugin</artifactId>  
                <version>2.5.5</version>  
  
                <!-- 在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置 -->  
                <executions>  
                    <execution>  
  
                        <!-- 执行目标的标识符,用于标识构建过程中的目标,或匹配继承中需要合并执行目标 -->  
                        <id>assembly</id>  
  
                        <!-- 绑定目标的构建生命周期阶段,如省略,目标会被绑定到源数据里配置的默认阶段 -->  
                        <phase>package</phase>  
  
                        <!-- 配置的执行目标 -->  
                        <goals>  
                            <goal>single</goal>  
                        </goals>  
  
                        <!-- 配置是否被传播到子POM -->  
                        <inherited>false</inherited>  
  
                    </execution>  
                </executions>  
  
                <!-- 作为DOM对象的配置,配置项因插件而异 -->  
                <configuration>  
                    <finalName>${finalName}</finalName>  
                    <appendAssemblyId>false</appendAssemblyId>  
                    <descriptor>assembly.xml</descriptor>  
                </configuration>  
  
                <!-- 是否从该插件下载Maven扩展(例如打包和类型处理器) -->  
                <!-- 由于性能原因,只有在真需要下载时,该元素才被设置成true -->  
                <extensions>false</extensions>  
  
                <!-- 项目引入插件所需要的额外依赖 -->  
                <dependencies>  
                    <dependency>...</dependency>  
                </dependencies>  
  
                <!-- 任何配置是否被传播到子项目 -->  
                <inherited>true</inherited>  
  
            </plugin>  
        </plugins>  
  
        <!-- 主要定义插件的共同元素、扩展元素集合,类似于dependencyManagement -->  
        <!-- 所有继承于此项目的子项目都能使用。该插件配置项直到被引用时才会被解析或绑定到生命周期 -->  
        <!-- 给定插件的任何本地配置都会覆盖这里的配置 -->  
        <pluginManagement>  
            <plugins>...</plugins>  
        </pluginManagement>  
  
</build>  
分发配置
<!-- 项目分发信息,在执行mvn deploy后表示要发布的位置 -->  
<!-- 有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库 -->  
<distributionManagement>  
  
        <!-- 部署项目产生的构件到远程仓库需要的信息 -->  
        <repository>  
  
            <!-- 分配给快照一个唯一的版本号(由时间戳和构建流水号),还是每次都使用相同的版本号 -->  
            <!-- 参见repositories/repository元素 -->  
            <uniqueVersion>true</uniqueVersion>  
  
            <id> repo-id </id>  
            <name> repo-name</name>  
            <url>file://${basedir}/target/deploy </url>  
            <layout />  
  
        </repository>  
  
        <!-- 构件的快照部署到哪里,如果没有配置该元素,默认部署到repository元素配置的仓库 -->  
        <snapshotRepository>  
            <uniqueVersion />  
            <id />  
            <name />  
            <url />  
            <layout />  
        </snapshotRepository>  
  
        <!-- 部署项目的网站需要的信息 -->  
        <site>  
  
            <!-- 部署位置的唯一标识符,用来匹配站点和settings.xml文件里的配置 -->  
            <id> site-id </id>  
  
            <!-- 部署位置的名称 -->  
            <name> site-name</name>  
  
            <!-- 部署位置的URL,按protocol://hostname/path形式 -->  
            <url>scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web </url>  
  
        </site>  
  
        <!-- 项目下载页面的URL。如果没有该元素,用户应该参考主页 -->  
        <!-- 使用该元素的原因是:帮助定位那些不在仓库里的构件(由于license限制) -->  
        <downloadUrl />  
  
        <!-- 如果构件有了新的groupID和artifact ID(构件移到了新的位置),这里列出构件的重定位信息。 -->  
        <relocation>  
  
            <!-- 构件新的group ID -->  
            <groupId />  
  
            <!-- 构件新的artifact ID -->  
            <artifactId />  
  
            <!-- 构件新的版本号 -->  
            <version />  
  
            <!-- 显示给用户的,关于移动的额外信息,例如原因 -->  
            <message />  
  
        </relocation>  
  
        <!-- 给出该构件在远程仓库的状态。不得在本地项目中设置该元素,因为这是工具自动更新的 -->  
        <!-- 有效的值有:none(默认),converted(仓库管理员从Maven 1 POM转换过来) -->  
        <!-- partner(直接从伙伴Maven 2仓库同步过来),deployed(从Maven 2实例部署),verified(被核实时正确的和最终的) -->  
        <status />  
  
</distributionManagement>  
仓库配置
<!--发现依赖和扩展的远程仓库列表。 -->  
<repositories>  
  
        <!--包含需要连接到远程仓库的信息 -->  
        <repository>  
  
            <!--如何处理远程仓库里发布版本的下载 -->  
            <releases>  
  
                <!--true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 -->  
                <enabled />  
  
                <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。 -->  
                <!--这里的选项是:always(一直),daily(默认,每日), -->  
                <!--interval:X(这里X是以分钟为单位的时间间隔),或者never(从不)。 -->  
                <updatePolicy />  
  
                <!--当Maven验证构件校验文件失败时该怎么做: -->  
                <!--ignore(忽略),fail(失败),或者warn(警告)。 -->  
                <checksumPolicy />  
  
            </releases>  
  
            <!--如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置, -->  
            <!--POM就可以在每个单独的仓库中,为每种类型的构件采取不同的策略。 -->  
            <!--例如,可能有人会决定只为开发目的开启对快照版本下载的支持 -->  
            <snapshots>  
                <enabled />  
                <updatePolicy />  
                <checksumPolicy />  
            </snapshots>  
  
            <!--远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 -->  
            <id> repo-id </id>  
  
            <!--远程仓库名称 -->  
            <name> repo-name</name>  
  
            <!--远程仓库URL,按protocol://hostname/path形式 -->  
            <url>http://192.168.1.169:9999/repository/ </url>  
  
            <!--用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。 -->  
            <!--Maven 2为其仓库提供了一个默认的布局; -->  
            <!--然而,Maven1.x有一种不同的布局。 -->  
            <!--我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。 -->  
            <layout> default</layout>  
  
        </repository>  
  
    </repositories>  
  
    <!--发现插件的远程仓库列表,这些插件用于构建和报表 -->  
    <pluginRepositories>  
  
        <!--包含需要连接到远程插件仓库的信息.参见repositories/repository元素 -->  
        <pluginRepository />  
  
</pluginRepositories>  
profile配置
<!--在列的项目构建profile,如果被激活,会修改构建处理 -->  
<profiles>  
  
        <!--根据环境参数或命令行参数激活某个构建处理 -->  
        <profile>  
            <!--自动触发profile的条件逻辑。Activation是profile的开启钥匙。 -->  
            <activation>  
  
                <!--profile默认是否激活的标识 -->  
                <activeByDefault>false</activeByDefault>  
  
                <!--activation有一个内建的java版本检测,如果检测到jdk版本与期待的一样,profile被激活。 -->  
                <jdk>1.7</jdk>  
  
                <!--当匹配的操作系统属性被检测到,profile被激活。os元素可以定义一些操作系统相关的属性。 -->  
                <os>  
  
                    <!--激活profile的操作系统的名字 -->  
                    <name>Windows XP</name>  
  
                    <!--激活profile的操作系统所属家族(如 'windows') -->  
                    <family>Windows</family>  
  
                    <!--激活profile的操作系统体系结构 -->  
                    <arch>x86</arch>  
  
                    <!--激活profile的操作系统版本 -->  
                    <version>5.1.2600</version>  
  
                </os>  
  
                <!--如果Maven检测到某一个属性(其值可以在POM中通过${名称}引用),其拥有对应的名称和值,Profile就会被激活。 -->  
                <!-- 如果值字段是空的,那么存在属性名称字段就会激活profile,否则按区分大小写方式匹配属性值字段 -->  
                <property>  
  
                    <!--激活profile的属性的名称 -->  
                    <name>mavenVersion</name>  
  
                    <!--激活profile的属性的值 -->  
                    <value>2.0.3</value>  
  
                </property>  
  
                <!--提供一个文件名,通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在,如果不存在则激活profile。 -->  
                <!--另一方面,exists则会检查文件是否存在,如果存在则激活profile。 -->  
                <file>  
  
                    <!--如果指定的文件存在,则激活profile。 -->  
                    <exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists>  
  
                    <!--如果指定的文件不存在,则激活profile。 -->  
                    <missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</missing>  
  
                </file>  
  
            </activation>  
            <id />  
            <build />  
            <modules />  
            <repositories />  
            <pluginRepositories />  
            <dependencies />  
            <reporting />  
            <dependencyManagement />  
            <distributionManagement />  
            <properties />  
</profile>  
报表配置
<!--描述使用报表插件产生报表的规范,特定的maven 插件能输出相应的定制和配置报表. -->  
<!--当用户执行“mvn site”,这些报表就会运行,在页面导航栏能看到所有报表的链接。 -->  
<reporting>  
  
        <!--true,则网站不包括默认的报表。这包括“项目信息”菜单中的报表。 -->  
        <excludeDefaults />  
  
        <!--所有产生的报表存放到哪里。默认值是${project.build.directory}/site。 -->  
        <outputDirectory />  
  
        <!--使用的报表插件和他们的配置。 -->  
        <plugins>  
  
            <plugin>  
                <groupId />  
                <artifactId />  
                <version />  
                <inherited />  
                <configuration>  
                    <links>  
                        <link>http://java.sun.com/j2se/1.5.0/docs/api/</link>  
                    </links>  
                </configuration>  
                <!--一组报表的多重规范,每个规范可能有不同的配置。 -->  
                <!--一个规范(报表集)对应一个执行目标 。例如,有1,2,3,4,5,6,7,8,9个报表。 -->  
                <!--1,2,5构成A报表集,对应一个执行目标。2,5,8构成B报表集,对应另一个执行目标 -->  
                <reportSets>  
  
                    <!--表示报表的一个集合,以及产生该集合的配置 -->  
                    <reportSet>  
  
                        <!--报表集合的唯一标识符,POM继承时用到 -->  
                        <id>sunlink</id>  
  
                        <!--产生报表集合时,被使用的报表的配置 -->  
                        <configuration />  
  
                        <!--配置是否被继承到子POMs -->  
                        <inherited />  
  
                        <!--这个集合里使用到哪些报表 -->  
                        <reports>  
                            <report>javadoc</report>  
                        </reports>  
  
                    </reportSet>  
  
                </reportSets>  
  
            </plugin>  
  
        </plugins>  
  
</reporting>   
环境配置
<!--项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL,本例为 jira -->  
<issueManagement>  
  
    <!--问题管理系统(例如jira)的名字, -->  
    <system> jira </system>  
  
    <!--该项目使用的问题管理系统的URL -->  
    <url> http://jira.clf.com/</url>  
  
</issueManagement>  
  
<!--项目持续集成信息 -->  
<ciManagement>  
  
    <!--持续集成系统的名字,例如continuum -->  
    <system />  
  
    <!--该项目使用的持续集成系统的URL(如果持续集成系统有web接口的话)。 -->  
    <url />  
  
    <!--构建完成时,需要通知的开发者/用户的配置项。包括被通知者信息和通知条件(错误,失败,成功,警告) -->  
    <notifiers>  
  
        <!--配置一种方式,当构建中断时,以该方式通知用户/开发者 -->  
        <notifier>  
  
            <!--传送通知的途径 -->  
            <type />  
  
            <!--发生错误时是否通知 -->  
            <sendOnError />  
  
            <!--构建失败时是否通知 -->  
            <sendOnFailure />  
  
            <!--构建成功时是否通知 -->  
            <sendOnSuccess />  
  
            <!--发生警告时是否通知 -->  
            <sendOnWarning />  
  
            <!--不赞成使用。通知发送到哪里 -->  
            <address />  
  
            <!--扩展配置项 -->  
            <configuration />  
  
        </notifier>  
  
    </notifiers>  
  
</ciManagement> 
项目信息
    <!--项目的名称, Maven产生的文档用 -->  
    <name>banseon-maven </name>  
  
    <!--项目主页的URL, Maven产生的文档用 -->  
    <url>http://www.clf.com/ </url>  
  
    <!--项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时 -->  
    <!--(例如,CDATA中的文本会被解析器忽略,就可以包含HTML标签),不鼓励使用纯文本描述。 -->  
    <!-- 如果你需要修改产生的web站点的索引页面,你应该修改你自己的索引页文件,而不是调整这里的文档。 -->  
    <description>A maven project to study maven. </description>  
  
    <!--描述了这个项目构建环境中的前提条件。 -->  
    <prerequisites>  
  
        <!--构建该项目或使用该插件所需要的Maven的最低版本 -->  
        <maven />  
  
    </prerequisites>  
  
    <!--项目创建年份,4位数字。当产生版权信息时需要使用这个值。 -->  
    <inceptionYear />  
  
    <!--项目相关邮件列表信息 -->  
    <mailingLists>  
  
        <!--该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 -->  
        <mailingList>  
  
            <!--邮件的名称 -->  
            <name> Demo </name>  
  
            <!--发送邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->  
            <post> clf@126.com</post>  
  
            <!--订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->  
            <subscribe> clf@126.com</subscribe>  
  
            <!--取消订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->  
            <unsubscribe> clf@126.com</unsubscribe>  
  
            <!--你可以浏览邮件信息的URL -->  
            <archive> http:/hi.clf.com/</archive>  
  
        </mailingList>  
  
    </mailingLists>  
  
    <!--项目开发者列表 -->  
    <developers>  
  
        <!--某个项目开发者的信息 -->  
        <developer>  
  
            <!--SCM里项目开发者的唯一标识符 -->  
            <id> HELLO WORLD </id>  
  
            <!--项目开发者的全名 -->  
            <name> banseon </name>  
  
            <!--项目开发者的email -->  
            <email> banseon@126.com</email>  
  
            <!--项目开发者的主页的URL -->  
            <url />  
  
            <!--项目开发者在项目中扮演的角色,角色元素描述了各种角色 -->  
            <roles>  
                <role> Project Manager</role>  
                <role>Architect </role>  
            </roles>  
  
            <!--项目开发者所属组织 -->  
            <organization> demo</organization>  
  
            <!--项目开发者所属组织的URL -->  
            <organizationUrl>http://hi.clf.com/ </organizationUrl>  
  
            <!--项目开发者属性,如即时消息如何处理等 -->  
            <properties>  
                <dept> No </dept>  
            </properties>  
  
            <!--项目开发者所在时区, -11到12范围内的整数。 -->  
            <timezone> -5</timezone>  
  
        </developer>  
  
    </developers>  
  
    <!--项目的其他贡献者列表 -->  
    <contributors>  
  
        <!--项目的其他贡献者。参见developers/developer元素 -->  
        <contributor>  
            <name />  
            <email />  
            <url />  
            <organization />  
            <organizationUrl />  
            <roles />  
            <timezone />  
            <properties />  
        </contributor>  
  
    </contributors>  
  
    <!--该元素描述了项目所有License列表。应该只列出该项目的license列表,不要列出依赖项目的license列表。 -->  
    <!--如果列出多个license,用户可以选择它们中的一个而不是接受所有license。 -->  
    <licenses>  
  
        <!--描述了项目的license,用于生成项目的web站点的license页面,其他一些报表和validation也会用到该元素。 -->  
        <license>  
  
            <!--license用于法律上的名称 -->  
            <name> Apache 2 </name>  
  
            <!--官方的license正文页面的URL -->  
            <url>http://www.clf.com/LICENSE-2.0.txt </url>  
  
            <!--项目分发的主要方式: repo,可以从Maven库下载 manual, 用户必须手动下载和安装依赖 -->  
            <distribution> repo</distribution>  
  
            <!--关于license的补充信息 -->  
            <comments> Abusiness-friendly OSS license </comments>  
  
        </license>  
  
    </licenses>  
  
    <!--SCM(Source Control Management)标签允许你配置你的代码库,供Maven web站点和其它插件使用。 -->  
    <scm>  
        <!--SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情,请看SCMs提供的URL格式和列表。该连接只读。 -->  
        <connection>scm:svn:http://svn.baidu.com/banseon/maven/</connection>  
  
        <!--给开发者使用的,类似connection元素。即该连接不仅仅只读 -->  
        <developerConnection>scm:svn:http://svn.baidu.com/banseon/maven/  
        </developerConnection>  
  
        <!--当前代码的标签,在开发阶段默认为HEAD -->  
        <tag />  
  
        <!--指向项目的可浏览SCM库(例如ViewVC或者Fisheye)的URL。 -->  
        <url> http://svn.baidu.com/banseon</url>  
    </scm>  
  
    <!--描述项目所属组织的各种属性。Maven产生的文档用 -->  
    <organization>  
        <!--组织的全名 -->  
        <name> demo </name>  
        <!--组织主页的URL -->  
        <url> http://www.clf.com/</url> 
    </organization>   

生命周期

项目构建包括:清理、编译、测试、部署等过程

image.png

clean --> compile-->test--> site -->package--> install

生命周期从开头开始执行:执行 test,就会执行 clean,再执行 compile

生命周期:

  • Clean:项目清理的处理
    • pre-clean:执行一些需要在clean之前完成的工作
    • clean:移除所有上一次构建生成的文件
    • post-clean:执行一些需要在clean之后立刻完成的工作
  • Site:项目站点文档创建的处理
    • pre-site:执行一些需要在生成站点文档之前完成的工作
    • site:生成项目的站点文档
    • post-site:执行一些需要在生成站点文档之后完成的工作,并且为部署做准备
    • site-deploy:将生成的站点文档部署到特定的服务器上
  • Default:项目部署的处理
    • validate:校验。校验项目是否正确并且所有必要的信息可以完成项目的构建过程
    • initialize:初始化。初始化构建状态,比如设置属性值
    • generate-sources:生成源代码。生成包含在编译阶段中的任何源代码
    • process-sources:处理源代码。处理源代码,比如说,过滤任意值
    • generate-resources:生成资源文件。生成将会包含在项目包中的资源文件
    • process-resources:处理资源文件。复制和处理资源到目标目录,为打包阶段最好准备
    • compile:编译。编译项目 mian 目录下的源代码
    • process-classes:处理类文件。处理编译生成的文件,比如说对Java class文件做字节码改善优化
    • generate-test-sources:生成测试源代码。生成包含在编译阶段中的任何测试源代码
    • process-test-sources:处理测试源代码。处理测试源代码,比如说,过滤任意值
    • generate-test-resources:生成测试资源文件。为测试创建资源文件
    • process-test-resources:处理测试资源文件。复制和处理测试资源到目标目录
    • test-compile:编译测试源码。编译测试源代码到测试目标目录
    • process-test-classes:处理测试类文件。处理测试源码编译生成的文件
    • test:测试。使用合适的单元测试框架运行测试(Juint是其中之一)
    • prepare-package:准备打包。在实际打包之前,执行任何的必要的操作为打包做准备
    • package:打包。将编译后的代码打包成可分发格式的文件,比如JAR、WAR或者EAR文件
    • pre-integration-test:集成测试前。在执行集成测试前进行必要的动作。比如说,搭建需要的环境
    • integration-test:集成测试。处理和部署项目到可以运行集成测试环境中
    • post-integration-test:集成测试后。在执行集成测试完成后进行必要的动作。如清理集成测试环境
    • verify:验证。运行任意的检查来验证项目包有效且达到质量标准
    • install:安装。安装项目包到本地仓库,这样项目包可以用作其他本地项目的依赖
    • deploy:部署。将最终的项目包复制到远程仓库中与其他开发者和项目共享

Maven操作

Maven仓库

  • 远程仓库(remote):互联网上的仓库,下载 jar 包并存在本地仓库
  • 本地仓库(local):本地文件夹,当第二次需要此 jar 包时则不再从远程仓库下载,优先从本地仓库获取
  • 中央仓库 (central):在 maven 软件中内置一个远程仓库地址 http://repo1.maven.org/maven2 ,服务于整个互联网,由 Maven 团队自己维护,里面存储了非常全的 jar 包,包含了世界上大部分流行的开源项目构件

在 maven 安装目录下的有 conf/setting.xml 文件,此 setting.xml 文件用于 maven 的所有 project
项目,它作为 maven 的全局配置

Maven命令

  • 编译 compile:mvn compile将 src/main/java 下的文件编译为 class 文件输出到 target 目录下
  • 测试 test:mvn test执行 src/test/java 下的单元测试类
  • 清理 clean,mvn clean执行 clean 会删除 target 目录及内容
  • 打包 package:mvn packageJava工程执行 package 打成 jar 包,对于 Web 工程打成 war 包
  • 安装 install:mvn install将 maven 打成 jar 包或 war 包发布到本地仓库

跳过测试打包:mvn clean package -Dmaven.test.skip=true

Maven依赖

依赖范围scope
scope说明mian目录(空间)test目录(空间)开发过程(时间)部署到服务器(时间)
compile YYYY
provided YYY
runtime
test YY
system
依赖传递

引用关系:A <-- B <-- C

A 能否用到 C,就看 C 提供给 B 的 scope:compile 可以;test、provided 不行

依赖排除exclusion

引用关系:

  • A --> B --> C 0.1
  • A --> D --> C 0.1

相当于 A 引入 C 0.1 和 C 0.6 两个版本,如果两个版本有冲突,就会出现问题

解决:

  • 选择 C 的一个版本 0.6,那么就要排除 C 0.1,在 A --> B 时排除掉 C
  • 在 B 引入 C 0.1 处添加可选可以阻断依赖传递性 <optional>true</optional>

Maven进阶

Maven继承

父工程(pom)下还有子工程(pom),即多模块项目

  • 父工程 pom.xml 的 packaging 类型必须是 pom
  • 父工程通过 <modules> 管理子工程
  • 父工程统一管理依赖包:<dependencyManagement> 只声明依赖,而不引用,子项目需写明需要依赖
  • 子工程通过 <parent> 指定父工程
    • 子工程 <groupId> 一样可以省略
    • 对于已经在父工程进行了管理的依赖 <dependencys>,子工程中引用时可以不写 <version>,如果子工程指定了 <version> ,则子工程会覆盖父工程的 <version>

Maven属性

声明:<properties> 中指定 <spring-cloud.version>Hoxton.SR8</spring-cloud.version>

引用:<version>${spring-cloud.version}</version>

<!-- 为pom定义一些常量,在pom中的其它地方可以直接引用 使用方式 如下 :${file.encoding} -->  
<properties>  
        <file.encoding>UTF-8</file.encoding>  
        <java.source.version>1.5</java.source.version>  
        <java.target.version>1.5</java.target.version>  
</properties> 

Maven插件

在 pom.xml 中使用 <plugins> 定义

  • 创建 jar 文件:首先清理目标目录(clean),然后打包项目构建的输出为 \target\jar 文件(package)
  • 创建 war 文件
  • 编译代码文件
  • 代码单元测试
  • 创建工程文档
  • 创建工程报告

<build> 定义了构建项目需要的信息,可以声明 jar 包的名称

<finalName>${project.artifactId}-${project.version}</finalName>

<repositories>配置远程仓库

在本地仓库找不到的情况下,Maven 下载依赖、扩展和插件就是从这里配置的远程仓库中进行下载

<!-- 配置远程仓库 -->
<repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
</repositories>

jar包冲突

短路优先:引用路径短路优先

  • A.jar --> B.jar --> C.jar
  • D.jar --> C.jar

声明优先:若引用路径长度相同时,在 pom.xml 中谁先被声明,就使用谁

jar包冲突表现

一般来说,由于我们自己编写代码、配置文件写错所导致的问题通常能够在异常信息中看到我们自己类的全类名或配置文件的所在路径。如果整个错误信息中完全没有我们负责的部分,全部是框架、第三方工具包里面的类报错,这往往就是jar包的问题所引起的。而具体的表现形式中,主要体现为找不到类或方法

找不到类:

  • java.lang.ClassNotFoundException:编译过程中找不到类
  • java.lang.NoclassDefFoundError:运行过程中找不到类
  • java.lang.LinkageError:不同类加载器分别加载的多个类有相同的全限定名

找不到方法:程序找不到符合预期的方法。这种情况多见于通过反射调用方法,所以经常会导致:

  • java.lang.NoSuchMethodError

没报错,但结果不对:两个 jar 包中的类分别实现了同一个接口

这本来是很正常的。但是问题在于:由于没有注意命名规范,两个不同实现类俗巧是同一个名字

具体例子:项目中部分模块使用 logj 打印日志;其它模块使用 logback,编译运行都不会冲突,但是会引起日志服务降级,让 log 配置文件失效。比如:指定了 error 级别输出,但是冲突就会导致 info、debug 都在输出

jar包冲突本质

  • 同一 jar 包的不同版本
  • 不同 jar 包中包含同名类

netty 是类似 Tomcat 的 Servlet 容器。通常不会直接依赖,基本上是框架传递。当用到框架很多,就会有不同框架用不同的坐标导入 netty:org.jboss.netty、io.netty。不同的包里面又有很多全限定名相同的类

jar包冲突方案

找到冲突:

  • Maven Helper(IDEA插件,罗列同一个 jar 包的不同版本及来源。但对不同 jar 包中同名的类没有办法)
  • enforcer(pom.plugins中配置,既可以检测同一个 jar 包的不同版本,又可检测不同 jar 包中同名的类)

解决冲突:

  • <exclusion>
  • <optional>true</optional>

标题:Maven—必知必会
作者:Hefery
地址:http://hefery.icu/articles/2022/03/28/1648453706964.html