Maven插件之portable-config-maven-plugin(不一樣環境打包)

大型項目中,分開發環境、測試環境、生產環境等;html

不一樣環境,配置不一樣,或數據源,或服務器,或數據庫等;mysql

 

問題來了,如何使用Maven針對不一樣的環境來打包呢?git

 

Maven提供了Profile的概念,用來解決此類問題,其原理很簡單,就是使用變量替換;舉個例子來講明,測試項目目錄結構以下圖所示:github

好比開發環境和生產環境的數據庫不一樣,db.properties配置文件內容以下:sql

 

[html]  view plain  copy
 在CODE上查看代碼片派生到個人代碼片
  1. #測試庫  
  2. db.url=192.10.2.168  
  3. db.username=dbtest  
  4. db.password=dbtest  
  5. #正式庫  
  6. #db.url=192.20.1.11  
  7. #db.username=admin  
  8. #db.password=comfreesecurity  


默認開啓測試環境;生產環境打包時,須要手動修改該配置文件.juvenxu說過,手動意味着低效率,高錯誤率!!shell

 

Maven提供的Profile功能,可解決以上問題:數據庫

一、在pom.xml文件中定義兩個不一樣的Profile,分別定義開發環境和生產環境的數據庫信息:apache

[html]  view plain  copy
 在CODE上查看代碼片派生到個人代碼片
  1. <profiles>  
  2.     <profile>  
  3.         <id>kaifa</id>  
  4.         <properties>  
  5.             <db.url>192.10.2.168</db.url>  
  6.             <db.username>dbtest</db.username>  
  7.             <db.password>dbtest</db.password>  
  8.         </properties>  
  9.     </profile>  
  10.       
  11.     <profile>  
  12.         <id>shengchan</id>  
  13.         <properties>  
  14.             <db.url>192.20.1.11</db.url>  
  15.             <db.username>admin</db.username>  
  16.             <db.password>comfreesecurity</db.password>  
  17.         </properties>  
  18.     </profile>  
  19. </profiles>  

 

二、將原來的配置文件內容修改以下:服務器

[html]  view plain  copy
 在CODE上查看代碼片派生到個人代碼片
  1. db.url=${db.url}  
  2. db.username=${db.username}  
  3. db.password=${db.password}  


三、須要開啓資源文件過濾,代碼以下:app

[html]  view plain  copy
 在CODE上查看代碼片派生到個人代碼片
    1. <resources>  
    2.     <resource>  
    3.         <directory>${project.basedir}/src/main/resources</directory>  
    4.         <filtering>true</filtering>  
    5.     </resource>  
    6. </resources>  添加<filtering>true</filtering>,容許使用變量替換資源文件;
      四、使用Maven命令打包時,指定Profile進行打包,命令以下:

      mvn package -Pkaifa

      mvn package -Pshengchan

      如此便可。

       

      此命令用的多了,就會發現,兩個環境必選其一,若是能設置其一個爲默認開啓,就不用每次都手動指定了,這個需求很現實,畢竟開發環境須要持續不斷的編譯、打包、部署等,而上線,則是一段時間纔會運行一次的;所以,默認啓用開發環境是最優的方案,Maven支持默認啓用某個Profile,只需在<profile>內添加以下代碼便可:

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. <activation>  
      2.     <activeByDefault>true</activeByDefault>  
      3. </activation>  

      此處須要注意:一旦顯式指定某個Profile,則該配置無效!

       

      在實際開發中使用以上方式操做時,天然而然的會提出如下的問題:假如配置文件的信息不少,那麼Profile的內容會很臃腫,不便於管理,若是能將配置信息從Profile抽取出來,獨立放置,再根據不一樣的Profile去調用,如此就更好了!

      Maven針對以上需求,確實有解決方案,就是使用<filters>標籤,針對不一樣的環境,使用不一樣的文件替換原來配置文件中的變量。

      項目根目錄下新建以下目錄和文件:

      db.properties問標準的屬性文件,kaifa/db.properties和shengchan/db.properties文件內容分別以下:


    7. [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. db.url=192.10.2.168  
      2. db.username=dbtest  
      3. db.password=dbtest  

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. db.url=192.20.1.11  
      2. db.username=admin  
      3. db.password=confreesecurity  

      將Profile中的屬性信息抽取到了db.properties文件中,同時在Profile中添加<filters></filters>部分,修改後的代碼以下:

       

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
        1. <profiles>  
        2.     <profile>  
        3.         <id>kaifa</id>  
        4.         <activation>  
        5.             <activeByDefault>true</activeByDefault>  
        6.         </activation>  
        7.         <build>  
        8.             <filters>  
        9.                 <filter>${basedir}/filters/kaifa/db.properties</filter>  
        10.             </filters>  
        11.         </build>  
        12.     </profile>  
        13.       
        14.     <profile>  
        15.         <id>shengchan</id>  
        16.         <build>  
        17.             <filters>  
        18.                 <filter>${basedir}/filters/shengchan/db.properties</filter>  
        19.             </filters>  
        20.         </build>  
        21.     </profile>  
        22. </profiles>  

      添加了<filters><filter>...</filter></filters>部分,使用指定的文件內容替換原文件中的變量;

      如此以後,使用Maven命令進行構建便可。

          細心的人會發現,以上Profile中的filters部分,除了使用的目錄名稱不一樣以外,其餘代碼所有相同,重複!!!

          若是再多幾個環境的話,代碼冗餘可想而知,所以須要優化,其實方法很簡單,仍是使用變量替換,修改後的pom.xml文件內容以下:

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
      2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
      3.   
      4.     <modelVersion>4.0.0</modelVersion>  
      5.   
      6.     <groupId>com.test</groupId>  
      7.     <artifactId>Profile</artifactId>  
      8.     <version>0.0.1-SNAPSHOT</version>  
      9.       
      10.     <build>  
      11.         <resources>  
      12.             <resource>  
      13.                 <directory>${project.basedir}/src/main/resources</directory>  
      14.                 <filtering>true</filtering>  
      15.             </resource>  
      16.         </resources>  
      17.         <filters>  
      18.             <filter>${basedir}/filters/${filters.env}/db.properties</filter>  
      19.         </filters>  
      20.     </build>  
      21.     <profiles>  
      22.         <profile>  
      23.             <id>kaifa</id>  
      24.             <activation>  
      25.                 <activeByDefault>true</activeByDefault>  
      26.             </activation>  
      27.             <properties>  
      28.                 <filters.env>kaifa</filters.env>  
      29.             </properties>  
      30.         </profile>  
      31.   
      32.         <profile>  
      33.             <id>shengchan</id>  
      34.             <properties>  
      35.                 <filters.env>shengchan</filters.env>  
      36.             </properties>  
      37.         </profile>  
      38.     </profiles>  
      39. </project>  

          使用-P參數時,會激活<filters.env>屬性,從而使用指定的過濾文件進行變量替換。



          其實,以上方式使用久了,仍是會有些想法,既然用變量,也就是說,必須使用Maven命令以後,才能部署到Tomcat等服務器中,屢次重複的操做,仍是有至關多的時間浪費在maven命令上,尤爲在改動不多的代碼的狀況下;

          此時又會提出新的需求,可否在不使用maven命令的狀況下便可進行平常開發;測試環境(或生產環境)打包時,使用Maven命令和-P參數指定環境進行打包呢?

       

      很幸運,Juven Xu--國內Maven第一人--爲咱們提供了這樣的一個插件portable-config-maven-plugin,使用該插件,能夠在不改變原有代碼的基礎上,進行不一樣環境的打包。

      ------如下應該算做最佳實踐了

      portable-config-maven-plugin插件的原理是內容替換(而不是變量替換);

       

       

      插件代碼地址:https://github.com/juven/portable-config-maven-plugin,目前最新版本爲1.1.4;
      該插件使用方法以下:

      假設src/main/resources/db.properties文件代碼以下:

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. database.jdbc.username=dev  
      2. database.jdbc.password=dev_pwd  

          對於測試環境,建立一個屬性替換文件src/main/portable/test.xml,代碼以下:

       

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. <?xml version="1.0" encoding="utf-8" ?>  
      2. <portable-config>  
      3.     <config-file path="WEB-INF/classes/db.properties">  
      4.         <replace key="database.jdbc.username">test</replace>  
      5.         <replace key="database.jdbc.password">test_pwd</replace>  
      6.     </config-file>  
      7. </portable-config>  

          此文件爲替換內容描述文件,<config-file>標籤的path屬性的值是基於war包的
      相對路徑
          ,指須要被內容替換的文件;

          配置portable-config-maven-plugin插件(
      該插件默認綁定到package聲明週期
          ):

       

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. <plugin>  
      2.     <groupId>com.juvenxu.portable-config-maven-plugin</groupId>  
      3.     <artifactId>portable-config-maven-plugin</artifactId>  
      4.     <version>1.1.4</version>  
      5.     <executions>  
      6.         <execution>  
      7.             <goals>  
      8.                 <goal>replace-package</goal>  
      9.             </goals>  
      10.         </execution>  
      11.     </executions>  
      12.     <configuration>  
      13.         <portableConfig>src/main/portable/test.xml</portableConfig>  
      14.     </configuration>  
      15. </plugin>  

          或在命令行指定替換內容描述文件:mvn clean package -DportableConfig="src/main/portable/test.xml"

          打包完成後,db.properties文件內容會被替換。



      該插件目前支持的內容替換文件格式有:

      .properties

       

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. database.jdbc.username=dev  
      2. database.jdbc.password=dev_pwd  
      3. 使用  
      4. <replace key="database.jdbc.username">test</replace>  
      5. <replace key="database.jdbc.password">test_pwd</replace>  
      6. 替換爲:  
      7. database.jdbc.username=test  
      8. database.jdbc.password=test_pwd  

       

      .xml(xml元素和屬性可使用xPath進行替換)

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. <?xml version="1.0" encoding="UTF-8"?>  
      2. <server>  
      3.     <port>8080</port>  
      4.     <hosts>  
      5.         <host id="1">localhost</host>  
      6.         <host id="2">localhost</host>  
      7.     </hosts>  
      8.     <mode value="debug" />  
      9. </server>  
      10. 使用  
      11. <replace xpath="/server/port">80</replace>  
      12. <replace xpath="//host/[@id='1']">192.168.1.1</replace>  
      13. <replace xpath="//host/[@id='2']">192.168.1.2</replace>  
      14. <replace xpath="/server/mode/@value">run</replace>  
      15. 替換爲:  
      16. <?xml version="1.0" encoding="UTF-8"?>  
      17. <server>  
      18.     <port>80</port>  
      19.     <hosts>  
      20.         <host id="1">192.168.1.1</host>  
      21.         <host id="2">192.168.1.2</host>  
      22.     </hosts>  
      23.     <mode value="run"/>  
      24. </server>  

       

      .sh

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. 無引號、單引號、雙引號、輸出的shell變量可被替換  
      2. BIN_HOME=/tmp/bin  
      3. OUT_HOME="/tmp/out"  
      4. LOG_HOME='/tmp/log'  
      5. export APP_HOME="/tmp/app"  
      6. 使用  
      7. <replace key="BIN_HOME">/home/juven/bin</replace>  
      8. <replace key="OUT_HOME">/home/juven/out</replace>  
      9. <replace key="LOG_HOME">/home/juven/log</replace>  
      10. <replace key="APP_HOME">/home/juven/app</replace>  
      11. 替換爲:  
      12. BIN_HOME=/home/juven/bin  
      13. OUT_HOME="/home/juven/out"  
      14. LOG_HOME='/home/juven/log'  
      15. export APP_HOME="/home/juven/app"  

       

      相似.properties格式

       

      [html]  view plain  copy
       在CODE上查看代碼片派生到個人代碼片
      1. 假若有個key=value類型的配置文件,但擴展名不是.properties,可按照如下方式指定:  
      2. <?xml version="1.0" encoding="utf-8" ?>  
      3. <portable-config>  
      4.     <config-file path="db.ini" type=".properties">  
      5.         <replace key="mysql.host">192.168.1.100</replace>  
      6.     </config-file>  
      7. </portable-config>  
      8. 使用type屬性強制指定文件類型。  


       

      對該插件的介紹到此爲止。

      回頭看看,發現內容和標題不符,說是介紹portable-config-maven-plugin插件,

      卻花了大篇幅的內容介紹了Maven其餘的標籤使用,不過以上內容總有相同之處--針對不一樣環境打包的一些解決方法

相關文章
相關標籤/搜索