第九节：Maven中的Profile

Maven属性：

     Maven中一共有6类属性：

• 内置属性：主要有两个常用内置属性：
  • ${basedir}：表示项目根目录，即包含pom.xml文件的目录
  • ${version}：表示项目版本
• POM属性：POM中对应元素的值。例如：${project.artifactId}对应了<project><artifactId>元素的值，常用的POM属性包括：
  • ${project.build.sourceDirectory}：项目的主源码目录，默认为src/main/java/
  • ${project.build.testSourceDirectory}：项目的测试源码目录，默认为/src/test/java/
  • ${project.build.directory}：项目构建输出目录，默认为target/
  • ${project.outputDirectory}：项目主代码编译输出目录，默认为target/classes/
  • ${project.testOutputDirectory}：项目测试代码编译输出目录，默认为target/testclasses/
  • ${project.groupId}：项目的groupId
  • ${project.artifactId}：项目的artifactId
  • ${project.version}：项目的version，与${version}等价
  • ${project.build.finalName}：项目打包输出文件的名称，默认为${project.artifactId}${project.version}.

     这些属性都对应了一个POM元素，它们中的一些属性的默认值都是在超级POM中定义的。

• 自定义属性：在POM中<properties>元素下自定义的Maven属性。例如：
  <project>  
  <properties>
  <my.prop>hello</my.prop>     
  </properties> 
  </project>
  然后在POM中其他地方使用${my.prop}的时候，就会被替换成hello。
• Settings属性：与POM属性同理，用户使用以settings.开头的属性引用settings.xml文件中XML元素的值，如${settings.localRepository}指向用户本地仓库的地址。
• Java系统属性：所有Java系统属性都可以使用Maven属性引用，例如：${user.home} 指向了用户目录。可以通过命令行mvn help:system查看所有的Java系统属性
• 环境变量属性：所有环境变量都可以使用以env.开头的Maven属性引用。例如：${env.JAVA_HOME} 指代了JAVA_HOME环境变量的值。也可以通过命令行mvn help:system查看所有环境变量。

资源过滤：

     我们在实际开发的时候可能会遇到这样的情况，开发，测试所使用的数据库是不一样的，我们当然可以针对不同的情况修改源码，但是更好的方式是使用profile动态得配置他们，即把不同情况的数据库地址，密码等用Maven属性来表示，默认情况下，Maven属性只有在POM中才会被解析， 而不会在项目的源码中被解析。资源过滤就是指让Maven属性在资源文件(src/main/resources、src/test/resources)中也能被解析。在POM中添加下面的配置便可以开启资源过滤。

     我们针对开发环境在POM文件中定义一个profile

<profiles>  
  <profile>  
  <id>dev</id>  
    <properties>
     <db.driver>com.mysql.jdbc.Driver</db.driver>
     <db.url>jdbc:mysql://192.168.1.100:3306/test</db.driver>
     <db.username>dev</db.username>
     <db.password>dev</db.password>
    </properties>
  </profile>  
</profiles> 

     然后继续在POM文件配置：

<build>  
    <resources>  
        <resource>  
            <directory>${project.basedir}/src/main/resources</directory>  
            <filtering>true</filtering>  
        </resource>  
    </resources>  
    <testResources>  
        <testResource>  
            <directory>${project.basedir}/src/test/resources</directory>  
            <filtering>true</filtering>  
        </testResource>  
    </testResources>  
</build>  

     最后我们只需在命令行激活profile，Maven就能在构件项目的时候使用profile中的属性值替换数据库配置文件中的属于引用。命令行如下：

$ mvn clean install -Pdev

     mvn的 -P 参数表示在命令行激活一个profile，这里激活了id为dev的profile

     Maven除了可以对主资源目录、测试资源目录过滤外，还能对Web项目的资源目录(如css、js目录)进行过滤。这时需要对maven-war-plugin插件进行配置

<plugin>  
    <groupId>org.apache.maven.plugins</groupId>  
    <artifactId>maven-war-plugin</artifactId>  
    <version>2.1-beta-1</version>  
    <configuration>  
        <webResources>  
            <resource>  
                <filtering>true</filtering>  
                <directory>src/main/webapp</directory>  
                <includes>  
                    <include>**/*.css</include>  
                    <include>**/*.js</include>  
                </includes>  
            </resource>  
        </webResources>  
    </configuration>  
</plugin>

Maven Profile：

     背景：项目在不同环境下构建是很不同的，有些环境需要配置插件使用本地文件，有些需要使用特定版本的依赖，所以为了能让构建在各个环境下方便得移植，Maven引入了profile， 每个Profile可以看作是POM的一部分配置，我们可以根据不同的环境应用不同的Profile，从而达到不同环境使用不同的POM配置的目的。

     Profile的种类： profile可以声明在以下这三个文件中：

• pom.xml：很显然，这里声明的profile只对当前项目有效。
• 用户settings.xml：.m2/settings.xml中的profile对该用户的Maven项目有效
• 全局settings.xml：conf/settings.xml，对本机上所有Maven项目有效

    

     我们要注意，pom.xml中的profile能够随着pom.xml一起被提交到代码仓库中，被Maven安装到本地仓库，部署到远程仓库。

profile在pom.xml中可声明的元素在settings.xml中可声明的元素是不一样的。

• profile在pom.xml中可声明的元素：
  • <repositories></repositories>：仓库地址
  • <pluginRepositories></pluginRepositories>：插件仓库地址
  • <distributionManagement></distributionManagement>：部署仓库地址
  • <dependencies></dependencies>：项目依赖
  • <dependencyManagement></dependencyManagement>：项目依赖
  • <modules></modules>：项目聚合配置
  • <properties></properties>：自定义的属性
  • <reporting></reporting>：项目报告位置
  • 还有build元素下面的子元素，主要包括：
  • <plugins></plugins>：插件配置
  • <defaultGoal></defaultGoal>
  • <resources></resources>：项目资源目录
  • <testResources></testResources>：测试资源目录
  • <finalName></finalName>：项目构件的默认名称

     与pom.xml中的profile对应的，是其他两种profile，由于他们不是跟特点的项目绑定在一起的，所以不允许他们修改和添加大部分的POM元素。例如：有一个项目A，我们在自己的settings.xml中定义了一个profile，并且在这个profile中声明了几个插件和依赖，然后通过激活profile的方式将项目A构建成功了。但是当别人拿到项目A的源码时，因为没有我们settings.xml中profile，这就导致了构建失败。

• 所以在pom.xml外部的profile中只能声明以下属性：
  • <repositories></repositories>：仓库地址
  • <pluginRepositories></pluginRepositories>：插件仓库地址
  • <properties></properties>：自定义的属性

     激活Profile：

• 命令行方式激活：命令行参数 -P 加上profile的id来激活，多个id以逗号分隔，如有两个profile id为devx和devy的profile：

  mvn clean install  -Pdevx,devy

• settings文件显式激活：通过配置settings.xml文件中activeProfile元素，可以使其配置的profile对于所有项目都处于激活状态：
  

  <activeProfiles>
     <activeProfile>devx</activeProfile>
     <activeProfile>devy</activeProfile>
  </activeProfiles>

• 系统属性激活：用户可以配置当某系统属性存在或其值等于期望值时激活profile，如：
  

  <profiles>  
      <profile>  
          <activation>  
              <property>  
                  <name>actProp</name>  
                  <value>x</value>  
              </property>  
          </activation>  
      </profile>  
  </profiles>  
  

  然后用户可以在命令行声明属性且多个profile可以使用同一个系统属性来激活：
  

  mvn clean install -DactProp=x 

• 操作系统环境激活：如果构建在不同的操作系统存在差异，则用户可以把这些差异写进profile里，然后根据不同的操作系统来激活不同的profile，其中family的值包括windows,UNIX和mac。
  

  <profiles>  
      <profile>  
          <activation>  
              <os>  
                  <name>Windows XP</name>  
                  <family>Windows</family>  
                  <arch>x86</arch>  
                  <version>5.1.2600</version>  
              </os>  
          </activation>  
      </profile>  
  </profiles> 
  

  
  
• 文件存在与否激活：  Maven根据文件存在与否来激活profile：
  

  <profiles>  
      <profile>  
          <activation>  
              <file>  
                  <missing>x.properties</missing>  
                  <exists>y.properties</exists>  
              </file>  
          </activation>  
      </profile>  
  </profiles>  
  

  
  
• 用户也可以在定义profile的时候默认将其激活：
  

  <profile>  
    <id>dev</id>  
    <activation>  
      <activeByDefault>true</activeByDefault>  
    </activation>  
  </profile> 
  

  但是有一点要注意，如果POM中有任意一个profile通过以上几种方式中的任意一种方式激活了，那么所有的默认激活配置都会失效。

• 注意：插件maven-help-plugin提供了一个目标帮助用户了解当前激活的profile：
  

  mvn help:active-profiles

• 另外还有一个目标来列出当前所有的profile：
  

  mvn help:all-profiles