Maven resrouce 下的中的filtering作用

filtering 作用

  • 是啥:filtering是maven的resource插件中提供的一个功能。
  • 为啥:想要解决编码过程中的配置文件的变量注入的问题,如:在不同的开发环境下要启用不同的配置属性,如何灵活的切换?filtering为我们提供了方法。
  • 咋用:首先通过上面的例子启动,之后,就可以在pom文件中定义属性,并在resources目录下的配置文件,如application.yml中使用了,具体使用方法见下文详述。

作用一 引入pom和resource 资源文件的变量预编译配置

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
</build>

上面的代码就是对resources目录开启了filtering过滤,不添加filtering ,默认认值为false。那么这个功能到底有什么效果呢?,

为了更深入的了解这个filtering,不妨从是什么?为什么?怎么用?三个方面进行阐述。

1.pom文件 读取pom文件内部的变量

  • 在pom文件内部对变量的应用,都通过 v a l u e n a m e 的方式,比如常见的: {value_name}的方式,比如常见的: valuename的方式,比如常见的:{project.artifactId}

2.application.yml 文件读取application.yml 文件内部的变量方式

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

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

3.yaml文件读取pom文件的变量方式

如果查看spring-boot-starter-parent中的属性栏,就可以看到赫然写着:
<resource.delimiter>@</resource.delimiter>
这代表了什么?这表示,在yaml中如果要引用pom中的属性,直接使用@标识符就行了,用法为@value_of_pom@。

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

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

就是为多个环境进行配置的时候:一般情况下,开发,测试,生产环境是不同的,尤其是其中有一些数据库的配置,服务发现地址的配置,日志文件的位置等都有所区分。

如果每次一换环境,就手动去一点儿点儿改配置,无疑是耗时耗力的,那么有没有一种方法,能够快捷的将环境进行一键切换,能够达到针对不同的运行环境采用不同配置的目的呢?

答案是可以的,就是利用我们的filtering对资源的动态管理。

filtering作为maven-resource插件中的一个功能,其起作用的时机是在maven生命周期中的resource阶段,这是一个对资源做出处理,先于compile的一个阶段。

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>

filtering:决定是否将resources目录下的文件中的tokens(即通过@val@标识的变量)进行参数替换。这里的参数主要有两个来源,一个是来自于pom文件中的properties属性,一个是来源于外部的.properties文件(个人认为这个文件不可与springboot中的配置文件混为一谈)

那么如何引用外部的.properties文件呢?通过另一个标签下的进行路径的指定。

作用二 开启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>

一些maven命令参数

主要用于切换环境的:

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

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

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

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

  • 30
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值