Maven配置文件的相关总结

野性酷女 2022-05-21 08:37 197阅读 0赞

# 1.[Profile详解][Profile] #

Profile能让你为一个特殊的环境自定义一个特殊的构建；profile使得不同环境间构建的可移植性成为可能。Maven中的profile是一组可选的配置，可以用来设置或者覆盖配置默认值。有了profile，你就可以为不同的环境定制构建。profile可以在pom.xml中配置，并给定一个id。然后你就可以在运行Maven的时候使用的命令行标记告诉Maven运行特定profile中的目标。

## profile简介 ##

profile可以让我们定义一系列的配置信息，然后指定其激活条件。这样我们就可以定义多个profile，然后每个profile对应不同的激活条件和配置信息，从而达到不同环境使用不同配置信息的效果。比如说，我们可以通过profile定义在jdk1.5以上使用一套配置信息，在jdk1.5以下使用另外一套配置信息；或者有时候我们可以通过操作系统的不同来使用不同的配置信息，比如windows下是一套信息，linux下又是另外一套信息，等等。

## profile的定义位置 ##

我们可以有多个地方定义profile。定义的地方不同，它的作用范围也不同。

*  针对于特定项目的profile配置我们可以定义在该项目的pom.xml中。
 *  针对于特定用户的profile配置，我们可以在用户的settings.xml文件中定义profile。该文件在用户家目录下的“.m2”目录下。
 *  全局的profile配置。全局的profile是定义在Maven安装目录下的“conf/settings.xml”文件中的。

## 下面写个案例 ##

1.在项目下pom.xml的project节点下创建了开发环境和线上环境的profile

其中id代表这个环境的唯一标识，下面会用到  
properties下我们我们自己自定义了标签env，内容分别是dev和prd。

activeByDefault=true代表如果不指定某个固定id的profile，那么就使用这个环境

2.下面是我们resources下的目录，有两个目录，dev和prd，在开发时，我们使用dev下的配置文件，部署时候使用prd下的配置文件

![1100855-20170919104217540-2059616866.png][]

3.配置pom.xml,如果直接install，那么就会找到默认的id为dev的这个profile，然后会在里面找env的节点的值，

接着就会执行替换，相当于将src/main/resources/dev这个文件夹下的所有的配置文件打包到classes根目录下。

<build>
            <finalName>springmvc2</finalName>
            <resources>
                <resource>
                    <directory>src/main/resources/${env}</directory>
                </resource>
            </resources>
        </build>

在idea下指定打包时指定profile的id

1第一步

![1100855-20170919105612946-1570925288.png][]

2第二步

![1100855-20170919105634056-1811425214.png][]

3第三步

![1100855-20170919105719884-1872214328.png][]

4第四步，执行打包命令

![1100855-20170919105830243-1426900335.png][]

这个时候target下springmvc项目下的classes根目录下有了env.properties,并且里面内容是我们指定的那个env.properties,

但是发现resources下的aa.properties文件没有被打包进去，那是因为我们只指定了resources/prd下的文件打包到根目录下，并没有指定其他文件

我们在pom.xml下的resources节点下新增规则

<resource>
        <directory>src/main/resources</directory>
        <excludes>
            <exclude>dev/*</exclude>
            <exclude>prd/*</exclude>
        </excludes>
    </resource>

再执行打包就会将resources下的除了dev文件夹和prd文件夹的其他所有文件打包到classes根目录下了

最后注意：如果有其他配置文件在src/main/java目录下，也是可以这样指定的,但是要指定

不然会将java类当配置文件一块放到classes根目录下，加了include就会只匹配符合条件的放到target的classes根目录下

最后放我的所有的配置

<profiles>
            <profile>
                <id>dev</id>
                <properties>
                    <env>dev</env>
                </properties>
                <activation>
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            <profile>
                <id>prd</id>
                <properties>
                    <env>prd</env>
                </properties>
            </profile>
        </profiles>
    
    
        <build>
            <finalName>springmvc</finalName>
            <resources>
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>*.xml</include>
                    </includes>
                </resource>
                <resource>
                    <directory>src/main/resources</directory>
                    <excludes>
                        <exclude>dev/*</exclude>
                        <exclude>prd/*</exclude>
                    </excludes>
                </resource>
                <resource>
                    <directory>src/main/resources/${env}</directory>
                </resource>
            </resources>
        </build>

## 2.Maven build配置 ##

前言： <build >设置，主要用于编译设置

### （1）分类 ###

在Maven的pom.xml文件中，存在如下两种<build>：

（1）全局配置（project build）

针对整个项目的所有情况都有效

（2）配置（profile build）

针对不同的profile配置

说明：

一种<build>被称为Project Build，即是<project>的直接子元素。

另一种<build>被称为Profile Build，即是<profile>的直接子元素。

Profile Build包含了基本的build元素，而Project Build还包含两个特殊的元素，即各种<...Directory>和<extensions>。

### （2） 配置说明 ###

#### 1.基本元素 ####

示例如下

<build>  
      <defaultGoal>install</defaultGoal>  
      <directory>${basedir}/target</directory>  
      <finalName>${artifactId}-${version}</finalName> 
      <filters>
       <filter>filters/filter1.properties</filter>
      </filters> 
      ...
    </build>

1）defaultGoal

执行build任务时，如果没有指定目标，将使用的默认值。

如上配置：在命令行中执行mvn，则相当于执行mvn install

2）directory  
                     build目标文件的存放目录，默认在$\{basedir\}/target目录

3）finalName

build目标文件的名称，默认情况为$\{artifactId\}-$\{version\}

4）filter

定义\*.properties文件，包含一个properties列表，该列表会应用到支持filter的resources中。

也就是说，定义在filter的文件中的name=value键值对，会在build时代替$\{name\}值应用到resources中。

maven的默认filter文件夹为$\{basedir\}/src/main/filters

####  2. Resources配置 ####

用于包含或者排除某些资源文件

<build>  
            ...  
           <resources>  
              <resource>  
                 <targetPath>META-INF/plexus</targetPath>  
                 <filtering>true</filtering>  
                <directory>${basedir}/src/main/plexus</directory>  
                <includes>  
                    <include>configuration.xml</include>  
                </includes>  
                <excludes>  
                    <exclude>**/*.properties</exclude>  
                </excludes>  
             </resource>  
        </resources>  
        <testResources>  
            ...  
        </testResources>  
        ...  
    </build>

1）resources

一个resources元素的列表。每一个都描述与项目关联的文件是什么和在哪里

2）targetPath

指定build后的resource存放的文件夹，默认是basedir。

通常被打包在jar中的resources的目标路径是META-INF

3）filtering

true/false，表示为这个resource，filter是否激活  
             4）directory

定义resource文件所在的文件夹，默认为$\{basedir\}/src/main/resources

5）includes

指定哪些文件将被匹配，以\*作为通配符

6）excludes

指定哪些文件将被忽略

7）testResources

定义和resource类似，只不过在test时使用

####  3 plugins配置 ####

用于指定使用的插件

<build>  
        ...  
        <plugins>  
            <plugin>  
                <groupId>org.apache.maven.plugins</groupId>  
                <artifactId>maven-jar-plugin</artifactId>  
                <version>2.0</version>  
                <extensions>false</extensions>  
                <inherited>true</inherited>  
                <configuration>  
                    <classifier>test</classifier>  
                </configuration>  
                <dependencies>...</dependencies>  
                <executions>...</executions>  
            </plugin>  
        </plugins>  
    </build>

####   4  pluginManagement配置 ####

pluginManagement的配置和plugins的配置是一样的，只是用于继承，使得可以在孩子pom中使用。

父pom：

<build>  
        ...  
        <pluginManagement>  
            <plugins>  
                <plugin>  
                  <groupId>org.apache.maven.plugins</groupId>  
                  <artifactId>maven-jar-plugin</artifactId>  
                  <version>2.2</version>  
                    <executions>  
                        <execution>  
                            <id>pre-process-classes</id>  
                            <phase>compile</phase>  
                            <goals>  
                                <goal>jar</goal>  
                            </goals>  
                            <configuration>  
                                <classifier>pre-process</classifier>  
                            </configuration>  
                        </execution>  
                    </executions>  
                </plugin>  
            </plugins>  
        </pluginManagement>  
        ...  
    </build>

则在子pom中，我们只需要配置：

<build>  
        ...  
        <plugins>  
            <plugin>  
                <groupId>org.apache.maven.plugins</groupId>  
                <artifactId>maven-jar-plugin</artifactId>  
            </plugin>  
        </plugins>  
        ...  
    </build>

这样大大简化了孩子pom的配置

参考：https://www.cnblogs.com/nfcm/p/7550772.html

[Profile]: https://www.cnblogs.com/wxgblogs/p/6696229.html
[1100855-20170919104217540-2059616866.png]: /images/20220521/9178f54a786c4a7b9c63f37a90eeb59b.png
[1100855-20170919105612946-1570925288.png]: /images/20220521/70b783ac3e644bb6b678ae6888e7e9a0.png
[1100855-20170919105634056-1811425214.png]: /images/20220521/30dabe1c50f4430383b9b5d8279f5e94.png
[1100855-20170919105719884-1872214328.png]: /images/20220521/1e55e2db46b44bde86fd9e236c9ff34b.png
[1100855-20170919105830243-1426900335.png]: /images/20220521/4992f317f5224c7bba6a80900aede585.png