一、簡(jiǎn)介

在此之前，我們首先要明確filtering的概念。

定義

filtering是maven的resource插件中提供的一個(gè)功能。

決定是否將resources目錄下的文件中的tokens（即通過(guò)@val@標(biāo)識(shí)的變量）進(jìn)行參數(shù)替換。

這里的參數(shù)主要有兩個(gè)來(lái)源，一個(gè)是來(lái)自于pom文件中的properties屬性，一個(gè)是來(lái)源于外部的.properties文件（個(gè)人認(rèn)為這個(gè)文件不可與springboot中的配置文件混為一談）。

解決的問(wèn)題

想要解決編碼過(guò)程中的配置文件的變量注入的問(wèn)題，如：在不同的開發(fā)環(huán)境下要啟用不同的配置屬性，如何靈活的切換？filtering為我們提供了方法。

用法

首先通過(guò)上面的例子啟動(dòng)，之后，就可以在pom文件中定義屬性，并在resources目錄下的配置文件，如application.yml中使用了，具體使用方法見下文詳述。

二、使用說(shuō)明

1. 引入pom和resource 資源文件的變量預(yù)編譯配置

示例代碼如下，就是對(duì)resources目錄開啟了filtering過(guò)濾，不添加filtering ，默認(rèn)認(rèn)值為false。

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

了更深入的了解這個(gè)filtering，詳解如下。

1.1 pom文件 讀取pom文件內(nèi)部的變量

在pom文件內(nèi)部對(duì)變量的應(yīng)用，都通過(guò) valuename 的方式。

常見的使用方式如下

• {value_name}
• valuen?ame
• {project.artifactId}

1.2 application.yml 文件讀取application.yml 文件內(nèi)部的變量方式

在application.yml中對(duì)內(nèi)部變量的引用，通常也是使用${value_name}的方式，比如常見的：${server.port}

這樣就導(dǎo)致了一個(gè)沖突，兩種配置文件都用同一套標(biāo)識(shí)符，那yaml文件怎么引入pom中的變量呢，于是就有了resource.delimiter這個(gè)屬性

1.3 yaml文件讀取pom文件的變量方式

如果查看spring-boot-starter-parent中的屬性欄，就可以看到赫然寫著：

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

在yaml中如果要引用pom中的屬性，直接使用@標(biāo)識(shí)符就行了，用法為@value_of_pom@。

就這樣，所以就出現(xiàn)了第三種變量的引用方式：

• 在resources的yaml文件中引用pom中的變量時(shí)，通過(guò)@value_of_pom@進(jìn)行引用（前提是開啟了資源的過(guò)濾filtering）。

1.4 pom文件讀取 .properties文件的變量

在Maven項(xiàng)目的pom.xml中，你可以使用元素來(lái)定義變量，并使用來(lái)指定資源文件的位置。如果你想要在pom.xml中讀取.properties文件中的變量，可以使用Maven的filtering功能。

以下是一個(gè)簡(jiǎn)單的例子：

在src/main/resources目錄下創(chuàng)建一個(gè).properties文件，比如config.properties。src/main/resources/config.properties

database.url=jdbc:mysql://localhost/mydb
database.user=myuser
database.password=mypassword

在pom.xml中配置資源過(guò)濾和元素。

<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 打包資源文件的過(guò)濾

通過(guò)includes和 excludes 標(biāo)簽進(jìn)行打包資源文件的過(guò)濾

<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標(biāo)簽的值默認(rèn)是false，在這里可寫可不寫-->
                <filtering>false</filtering>
                <excludes>
                    <exclude>a.properties</exclude>
                </excludes>
            </resource>
        </resources>
</build>

3. maven命令參數(shù)

主要用于切換環(huán)境的：

//這表示給pom中的file變量賦值為了my-setting-file，如果這個(gè)是設(shè)定的filter的文件名，即會(huì)引入my-setting-file中的設(shè)定參數(shù)。
mvn resources:resources -Dfile=my-setting-file
//這表示啟用test，jdk8兩個(gè)profile，不激活os-windows。
mvn clean package -Ptest,jdk8,!os-windows

到此這篇關(guān)于Maven resrouce下filtering的使用方法的文章就介紹到這了,更多相關(guān)Maven resrouce filtering作用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論