Maven-profile

概述

profile标签配置可以根据不同的环境参数或命令行参数激活不同的构建处理。

在开发过程中，我们的项目会存在不同的运行环境，比如开发环境、测试环境、生产环境，而我们的项目在不同的环境中，有的配置可能会不一样，比如数据源配置、日志文件配置、以及一些软件运行过程中的基本配置，那每次我们将软件部署到不同的环境时，都需要修改相应的配置文件，这样来回修改，很容易出错，而且浪费劳动力。
profile标签则根据不同的命令行参数动态激活不同的配置。

标签	类型	描述
id	String	构建配置的唯一标识符。即用于命令行激活，也用于在继承时合并具有相同标识符的profile。
activation	activation	自动触发profile的条件逻辑。Activation是profile的开启钥匙。
build	build	项目构建所需的信息。
modules	List<String>	模块
distributionManagement	distributionManagement	项目发布信息
properties	key/value	配置项。一般配置全局环境变量，动态赋值给其他标签元素使用。
dependencyManagement	List<dependency>	默认继承这一项目的依赖信息。
dependencies	List<dependency>	描述所有与这个项目相关的依赖信息。
repositories	List<repository>	依赖和扩展的远程仓库列表。
pluginRepositories	pluginRepository	插件的远程仓库列表
reporting	reporting	描述使用报表插件产生报表的规范

id

构建配置的唯一标识符，用于命令行激活。
项目结构：

定义了dev，pro，test三个文件夹，用来演示maven中profile的使用。

pom文件：

<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">
    
    ...
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <executable>true</executable>
                </configuration>
            </plugin>
        </plugins>

        <resources>
            <resource>
                <directory>src/main/resources/</directory>
                <!--打包时先排除掉三个文件夹-->
                <excludes>
                    <exclude>dev/*</exclude>
                    <exclude>pro/*</exclude>
                    <exclude>test/*</exclude>
                </excludes>
            </resource>
            <resource>
                <!--这里是关键！ 根据不同的环境，把对应文件夹里的配置文件打包-->
                <directory>src/main/resources/${profiles.active}</directory>
            </resource>
        </resources>
    </build>

    <profiles>
        <profile>
            <!--不同环境Profile的唯一id-->
            <id>dev</id>
            <properties>
                <!--profiles.active是自定义的字段，自定义字段可以有多个-->
                <profiles.active>dev</profiles.active>
            </properties>
        </profile>
        <profile>
            <id>pro</id>
            <properties>
                <profiles.active>pro</profiles.active>
            </properties>
            <!--activation用来指定激活方式，可以根据jdk环境，环境变量，文件的存在或缺失-->
            <activation>
                <!--这个字段表示默认激活-->
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <profiles.active>test</profiles.active>
            </properties>
        </profile>
    </profiles>
</project>

定义了多个profile，每个profile都有唯一的id，也包含properties属性。这里为每个profile都定义一个名为profiles.active的properties，每个环境的值不同。当我们打包项目时，激活不同的环境，profiles.active字段就会被赋予不同的值。
该字段值可以应用到许多地方中，可以结合pom文件中resource和filter属性等。

mvn clean package

运行结果：

因为id=prod的activeByDefault=true，默认激活，所以执行后application-prod.properties被打入最终Jar包。

maven打包时通过-P参数，-P后跟上profile的唯一id，指定打包所需id

mvn clean package -Ptest

运行结果：

打包时test的profile被激活，执行后application-test.properties被打入最终Jar包。

注：idea手动执行maven命令的两种方式
1、在idea主界面上面选择 Terminal 窗口

2、Run/Debug Configurations

activation

自动触发profile的条件逻辑。Activation是profile的开启钥匙。能够在某些特定的环境中自动使用某些特定的值；这些环境通过activation元素指定。

标签	类型	描述
activeByDefault	boolean	默认值是false。是否激活的标志
jdk	String	当匹配的jdk被检测到，profile被激活。例如，1.4激活JDK1.4
os	ActivationOS	当匹配的操作系统属性被检测到，profile被激活。
property	ActivationProperty	检测到某一个属性，Profile就会被激活。
file	ActivationFile	提供一个文件名，通过检测该文件的存在或不存在来激活profile。

示例：

<profiles>
   <profile>
     <!--不同环境Profile的唯一id-->
     <id>dev</id>
     <properties>
          <!--profiles.active是自定义的字段，自定义字段可以有多个-->
          <profiles.active>dev</profiles.active>
     </properties>
   </profile>
   <profile>
     <id>pro</id>
     <properties>
          <profiles.active>pro</profiles.active>
     </properties>
     <!--activation用来指定激活方式，可以根据jdk环境，环境变量，文件的存在或缺失-->
     <activation>
         <!--配置默认激活-->
         <activeByDefault>false</activeByDefault>

         <!--当jdk环境版本为1.5时，此profile被激活-->
         <jdk>1.5</jdk>
         
         <!--根据当前操作系统-->
         <os>
            <name>Windows XP</name>
            <family>Windows</family>
            <arch>x86</arch>
            <version>5.1.2600</version>
         </os>
         
         <!--如果Maven检测到某一个属性（其值可以在POM中通过${名称}引用），其拥有对应的名称和值，Profile就会被激活。
         如果值字段是空的，那么存在属性名称字段就会激活profile，否则按区分大小写方式匹配属性值字段。-->
         <property>
           <!--激活profile的属性名称-->
           <name>tsf</name>
           <!--激活profile的属性值-->
           <value>2.0.3</value>
         </property>
         
         <!--通过检测文件的存在或不存在来激活profile-->    
         <file>
          <exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists>
          <missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</missing>
         </file>
     </activation>
   </profile>
   <profile>
      <id>test</id>
      <properties>
         <profiles.active>test</profiles.active>
      </properties>
   </profile>
</profiles>

maven打包时通过-D参数，-D后跟上property内键值对，激活id=pro配置

mvn clean package -Dtsf=2.0.3

运行结果：

os

当匹配的操作系统属性被检测到，profile被激活。

标签	类型	描述
name	String	激活profile的操作系统的名字
family	String	激活profile的操作系统所属家族(如 ‘windows’)
arch	String	激活profile的操作系统体系结构
version	String	激活profile的操作系统版本

property

如果Maven检测到某一个属性（其值可以在POM中通过${名称}引用），其拥有对应的名称和值，Profile就会被激活。

标签	类型	描述
name	String	激活profile的属性名称
value	String	激活profile的属性值

file

提供一个文件名，通过检测该文件的存在或不存在来激活profile。

标签	类型	描述
missing	String	如果指定的文件不存在，则激活profile。
exists	String	如果指定的文件存在，则激活profile。

注：以上activeByDefault、jdk版本、操作系统、系统环境变量、文件的存在或缺失，实际项目可以根据需要选取一种即可。这种的优先级低于maven命令参数指定的方式。

build

构建通用的信息。

标签	类型	描述
filters	List<String>	过滤器属性的列表文件。启用过滤时使用
defaultGoal	String	默认目标Goal
directory	String	生成所有文件的目录。 默认值是target
finalName	String	生成最终文件名。默认值是${artifactId}-${version}
resources	List<resource>	描述了类路径的所有资源。默认是src/main/resources
testResources	List<resource>	描述了类路径的所有测试相关的资源。默认是src/test/resources
pluginManagement	pluginManagement	父项目统一配置的插件列表。这个插件配置不会或绑定到生命周期，除非子模块引用。
plugins	List<plugin>	插件列表