pom文件中的filtering作用

最新推荐文章于 2024-07-13 15:29:04 发布

拿破轮

最新推荐文章于 2024-07-13 15:29:04 发布

阅读量997

点赞数

文章标签： java 开发语言

原文链接：https://www.jianshu.com/p/4410613bb36f

版权

首先，下面是一个简单的filtering的应用

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

上面的代码就是对resources目录开启了filtering过滤，那么这个功能到底有什么效果呢？

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

filtering

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

大致的三个问题已经解决了，那么具体怎么用，有哪几种用法呢？

下面来详谈一下：

一般来说:

在pom文件内部对变量的应用，都通过${value_name}的方式，比如常见的：${project.artifactId}
在application.yml中对内部变量的引用，通常也是使用${value_name}的方式，比如常见的：${server.port}

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

如果查看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的一个阶段。

拓展

一个完整的resource标签如下：

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

其中包含的标签含义如下：

targetPath：指定了资源构建时的目标目录，默认为base direcory，即source目录结构下

原文：This is not required if you simply put the resources in that directory structure at the source

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