Maven resrouce下filtering作用说明

时间:2024-11-02 17:34:29

一、简介

在此之前,我们首先要明确filtering的概念。

定义

filtering是maven的resource插件中提供的一个功能。

决定是否将resources目录下的文件中的tokens(即通过@val@标识的变量)进行参数替换。

这里的参数主要有两个来源,一个是来自于pom文件中的properties属性,一个是来源于外部的.properties文件(个人认为这个文件不可与springboot中的配置文件混为一谈)。

解决的问题

想要解决编码过程中的配置文件的变量注入的问题,如:在不同的开发环境下要启用不同的配置属性,如何灵活的切换?filtering为我们提供了方法。

用法

首先通过上面的例子启动,之后,就可以在pom文件中定义属性,并在resources目录下的配置文件,如application.yml中使用了,具体使用方法见下文详述。

二、使用说明

1. 引入pom和resource 资源文件的变量预编译配置

示例代码如下,就是对resources目录开启了filtering过滤,不添加filtering ,默认认值为false。

<build>

        <resources>

            <resource>

                <directory>src/main/resources</directory>

                <filtering>true</filtering>

            </resource>

        </resources>

</build>

了更深入的了解这个filtering,详解如下。

1.1 pom文件 读取pom文件内部的变量

在pom文件内部对变量的应用,都通过 valuename 的方式。

常见的使用方式如下

  • {value_name}
  • valuen​ame
  • {project.artifactId}
1.2 application.yml 文件读取application.yml 文件内部的变量方式

在application.yml中对内部变量的引用,通常也是使用${value_name}的方式,比如常见的:${server.port}

这样就导致了一个冲突,两种配置文件都用同一套标识符,那yaml文件怎么引入pom中的变量呢,于是就有了resource.delimiter这个属性

1.3 yaml文件读取pom文件的变量方式

如果查看spring-boot-starter-parent中的属性栏,就可以看到赫然写着:

<resource.delimiter>@</resource.delimiter>

在yaml中如果要引用pom中的属性,直接使用@标识符就行了,用法为@value_of_pom@。

就这样,所以就出现了第三种变量的引用方式:

  • 在resources的yaml文件中引用pom中的变量时,通过@value_of_pom@进行引用(前提是开启了资源的过滤filtering)。
1.4 pom文件读取 .properties文件的变量

在Maven项目的pom.xml中,你可以使用元素来定义变量,并使用来指定资源文件的位置。如果你想要在pom.xml中读取.properties文件中的变量,可以使用Maven的filtering功能。

以下是一个简单的例子:

在src/main/resources目录下创建一个.properties文件,比如config.properties。src/main/resources/config.properties

database.url=jdbc:mysql://localhost/mydb

database.user=myuser

database.password=mypassword

在pom.xml中配置资源过滤和元素。

<project>

    ...

    <properties>

        <database.url>${database.url}</database.url>

        <database.user>${database.user}</database.user>

        <database.password>${database.password}</database.password>

    </properties>

    <build>

        <resources>

            <resource>

                <directory>src/main/resources</directory>

                <filtering>true</filtering>

            </resource>

        </resources>

    </build>

    ...

</project>

2. 开启resource 打包资源文件的过滤

通过includes和 excludes 标签进行打包资源文件的过滤

<build>

        <resources>

            <resource>

                <directory>src/main/resources</directory>

                <filtering>true</filtering>

                <includes>

                    <include>a.properties</include>

                </includes>

            </resource>

            <resource>

                <directory>src/main/resources</directory>

                <!--filtering标签的值默认是false,在这里可写可不写-->

                <filtering>false</filtering>

                <excludes>

                    <exclude>a.properties</exclude>

                </excludes>

            </resource>

        </resources>

</build>

3. maven命令参数

主要用于切换环境的:

//这表示给pom中的file变量赋值为了my-setting-file,如果这个是设定的filter的文件名,即会引入my-setting-file中的设定参数。

mvn resources:resources -Dfile=my-setting-file



//这表示启用test,jdk8两个profile,不激活os-windows。

mvn clean package -Ptest,jdk8,!os-windows