Maven jar profile 多環(huán)境

簡(jiǎn)言

為了減少開發(fā)人員反復(fù)修改配置惠啄,考慮在舊項(xiàng)目(非springboot)中使用 maven profile,在此記錄下實(shí)現(xiàn)過程豆瘫。

修改記錄

  1. 之前直接使用 POM 中的 <resource> 標(biāo)簽來控制文件覆蓋不穩(wěn)定铆铆,時(shí)靈時(shí)不靈。導(dǎo)致測(cè)試扩借、生產(chǎn)環(huán)境jar包內(nèi)配置文件不正確〗凡遥現(xiàn)在糾正為使用resource插件缤至,如果給讀到的讀者帶來了疑惑,請(qǐng)多諒解。

  2. 由 copy-resource 改為 antrun领斥。

實(shí)現(xiàn)過程

1.profiles

在pom文件中加入profiles配置嫉到。根據(jù)項(xiàng)目的需要,我配置3個(gè)profile節(jié)點(diǎn)月洛,分別對(duì)應(yīng)開發(fā)何恶、測(cè)試和生產(chǎn)3種環(huán)境。代碼如下:

<!-- 多環(huán)境配置 -->
    <profiles>
        <profile>
            <id>default</id>
            <properties>
                <package.environment.conf>src/main/filters/conf/local</package.environment.conf>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <package.environment.conf>src/main/filters/conf/test</package.environment.conf>
            </properties>
        </profile>
        <profile>
            <id>production</id>
            <properties>    
                <package.environment.conf>src/main/filters/conf/production</package.environment.conf>
            </properties>
        </profile>
    </profiles>

簡(jiǎn)單解釋下代碼中各個(gè)節(jié)點(diǎn):

  1. id節(jié)點(diǎn)自定義嚼黔,定義什么细层,使用打包命令時(shí)就用什么。如test唬涧,打包時(shí)就是用mvn package -Ptest疫赎。
  2. properties下屬子節(jié)點(diǎn)自定義,名稱自定義碎节,結(jié)合下文中的<buile> <resource>使用捧搞。子節(jié)點(diǎn)多少視項(xiàng)目實(shí)際情況而定。
  3. activation 缺省設(shè)置狮荔,如果直接使用mvn package時(shí),默認(rèn)會(huì)使用defaule節(jié)點(diǎn)下的配置文件。如果不設(shè)置此節(jié)點(diǎn)乐设,那么使用打包命令時(shí)需要顯示執(zhí)行id稚晚。

加入這段代碼的目的是:在打包時(shí),將目標(biāo)環(huán)境對(duì)應(yīng)目錄下的配置文件覆蓋項(xiàng)目原有的配置文件雅采,以此來達(dá)到自動(dòng)修改文件题涨。舉例說明下,通過mvn package -Ptest打包总滩,目標(biāo)環(huán)境為test纲堵。那么在打包的時(shí)候,會(huì)使用test定義的目錄闰渔,即src/main/filters/conf/test席函。然后,會(huì)將該目錄下的配置文件覆蓋項(xiàng)目原有的配置文件冈涧。

2.build

定義過 profiles 后茂附,就需要定義 build 節(jié)點(diǎn)內(nèi)容了。兩者的關(guān)系就是后者調(diào)用前者督弓。

  <build>
        <finalName>${project.artifactId}-${project.version}</finalName>
        <resources>
            <resource>
                <directory>src/main/java</directory>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                                <excludes>
                    <exclude>db/*</exclude>
                    <exclude>*config.properties</exclude>
                    <exclude>*spring.xml</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src/main/filters</directory>
                <excludes>
                    <exclude>conf/local/*</exclude>
                    <exclude>conf/production/*</exclude>
                    <exclude>conf/test/*</exclude>
                </excludes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.1.0</version>
                <executions>
                    <execution>
                        <id>copy-resources</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${basedir}/target/classes</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>${package.environment.conf}</directory>
                                    <filtering>true</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

2.1 copy-resource

下面的代碼就是對(duì) profiles 節(jié)點(diǎn)定義內(nèi)容的調(diào)用:

<phase>prepare-package</phase>
<goals>
    <goal>copy-resources</goal>
</goals>
<configuration>
    <outputDirectory>${basedir}/target/classes</outputDirectory>
    <resources>
        <resource>
            <directory>${package.environment.conf}</directory>
            <filtering>true</filtering>
        </resource>
    </resources>
</configuration>

<directory>${package.environment.conf}</directory> 配置就是打包命令中指定的profile節(jié)點(diǎn)中定義屬性的目錄营曼。舉個(gè)例子:
“mvn package -Ptest”,使用此打包命令時(shí)愚隧,會(huì)先去找對(duì)應(yīng)的profile節(jié)點(diǎn)蒂阱,即:

<profile>
    <id>test</id>
    <properties>
        <package.environment.conf>src/main/filters/conf/test</package.environment.conf>
    </properties>
</profile>

找到節(jié)點(diǎn)后,${package.environment.conf} 會(huì)引用 package.environment.conf 所定義的內(nèi)容,即:src/main/filters/conf/test录煤。

2.2 phase

<phase> 翻譯為階段鳄厌,即在什么時(shí)候?qū)?test 環(huán)境下的文件覆蓋原來的配置文件,在這里為了保證打包時(shí)能選擇正確的配置文件妈踊,設(shè)置為打包準(zhǔn)備階段了嚎,即 prepare-package

2.3 outputDirectory

<outputDirectory>就是目標(biāo)文件夾廊营,即要將src/main/filters/conf/test目錄下的文件歪泳,放到${basedir}/src/main/resources下,${basedir} 就是項(xiàng)目文件夾的根路徑露筒。

2.4 copy-resource 改為 antrun

項(xiàng)目背景

項(xiàng)目達(dá)成jar包后夹囚,被其他項(xiàng)目模塊引用了。所以使用 IDEA 時(shí)需要開啟 maven 委托邀窃,maven 配置才能生效荸哟,打包時(shí)間略長(zhǎng)且不能使用 JRebel,給開發(fā)帶來不便瞬捕。所以根據(jù)實(shí)際需要改為使用 antrun 插件的 copy 來達(dá)到相同的目的鞍历。

<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-antrun-plugin</artifactId>
        <executions>
            <execution>
                <id>prepare-copy-resources</id>
                <phase>package</phase>
                <goals>
                    <goal>run</goal>
                </goals>
                <configuration>
                    <tasks>
                        <copy file="${package.environment.conf}/spring-application.xml" tofile="${basedir}/target/classes/spring-application.xml" overwrite="true" />
                        <copy file="${package.environment.conf}/config.properties" tofile="${basedir}/target/classes/config.properties" overwrite="true" />
                    </tasks>
                </configuration>
            </execution>
        </executions>
    </plugin>
</plugins>

結(jié)語

至此,項(xiàng)目工程打包時(shí)肪虎,通過指定profile自動(dòng)修改配置文件的目的已經(jīng)實(shí)現(xiàn)劣砍。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市扇救,隨后出現(xiàn)的幾起案子刑枝,更是在濱河造成了極大的恐慌,老刑警劉巖迅腔,帶你破解...
    沈念sama閱讀 211,042評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件装畅,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡沧烈,警方通過查閱死者的電腦和手機(jī)掠兄,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,996評(píng)論 2 384
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來锌雀,“玉大人蚂夕,你說我怎么就攤上這事∫改妫” “怎么了婿牍?”我有些...
    開封第一講書人閱讀 156,674評(píng)論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)惩歉。 經(jīng)常有香客問我等脂,道長(zhǎng)俏蛮,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,340評(píng)論 1 283
  • 正文 為了忘掉前任慎菲,我火速辦了婚禮嫁蛇,結(jié)果婚禮上锨并,老公的妹妹穿的比我還像新娘露该。我一直安慰自己,他們只是感情好第煮,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,404評(píng)論 5 384
  • 文/花漫 我一把揭開白布解幼。 她就那樣靜靜地躺著,像睡著了一般包警。 火紅的嫁衣襯著肌膚如雪撵摆。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,749評(píng)論 1 289
  • 那天害晦,我揣著相機(jī)與錄音特铝,去河邊找鬼。 笑死壹瘟,一個(gè)胖子當(dāng)著我的面吹牛鲫剿,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播稻轨,決...
    沈念sama閱讀 38,902評(píng)論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼灵莲,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了殴俱?” 一聲冷哼從身側(cè)響起政冻,我...
    開封第一講書人閱讀 37,662評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎线欲,沒想到半個(gè)月后明场,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,110評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡李丰,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,451評(píng)論 2 325
  • 正文 我和宋清朗相戀三年榕堰,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片嫌套。...
    茶點(diǎn)故事閱讀 38,577評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡逆屡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出踱讨,到底是詐尸還是另有隱情魏蔗,我是刑警寧澤,帶...
    沈念sama閱讀 34,258評(píng)論 4 328
  • 正文 年R本政府宣布痹筛,位于F島的核電站莺治,受9級(jí)特大地震影響廓鞠,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜谣旁,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,848評(píng)論 3 312
  • 文/蒙蒙 一床佳、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧榄审,春花似錦砌们、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至饼问,卻和暖如春影兽,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背莱革。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評(píng)論 1 264
  • 我被黑心中介騙來泰國(guó)打工峻堰, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人盅视。 一個(gè)月前我還...
    沈念sama閱讀 46,271評(píng)論 2 360
  • 正文 我出身青樓捐名,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親左冬。 傳聞我的和親對(duì)象是個(gè)殘疾皇子桐筏,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,452評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容