Maven 笔记

常用命令

• 百度云书籍链接：https://pan.baidu.com/s/16BPdjv7Umk_mbu6QwbR1BA 密码：h95p
• 安装：

set M2_HOME=c:\Program Files\maven-2.0.9
set PATH=%PATH%;%M2_HOME%\bin

• 查看effectPom : mvn help:effective-pom
• 运行项目： mvn exec:java -Dexec.mainClass=org.sonatype.mavenbook.weather.Main
• 查看exec的描述：mvn help:describe -Dplugin=exec -Dfull
• 浏览项目依赖：mvn dependency:resolve
• 浏览项目依赖树：mvn dependency:tree
• 查看完整的依赖踪迹：mvn install -X

依赖管理

可传递性依赖发现

功能	功能描述
依赖调节	决定当多个手动创建的版本同时出现时，哪个依赖版本将会被使用。 如果两个依赖版本在依赖树里的深度是一样的时候，第一个被声明的依赖将会被使用。
依赖管理	直接的指定手动创建的某个版本被使用。例如当一个工程 C 在自己的依赖管理模块包含工程 B，即 B 依赖于 A， 那么 A 即可指定在 B 被引用时所使用的版本。
依赖范围	包含在构建过程每个阶段的依赖。
依赖排除	任何可传递的依赖都可以通过 “exclusion” 元素被排除在外。举例说明，A 依赖 B， B 依赖 C，因此 A 可以标记 C 为 “被排除的”。
依赖可选	任何可传递的依赖可以被标记为可选的，通过使用 “optional” 元素。例如：A 依赖 B， B 依赖 C。因此，B 可以标记 C 为可选的， 这样 A 就可以不再使用 C。

依赖范围

范围	描述
编译阶段	该范围表明相关依赖是只在项目的类路径下有效。默认取值。
供应阶段	该范围表明相关依赖是由运行时的 JDK 或者 网络服务器提供的。
运行阶段	该范围表明相关依赖在编译阶段不是必须的，但是在执行阶段是必须的。
测试阶段	该范围表明相关依赖只在测试编译阶段和执行阶段。
系统阶段	该范围表明你需要提供一个系统路径。
导入阶段	该范围只在依赖是一个 pom 里定义的依赖时使用。同时，当前项目的POM 文件的 部分定义的依赖关系可以取代某特定的 POM。

mirror和repository 区别

repository

repository里存放的都是各种jar包和maven插件。当向仓库请求插件或依赖的时候，会先检查local repository，如果local repository有则直接返回，否则会向remote repository请求，并缓存到local repository。也可以把做的东西放到本地仓库，仅供本地使用；或上传到远程仓库，供大家使用。

mirror

mirror相当于一个拦截器，它会拦截maven对remote repository的相关请求，把请求里的remote repository地址，重定向到mirror里配置的地址。

• 没有配置mirror：
  
• 配置mirror：
  

此时，B Repository被称为A Repository的镜像。如果仓库X可以提供仓库Y存储的所有内容，那么就可以认为X是Y的一个镜像。换句话说，任何一个可以从仓库Y获得的构件，都胡够从它的镜像中获取。

• mirrorOf

<mirrorOf></mirrorOf>标签里面放置的是要被镜像的Repository ID。为了满足一些复杂的需求，Maven还支持更高级的镜像配置：

<mirrorOf>*</mirrorOf>：匹配所有远程仓库。
<mirrorOf>repo1,repo2</mirrorOf>：匹配仓库repo1和repo2，使用逗号分隔多个远程仓库。

<mirrorOf>*,!repo1</miiroOf>：匹配所有远程仓库，repo1除外，使用感叹号将仓库从匹配中排除。

Repository与Mirror

• 定义：mirror表示的是两个Repository之间的关系，在maven配置文件（setting.xml)里配置了…，即定义了两个Repository之间的镜像关系。
• 目的：配置两个Repository之间的镜像关系，一般是出于访问速度和下载速度考虑。

例如， 有一个项目，需要在公司和住所都编码，并在项目pom.xml配置了A Maven库。在公司，是电信网络，访问A库很快，所以maven管理依赖和插件都从A库下载；在住所，是网通网络，访问A库很慢，但是访问B库很快。这时，在住所的setting.xml里，只要配置一下<mirrors><mirror>....</mirror></mirrors>，让B库成为A库的mirror，即可不用更改项目pom.xml里对于A库的相关配置。

如果该镜像仓库需要认证，则配置setting.xml中的<server></server>即可。

• 注意
  需要注意的是，由于镜像仓库完全屏蔽了被镜像仓库，当镜像仓库不稳定或者停止服务的时候，Maven仍将无法访问被镜像仓库，因而将无法下载构件。

常用镜像

<mirror>
    <id>nexus-aliyun</id>
    <mirrorOf>*</mirrorOf>
    <name>Nexus aliyun</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public</url>
</mirror> 
<mirror>
    <id>spring</id>
    <mirrorOf>*</mirrorOf>
    <name>springsource</name>
    <url>http://repo.springsource.org/libs-milestone-local/</url>
</mirror>
<mirror>
    <id>sonatype</id>
    <mirrorOf>*</mirrorOf>
    <name>sonatype</name>
    <url>https://repository.sonatype.org/content/groups/public/</url>
</mirror>
<mirror>
    <id>jboss</id>
    <mirrorOf>*</mirrorOf>
    <name>jboss</name>
    <url>https://repository.jboss.org/maven2/</url>
</mirror>
<mirror>
    <id>maven</id>
    <mirrorOf>*</mirrorOf>
    <name>maven</name>
    <url>https://repo1.maven.org/maven2/</url>
</mirror>

快照(SNAPSHOT) 与 发布（release）

maven中的仓库分为两种，snapshot快照仓库和release发布仓库。snapshot快照仓库用于保存开发过程中的不稳定版本，release正式仓库则是用来保存稳定的发行版本。定义一个组件/模块为快照版本，只需要在pom文件中在该模块的版本号后加上-SNAPSHOT即可(注意这里必须是大写)。
简而言之，同一个版本号的SNAPSHOT版本可以deploy多次，使用者即使本地有SNAPSHOT版本也会从远程去检查新的快照，如果有更新，便重新拉取。而同一版本的release版本deploy多次会报错，即使删掉远程，重新deploy，如果使用者本地有release版本，也不会去远程拉取。

插件

测试

• 也可以使用命令：mvn test -Dmaven.test.failure.ignore=true
• 跳过单元测试：mvn install -Dmaven.test.skip=true

<build>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-surefire-plugin</artifactId>
			<configuration>
			<skip>true</skip>
			</configuration>
		</plugin>
	</plugins>
</build>

装配插件

<build>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-surefire-plugin</artifactId>
			<configuration>
			<skip>true</skip>
			</configuration>
		</plugin>
	</plugins>
</build>

配置 Jetty 插件

<plugins>
	<plugin>
		<groupId>org.mortbay.jetty</groupId>
		<artifactId>maven-jetty-plugin</artifactId>
	</plugin>
</plugins>

• 命令：mvn assembly:assembly

获取git信息 之 git-commit-id-maven-plugin

官网地址：https://github.com/git-commit-id/git-commit-id-maven-plugin
碰到的使用场景：健康检查的时候，/health 接口返回git相关信息

• 问题：Authentication is required but no CredentialsProvider has been registered
• 原因：早期版本默认去远程拉取最新的版本信息，且用SSH免登录方式，如果没有配置SSH，就会报该问题。
• 解决办法：使用本地git信息
  ![在这里插入图片描述](https://img-blog.csdnimg.cn/b8a2b8f8d9264dd59d8b307191cb387f.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAUnlhbl8yMDIxXw==,size_20,color_FFFFFF,t_70,g_se,x_16

POM配置

添加组织，法律和开发人员信息

<licenses>
	<license>
		<name>Apache 2</name>
		<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
		<distribution>repo</distribution>
		<comments>A business-friendly OSS license</comments>
	</license>
</licenses>
<organization>
	<name>Sonatype</name>
	<url>http://www.sonatype.com</url>
</organization>
<developers>
	<developer>
		<id>jason</id>
		<name>Jason Van Zyl</name>
		<email>jason@maven.org</email>
		<url>http://www.sonatype.com</url>
		<organization>Sonatype</organization>
		<organizationUrl>http://www.sonatype.com</organizationUrl>
		<roles>
			<role>developer</role>
		</roles>
		<timezone>-6</timezone>
	</developer>
</developers>

默认settings

<?xml version="1.0" encoding="UTF-8"?>
<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">
    <!-- 本地仓库的路径。默认值为${user.home}/.m2/repository。 -->
    <localRepository>/path/to/local/repo</localRepository>
    <!-- Maven是否需要和用户交互以获得输入。如果Maven需要和用户交互以获得输入，则设置成true，反之则应为false。默认为true。-->
    <interactiveMode>true</interactiveMode>
    <!-- 是否需要在离线模式下运行。如果构建系统需要在离线模式下运行，则为true，默认为false。当网络设置原因或者安全因素，构建服务器不能连接远程仓库时，该配置十分有用。 -->
    <offline>false</offline>
    <!-- 当插件的组织Id（groupId）没有显式提供时，供搜寻插件组织Id（groupId）的列表。该元素包含一个pluginGroup元素列表，每个子元素包含了一个组织Id（groupId）。
当使用某个插件，且没有在命令行为其提供组织Id（groupId）的时候，Maven就会使用该列表。默认情况下该列表包含了org.apache.maven.plugins和org.codehaus.mojo -->
    <pluginGroups>
        <!--plugin的组织Id（groupId）  -->
        <pluginGroup>org.codehaus.mojo</pluginGroup>
    </pluginGroups>
    <!--    用来配置不同的代理，多代理profiles 可以应对笔记本或移动设备的工作环境：
    通过简单的设置profile id就可以很容易的更换整个代理配置。 -->
    <proxies>
        <!--代理元素包含配置代理时需要的信息-->
        <proxy>
            <!--代理的唯一定义符，用来区分不同的代理元素。-->
            <id>myproxy</id>
            <!-- 该代理是否是激活的那个。true则激活代理。当声明了一组代理，而某个时候只需要激活一个代理的时候，该元素就可以派上用处。    -->
            <active>true</active>
            <!--代理的协议。 协议://主机名:端口，分隔成离散的元素以方便配置。-->
            <protocol>http</protocol>
            <!--代理的主机名。协议://主机名:端口，分隔成离散的元素以方便配置。  -->
            <host>proxy.somewhere.com</host>
            <!--代理的端口。协议://主机名:端口，分隔成离散的元素以方便配置。 -->
            <port>8080</port>
            <!--代理的用户名，用户名和密码表示代理服务器认证的登录名和密码。 -->
            <username>proxyuser</username>
            <!--代理的密码，用户名和密码表示代理服务器认证的登录名和密码。 -->
            <password>somepassword</password>
            <!--不该被代理的主机名列表。该列表的分隔符由代理服务器指定；例子中使用了竖线分隔符，使用逗号分隔也很常见。-->
            <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts>
        </proxy>
    </proxies>
    <!-- 服务端设置。安全证书不应该和pom.xml一起分发。这种类型的信息应该存在于构建服务器上的settings.xml文件中。-->
    <servers>
        <!-- 服务器元素包含配置服务器时需要的信息 -->
        <server>
            <!-- 这是server的id（注意不是用户登陆的id）该id与distributionManagement中repository元素的id相匹配。 -->
            <id>server001</id>
            <!--鉴权用户名。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。 -->
            <username>my_login</username>
            <!-- 鉴权密码 。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。 密码加密功能已被添加到2.1.0 +。详情请访问密码加密页面 -->
            <password>my_password</password>
            <!-- 鉴权时使用的私钥位置。和前两个元素类似，私钥位置和私钥密码指定了一个私钥的路径（默认是${user.home}/.ssh/id_dsa）以及如果需要的话，一个密语。
        将来passphrase和password元素可能会被提取到外部，但目前它们必须在settings.xml文件以纯文本的形式声明。 -->
            <privateKey>${usr.home}/.ssh/id_dsa</privateKey>
            <!--鉴权时使用的私钥密码。-->
            <passphrase>some_passphrase</passphrase>
            <!-- 文件被创建时的权限。若在部署时创建仓库文件或者目录，这时就可使用权限（permission）。
        此二元素合法值是个三位数字，对应unix文件系统的权限，如664，或者775。-->
            <filePermissions>664</filePermissions>
            <!--目录被创建时的权限。 -->
            <directoryPermissions>775</directoryPermissions>
        </server>
    </servers>
    <!--为仓库列表配置的下载镜像列表。高级设置请参阅镜像设置页面 -->
    <mirrors>
        <!--给定仓库的下载镜像。 -->
        <mirror>
            <!--该镜像的唯一标识符。id用来区分不同的mirror元素。 -->
            <id>planetmirror.com</id>
            <!--镜像名称 -->
            <name>PlanetMirror Australia</name>
            <!--该镜像的URL。构建系统会优先考虑使用该URL，而非使用默认的服务器URL。 -->
            <url>http://downloads.planetmirror.com/pub/maven2</url>
            <!-- 镜像的服务器的id。若设置了个Maven中央仓库（http://repo.maven.apache.org/maven2/）的镜像，
        就需要将该元素设置成central。这必须和中央仓库的id central完全一致。-->
            <mirrorOf>central</mirrorOf>
        </mirror>
    </mirrors>
    <!-- 根据环境参数来调整构建配置的列表。settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。
    它包含了id，activation, repositories, pluginRepositories和 properties元素。
    这里的profile元素只包含这五个子元素是因为这里只关心构建系统这个整体
    （这正是settings.xml文件的角色定位），而非单独的项目对象模型设置。
    若settings中的profile被激活,它的值会覆盖任何其它定义在POM中或者profile.xml中的带有相同id的profile。 -->
    <profiles>
        <!--根据环境参数来调整的构件的配置-->
        <profile>
            <!--该配置的唯一标识符。 -->
            <id>jdk-1.4</id>
            <!--自动触发profile的条件逻辑。Activation是profile的开启钥匙。
    如POM中的profile一样，profile能够在某些特定的环境中自动使用某些特定的值；
    这些环境通过activation元素指定。activation元素并不是激活profile的唯一方式。 
    settings.xml文件中的activeProfile元素可以包含profile的id。
    profile也可命令行，使用-P标记和逗号分隔的列表来显式的激活（如，-P test）。-->
            <activation>
                <!--profile默认是否激活的标识-->
                <activeByDefault>false</activeByDefault>
                <!--当匹配的jdk被检测到，profile被激活。 如，1.4激活JDK1.4，1.4.0_2，而!1.4激活所有版本不是以1.4开头的JDK。 -->
                <jdk>1.4</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中通过${name}引用），其拥有对应的name = 值，Profile就会被激活。
        如果值字段是空的，那么存在属性名称字段就会激活profile，否则按区分大小写方式匹配属性值字段 -->
                <property>
                    <!--激活profile的属性的名称-->
                    <name>mavenVersion</name>
                    <!--激活profile的属性的值 -->
                    <value>2.0.3</value>
                </property>
                <!-- 提供一个文件名，通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在，如果不存在则激活profile。另一方面，exists则会检查文件是否存在，如果存在则激活profile。 -->
                <file>
                    <!--如果指定的文件存在，则激活profile。 -->
                    <exists>${basedir}/file2.properties</exists>
                    <!--如果指定的文件不存在，则激活profile。-->
                    <missing>${basedir}/file1.properties</missing>
                </file>
            </activation>
            <!-- 对应profile的扩展属性列表。Maven属性和Ant中的属性一样，可以用来存放一些值。这些值可以在POM中的任何地方使用标记${X}来使用，这里X是指属性的名称。属性有五种不同的形式，并且都能在settings.xml文件中访问。
				1. env.X: 在一个变量前加上"env."的前缀，会返回一个shell环境变量。如,"env.PATH"指代了$path环境变量（在Windows上是%PATH%）。
				2. project.x：指代了POM中对应的元素值。如: <project><version>1.0</version></project>。通过${project.version}获得version的值。
				3. settings.x: 指代了settings.xml中对应元素的值。如：<settings><offline>false</offline></settings>通过 ${settings.offline}获得offline的值。
				4. Java System Properties: 所有可通过java.lang.System.getProperties()访问的属性都能在POM中使用该形式访问。如 ${java.home}。
				5. x: 在<properties/>元素中，或者外部文件中设置，以${someVar}的形式使用。 -->
            <properties>
                <user.install>${user.home}/our-project</user.install>
            </properties>
            <!--note：如果该profile被激活，则可以再POM中使用${user.install}。 -->
            <!-- 远程仓库列表，它是Maven用来填充构建系统本地仓库所使用的一组远程项目。 -->
            <repositories>
                <!--包含需要连接到远程仓库的信息 -->
                <repository>
                    <!--远程仓库唯一标识-->
                    <id>codehausSnapshots</id>
                    <!--远程仓库名称 -->
                    <name>Codehaus Snapshots</name>
                    <!--如何处理远程仓库里发布版本的下载-->
                    <releases>
                        <!-- true或者false表示该仓库是否为下载某种类型构件（发布版，快照版）开启。 -->
                        <enabled>false</enabled>
                        <!-- 指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。选项是：always（一直），daily（默认，每日），interval：X（这里X是以分钟为单位的时间间隔），或者never（从不）。 -->
                        <updatePolicy>always</updatePolicy>
                        <!--当Maven验证构件校验文件失败时该怎么做：ignore（忽略），fail（失败），或者warn（警告）。-->
                        <checksumPolicy>warn</checksumPolicy>
                    </releases>
                    <!-- 如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置，POM就可以在每个单独的仓库中，
				为每种类型的构件采取不同的策略。如，可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素-->
                    <snapshots>
                        <enabled/>
                        <updatePolicy/>
                        <checksumPolicy/>
                    </snapshots>
                    <!--远程仓库URL，按protocol://hostname/path形式 -->
                    <url>http://snapshots.maven.codehaus.org/maven2</url>
                    <!--定位和排序构件的仓库布局类型-可以是default（默认）或者legacy（遗留）。Maven 2为其仓库提供了一个默认的布局；然而，Maven 1.x有一种不同的布局。可以使用该元素指定布局是default（默认）还是legacy（遗留）。 -->
                    <layout>default</layout>
                </repository>
            </repositories>
            <!-- 发现插件的远程仓库列表。仓库是两种主要构件的家。第一种构件被用作其它构件的依赖。这是中央仓库中存储的大部分构件类型。
			另一种构件类型是插件。Maven插件是一种特殊类型的构件。因此，插件仓库独立于其它仓库。pluginRepositories元素的结构和repositories元素的结构类似。每个pluginRepository元素指定一个Maven可以用来寻找新插件的远程地址。-->
            <pluginRepositories>
                <!--包含需要连接到远程插件仓库的信息.参见profiles/profile/repositories/repository元素的说明-->
                <pluginRepository>
                    <releases>
                        <enabled/>
                        <updatePolicy/>
                        <checksumPolicy/>
                    </releases>
                    <snapshots>
                        <enabled/>
                        <updatePolicy/>
                        <checksumPolicy/>
                    </snapshots>
                    <id/>
                    <name/>
                    <url/>
                    <layout/>
                </pluginRepository>
            </pluginRepositories>
        </profile>
        <!-- Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |-->
        <profile>
            <id>env-dev</id>
            <!-- ... -->
        </profile>
    </profiles>
    <!--手动激活profiles的列表，按照profile被应用的顺序定义activeProfile。该元素包含了一组activeProfile元素，每个activeProfile都含有一个profile id。任何在activeProfile中定义的profile id，不论环境设置如何，其对应的profile都会被激活。如果没有匹配的profile，则什么都不会发生。如，env-test是一个activeProfile， 则在pom.xml（或者profile.xml）中对应id的profile会被激活。如果运行过程中找不到这样一个profile，Maven则会像往常一样运行。 -->
    <activeProfiles>
        <activeProfile>env-test</activeProfile>
    </activeProfiles>
</settings>