Maven问题记录包括maven一些基础知识的补缺漏,包括maven的原理性的东西。

 

壹、maven的一些平常容易被忽略的属性。


这是一个普通maven的基本构成

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
	<!-- 模型版本。maven2.0必须是这样写,现在是maven2唯一支持的版本 -->
	<modelVersion>4.0.0</modelVersion>
 
	<!-- 公司或者组织的唯一标志,并且配置时生成的路径也是由此生成, 如com.winner.trade,maven会将该项目打成的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, ejb, war, ear, rar, par,默认为jar -->
	<packaging>jar</packaging>
 
	<!-- 帮助定义构件输出的一些附属构件,附属构件与主构件对应,有时候需要加上classifier才能唯一的确定该构件 不能直接定义项目的classifer,因为附属构件不是项目直接默认生成的,而是由附加的插件帮助生成的 -->
	<classifier>...</classifier>
 
	<!-- 定义本项目的依赖关系 -->
	<dependencies>
 
		<!-- 每个dependency都对应这一个jar包 -->
		<dependency>
 
			<!--一般情况下,maven是通过groupId、artifactId、version这三个元素值(俗称坐标)来检索该构件, 然后引入你的工程。如果别人想引用你现在开发的这个项目(前提是已开发完毕并发布到了远程仓库),--> 
			<!--就需要在他的pom文件中新建一个dependency节点,将本项目的groupId、artifactId、version写入, maven就会把你上传的jar包下载到他的本地 -->
			<groupId>com.winner.trade</groupId>
			<artifactId>trade-test</artifactId>
			<version>1.0.0-SNAPSHOT</version>
 
			<!-- maven认为,程序对外部的依赖会随着程序的所处阶段和应用场景而变化,所以maven中的依赖关系有作用域(scope)的限制。 -->
			<!--scope包含如下的取值:compile(编译范围)、provided(已提供范围)、runtime(运行时范围)、test(测试范围)、system(系统范围) -->
			<scope>test</scope>
 
			<!-- 设置指依赖是否可选,默认为false,即子项目默认都继承:为true,则子项目必需显示的引入,与dependencyManagement里定义的依赖类似  -->
			<optional>false</optional>
 
			<!-- 屏蔽依赖关系。 比如项目中使用的libA依赖某个库的1.0版,libB依赖某个库的2.0版,现在想统一使用2.0版,就应该屏蔽掉对1.0版的依赖 -->
			<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>

我关注的是

1、scope

compile (所有阶段)
默认scope为compile,表示为当前依赖参与项目的编译、测试和运行阶段,属于强依赖。随项目发布
test (适用于编译和测试)
该依赖仅仅参与测试相关的内容,不会随着项目发布。
runtime (适用于运行和测试阶段)
依赖仅参与运行周期中的使用。一般这种类库都是接口与实现相分离的类库,比如JDBC类库。
provided 
该依赖在打包过程中,不需要打进去,这个由运行的环境来提供,比如tomcat或者基础类库等等,事实上,该依赖可以参与编译、测试和运行等周期,与compile等同。区别在于打包阶段进行了exclude操作。
system 
使用上与provided相同,不同之处在于该依赖不从maven仓库中提取,而是从本地文件系统中提取,其会参照systemPath的属性进行提取依赖。
import 
这个是maven2.0.9版本后出的属性,import只能在dependencyManagement的中使用,能解决maven单继承问题,import依赖关系实际上并不参与限制依赖关系的传递性。
 

 

2、systemPath

当引用的jar不在repository中而在本地的时候,就需要用到它。

<dependency>
    <groupid>org.hamcrest</groupid>
    <artifactid>hamcrest-core</artifactid>
    <version>1.5</version>
    <scope>system</scope>
    <systempath>${basedir}/WebContent/WEB-INF/lib/hamcrest-core-1.3.jar</systempath>
</dependency>

3、classfier

Classifier可能是最容易被忽略的Maven特性,但它确实非常重要,我们也需要它来帮助规划坐标。设想这样一个情况,有一个jar项目,就说是 dog-cli-1.0.jar 吧,运行它用户就能在命令行上画一只小狗出来。现在用户的要求是希望你能提供一个zip包,里面不仅包含这个可运行的jar,还得包含源代码和文档,换句话说,这是比较正式的分发包。这个文件名应该是怎样的呢?dog-cli-1.0.zip?不够清楚,仅仅从扩展名很难分辨什么是Maven默认生成的构件,什么是额外配置生成分发包。如果能是dog-cli-1.0-dist.zip就最好了。这里的dist就是classifier,默认Maven只生成一个构件,我们称之为主构件,那当我们希望Maven生成其他附属构件的时候,就能用上classifier。常见的classifier还有如dog-cli-1.0-sources.jar表示源码包,dog-cli-1.0-javadoc.jar表示JavaDoc包等等。

classifier它表示在相同版本下针对不同的环境或者jdk使用的jar,如果配置了这个元素,则会将这个元素名在加在最后来查找相应的jar,例如:

<classfier>  jdk1.8  </classfier>
<classfier>  jdk1.5  </classfier>

贰、build

<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>

 

 

弎、仓库配置

<!--发现依赖和扩展的远程仓库列表。 -->
<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>

以上是一些我常遇见的东西,更多详情可以参照原文链接的博客。

 

伍、dependencies 和 dependencyManagement的区别

dependencyManagement应用场景

当项目的模块较多的时候,尤其是在涉及到父工程和子模块的时候,需要 dependencyManagement。

如果我们的模块很多,而我们又抽象了一层,抽出一个itoo-base-parent来管理子项目的公共的依赖。为了项目的正确运行,必须让所有的子项目使用依赖项的统一版本,必须确保应用的各个项目的依赖项和版本一致,才能保证测试的和发布的是相同的结果。

在我们项目顶层的POM文件中,我们会看到dependencyManagement元素。通过它元素来管理jar包的版本,让子项目中引用一个依赖而不用显示的列出版本号。Maven会沿着父子层次向上走,直到找到一个拥有dependencyManagement元素的项目,然后它就会使用在这个dependencyManagement元素中指定的版本号。

dependencies 的应用场景就很普通了。

 

这样做的好处:统一管理项目的版本号,确保应用的各个项目的依赖和版本一致,才能保证测试的和发布的是相同的成果,因此,在顶层pom中定义共同的依赖关系。同时可以避免在每个使用的子项目中都声明一个版本号,这样想升级或者切换到另一个版本时,只需要在父类容器里更新,不需要任何一个子项目的修改;如果某个子项目需要另外一个版本号时,只需要在dependencies中声明一个版本号即可。子类就会使用子类声明的版本号,不继承于父类版本号。

我们一般做法是:

子模块写dependencies,但是不写版本号,这样它会从父工程找版本号。

父工程写dependencyManagement,用来统一管理版本号。

 

 

陆、作用域

compile,缺省值,适用于所有阶段,会随着项目一起发布
provided,类似compile,期望JDK、容器或使用者会提供这个依赖。
runtime,只在运行时使用,如JDBC驱动,适用运行和测试阶段。
test,只在测试时使用,用于编译和运行测试代码。不会随项目发布。
system,类似provided,需要显式提供包含依赖的jar,Maven不会在Repository中查找它