Maven中一些常见的配置说明

在学习maven的时候,有的时候我们会对pom.xml中的配置不太了解,所以现在我就把一些典型的配置说明下:


基础配置

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  3.   
  4.     <!-- 模型版本。maven2.0必须是这样写,现在是maven2唯一支持的版本 -->  
  5.     <modelVersion>4.0.0</modelVersion>  
  6.   
  7.     <!-- 公司或者组织的唯一标志,并且配置时生成的路径也是由此生成, 如com.winner.trade,maven会将该项目打成的jar包放本地路径:/com/winner/trade -->  
  8.     <groupId>com.winner.trade</groupId>  
  9.   
  10.     <!-- 本项目的唯一ID,一个groupId下面可能多个项目,就是靠artifactId来区分的 -->  
  11.     <artifactId>trade-core</artifactId>  
  12.   
  13.     <!-- 本项目目前所处的版本号 -->  
  14.     <version>1.0.0-SNAPSHOT</version>  
  15.   
  16.     <!-- 打包的机制,如pom,jar, maven-plugin, ejb, war, ear, rar, par,默认为jar -->  
  17.     <packaging>jar</packaging>  
  18.   
  19.     <!-- 帮助定义构件输出的一些附属构件,附属构件与主构件对应,有时候需要加上classifier才能唯一的确定该构件 不能直接定义项目的classifer,因为附属构件不是项目直接默认生成的,而是由附加的插件帮助生成的 -->  
  20.     <classifier>...</classifier>  
  21.   
  22.     <!-- 定义本项目的依赖关系 -->  
  23.     <dependencies>  
  24.   
  25.         <!-- 每个dependency都对应这一个jar包 -->  
  26.         <dependency>  
  27.   
  28.             <!--一般情况下,maven是通过groupId、artifactId、version这三个元素值(俗称坐标)来检索该构件, 然后引入你的工程。如果别人想引用你现在开发的这个项目(前提是已开发完毕并发布到了远程仓库),-->   
  29.             <!--就需要在他的pom文件中新建一个dependency节点,将本项目的groupId、artifactId、version写入, maven就会把你上传的jar包下载到他的本地 -->  
  30.             <groupId>com.winner.trade</groupId>  
  31.             <artifactId>trade-test</artifactId>  
  32.             <version>1.0.0-SNAPSHOT</version>  
  33.   
  34.             <!-- maven认为,程序对外部的依赖会随着程序的所处阶段和应用场景而变化,所以maven中的依赖关系有作用域(scope)的限制。 -->  
  35.             <!--scope包含如下的取值:compile(编译范围)、provided(已提供范围)、runtime(运行时范围)、test(测试范围)、system(系统范围) -->  
  36.             <scope>test</scope>  
  37.   
  38.             <!-- 设置指依赖是否可选,默认为false,即子项目默认都继承:为true,则子项目必需显示的引入,与dependencyManagement里定义的依赖类似  -->  
  39.             <optional>false</optional>  
  40.   
  41.             <!-- 屏蔽依赖关系。 比如项目中使用的libA依赖某个库的1.0版,libB依赖某个库的2.0版,现在想统一使用2.0版,就应该屏蔽掉对1.0版的依赖 -->  
  42.             <exclusions>  
  43.                 <exclusion>  
  44.                     <groupId>org.slf4j</groupId>  
  45.                     <artifactId>slf4j-api</artifactId>  
  46.                 </exclusion>  
  47.             </exclusions>  
  48.   
  49.         </dependency>  
  50.   
  51.     </dependencies>  
  52.   
  53.     <!-- 为pom定义一些常量,在pom中的其它地方可以直接引用 使用方式 如下 :${file.encoding} -->  
  54.     <properties>  
  55.         <file.encoding>UTF-8</file.encoding>  
  56.         <java.source.version>1.5</java.source.version>  
  57.         <java.target.version>1.5</java.target.version>  
  58.     </properties>  
  59.   
  60.     </project>

这里有必要对一个不太常用的属性classifier做一下解释,因为有时候引用某个jar包,classifier不写的话会报错。

  1. <dependency>  
  2.            <groupId>net.sf.json-lib</groupId>  
  3.            <artifactId>json-lib</artifactId>  
  4.             <version>2.4</version>  
  5.            <classifier>jdk15</classifier>  
  6. </dependency>

构建配置



  1. <build>  
  2.   
  3.     <!-- 产生的构件的文件名,默认值是${artifactId}-${version}。 -->  
  4.     <finalName>myPorjectName</finalName>  
  5.   
  6.     <!-- 构建产生的所有文件存放的目录,默认为${basedir}/target,即项目根目录下的target -->  
  7.     <directory>${basedir}/target</directory>  
  8.   
  9.     <!--当项目没有规定目标(Maven2叫做阶段(phase))时的默认值, -->  
  10.     <!--必须跟命令行上的参数相同例如jar:jar,或者与某个阶段(phase)相同例如install、compile等 -->  
  11.     <defaultGoal>install</defaultGoal>  
  12.   
  13.     <!--当filtering开关打开时,使用到的过滤器属性文件列表。 -->  
  14.     <!--项目配置信息中诸如${spring.version}之类的占位符会被属性文件中的实际值替换掉 -->  
  15.     <filters>  
  16.         <filter>../filter.properties</filter>  
  17.     </filters>  
  18.   
  19.     <!--项目相关的所有资源路径列表,例如和项目相关的配置文件、属性文件,这些资源被包含在最终的打包文件里。 -->  
  20.     <resources>  
  21.         <resource>  
  22.   
  23.             <!--描述了资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory})。 -->  
  24.             <!--举个例子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为org/apache/maven/messages。 -->  
  25.             <!--然而,如果你只是想把资源放到源码目录结构里,就不需要该配置。 -->  
  26.             <targetPath>resources</targetPath>  
  27.   
  28.             <!--是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素里列出。 -->  
  29.             <filtering>true</filtering>  
  30.   
  31.             <!--描述存放资源的目录,该路径相对POM路径 -->  
  32.             <directory>src/main/resources</directory>  
  33.   
  34.             <!--包含的模式列表 -->  
  35.             <includes>  
  36.                 <include>**/*.properties</include>  
  37.                 <include>**/*.xml</include>  
  38.             </includes>  
  39.   
  40.             <!--排除的模式列表 如果<include>与<exclude>划定的范围存在冲突,以<exclude>为准 -->  
  41.             <excludes>  
  42.                 <exclude>jdbc.properties</exclude>  
  43.             </excludes>  
  44.   
  45.         </resource>  
  46.     </resources>  
  47.   
  48.     <!--单元测试相关的所有资源路径,配制方法与resources类似 -->  
  49.     <testResources>  
  50.         <testResource>  
  51.             <targetPath />  
  52.             <filtering />  
  53.             <directory />  
  54.             <includes />  
  55.             <excludes />  
  56.         </testResource>  
  57.     </testResources>  
  58.   
  59.     <!--项目源码目录,当构建项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->  
  60.     <sourceDirectory>${basedir}\src\main\java</sourceDirectory>  
  61.   
  62.     <!--项目脚本源码目录,该目录和源码目录不同, <!-- 绝大多数情况下,该目录下的内容会被拷贝到输出目录(因为脚本是被解释的,而不是被编译的)。 -->  
  63.     <scriptSourceDirectory>${basedir}\src\main\scripts  
  64.     </scriptSourceDirectory>  
  65.   
  66.     <!--项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->  
  67.     <testSourceDirectory>${basedir}\src\test\java</testSourceDirectory>  
  68.   
  69.     <!--被编译过的应用程序class文件存放的目录。 -->  
  70.     <outputDirectory>${basedir}\target\classes</outputDirectory>  
  71.   
  72.     <!--被编译过的测试class文件存放的目录。 -->  
  73.     <testOutputDirectory>${basedir}\target\test-classes  
  74.     </testOutputDirectory>  
  75.   
  76.     <!--项目的一系列构建扩展,它们是一系列build过程中要使用的产品,会包含在running bulid‘s classpath里面。 -->  
  77.     <!--他们可以开启extensions,也可以通过提供条件来激活plugins。 -->  
  78.     <!--简单来讲,extensions是在build过程被激活的产品 -->  
  79.     <extensions>  
  80.   
  81.         <!--例如,通常情况下,程序开发完成后部署到线上Linux服务器,可能需要经历打包、 -->  
  82.         <!--将包文件传到服务器、SSH连上服务器、敲命令启动程序等一系列繁琐的步骤。 -->  
  83.         <!--实际上这些步骤都可以通过Maven的一个插件 wagon-maven-plugin 来自动完成 -->  
  84.         <!--下面的扩展插件wagon-ssh用于通过SSH的方式连接远程服务器, -->  
  85.         <!--类似的还有支持ftp方式的wagon-ftp插件 -->  
  86.         <extension>  
  87.             <groupId>org.apache.maven.wagon</groupId>  
  88.             <artifactId>wagon-ssh</artifactId>  
  89.             <version>2.8</version>  
  90.         </extension>  
  91.   
  92.     </extensions>  
  93.   
  94.     <!--使用的插件列表 。 -->  
  95.     <plugins>  
  96.         <plugin>  
  97.             <groupId></groupId>  
  98.             <artifactId>maven-assembly-plugin</artifactId>  
  99.             <version>2.5.5</version>  
  100.   
  101.             <!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 -->  
  102.             <executions>  
  103.                 <execution>  
  104.   
  105.                     <!--执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 -->  
  106.                     <id>assembly</id>  
  107.   
  108.                     <!--绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 -->  
  109.                     <phase>package</phase>  
  110.   
  111.                     <!--配置的执行目标 -->  
  112.                     <goals>  
  113.                         <goal>single</goal>  
  114.                     </goals>  
  115.   
  116.                     <!--配置是否被传播到子POM -->  
  117.                     <inherited>false</inherited>  
  118.   
  119.                 </execution>  
  120.             </executions>  
  121.   
  122.             <!--作为DOM对象的配置,配置项因插件而异 -->  
  123.             <configuration>  
  124.                 <finalName>${finalName}</finalName>  
  125.                 <appendAssemblyId>false</appendAssemblyId>  
  126.                 <descriptor>assembly.xml</descriptor>  
  127.             </configuration>  
  128.   
  129.             <!--是否从该插件下载Maven扩展(例如打包和类型处理器), -->  
  130.             <!--由于性能原因,只有在真需要下载时,该元素才被设置成true。 -->  
  131.             <extensions>false</extensions>  
  132.   
  133.             <!--项目引入插件所需要的额外依赖 -->  
  134.             <dependencies>  
  135.                 <dependency>...</dependency>  
  136.             </dependencies>  
  137.   
  138.             <!--任何配置是否被传播到子项目 -->  
  139.             <inherited>true</inherited>  
  140.   
  141.         </plugin>  
  142.     </plugins>  
  143.   
  144.     <!--主要定义插件的共同元素、扩展元素集合,类似于dependencyManagement, -->  
  145.     <!--所有继承于此项目的子项目都能使用。该插件配置项直到被引用时才会被解析或绑定到生命周期。 -->  
  146.     <!--给定插件的任何本地配置都会覆盖这里的配置 -->  
  147.     <pluginManagement>  
  148.         <plugins>...</plugins>  
  149.     </pluginManagement>  
  150.   
  151. </build> 




;