Maven resrouce下filtering的使用方法

 更新时间:2024年11月10日 09:38:06   作者:AiFlutter  
本文介绍了Maven的resource插件中的filtering功能,该功能用于在构建过程中将资源目录下的文件中的tokens进行参数替换,tokens的来源可以是pom文件中的properties属性或外部的.properties文件,通过这种方式,可以灵活地切换不同开发环境下的配置属性

一、简介

在此之前,我们首先要明确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

到此这篇关于Maven resrouce下filtering的使用方法的文章就介绍到这了,更多相关Maven resrouce filtering作用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:

相关文章

  • Java基本类型和包装类型的区别

    Java基本类型和包装类型的区别

    这篇文章主要介绍了Java基本类型和包装类型的区别,帮助大家更好的理解和学习Java,感兴趣的朋友可以了解下
    2020-09-09
  • Java异或技操作给任意的文件加密原理及使用详解

    Java异或技操作给任意的文件加密原理及使用详解

    这篇文章主要介绍了Java异或技操作给任意的文件加密原理及使用详解,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • springboot之如何获取项目目录路径

    springboot之如何获取项目目录路径

    这篇文章主要介绍了springboot之如何获取项目目录路径问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05
  • springboot项目获取resources相对路径的方法

    springboot项目获取resources相对路径的方法

    这篇文章主要介绍了springboot项目获取resources相对路径的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • Java如何利用线程池和Redis实现高效数据入库

    Java如何利用线程池和Redis实现高效数据入库

    文章介绍了如何利用线程池和Redis在高并发环境中实现高效的数据入库,通过将数据首先存储在Redis缓存中,然后利用线程池定期批量入库处理,确保系统的性能和稳定性,主要组件包括BatchDataStorageService、CacheService和RedisUtils等
    2025-02-02
  • Struts2实现生成动态验证码并验证实例代码

    Struts2实现生成动态验证码并验证实例代码

    这篇文章主要介绍了Struts2实现生成动态验证码并验证实例代码的相关资料,非常不错具有参考借鉴价值,需要的朋友可以参考下
    2016-06-06
  • Java中switch的三种用法方式小结

    Java中switch的三种用法方式小结

    这篇文章主要介绍了Java中switch的三种用法方式小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • SpringBoot 使用 Sa-Token 完成注解鉴权功能(权限校验)

    SpringBoot 使用 Sa-Token 完成注解鉴权功能(权限校验)

    Sa-Token 是一个轻量级 java 权限认证框架,主要解决登录认证、权限认证、单点登录、OAuth2、微服务网关鉴权 等一系列权限相关问题,这篇文章主要介绍了SpringBoot使用Sa-Token完成注解鉴权功能,需要的朋友可以参考下
    2023-05-05
  • Java编写的实体返回VO工具

    Java编写的实体返回VO工具

    VO(value object)通常用于业务层之间的数据传递,VO的属性是根据当前业务的不同而不同的,也就是说,它的每一个属性都一一对应当前业务逻辑所需要的数据的名称。本文将介绍如何将实体转换为vo对象
    2021-05-05
  • Java 中一个类提供一个默认对象的多种方法

    Java 中一个类提供一个默认对象的多种方法

    这篇文章主要介绍了Java 中一个类提供一个默认对象的多种方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07

最新评论