[关闭]
@haokuixi 2014-11-26T00:41:31.000000Z 字数 9935 阅读 28965

Maven 如何为不同的环境打包 —— 开发、测试和产品环境

The best practice for building war for different environment - Dev(Development), QA(Test) and Prod(Product)

maven profile

本文介绍 Maven 打包的实践，以 build war 为例。
每个项目都会有多套运行环境，最基本的就是Dev、QA、Prod，不同的环境对应的配置也不尽相同，比如说数据库连接，文件路径，WebServices address 等等。
不同环境下需要构建不同的包，那么我们可以通过以下两种方式来解决：

一、定义多个 pom，使用 -f <pom_file> 指定

e.g.

pom.xml (default)
pom_qa.xml
pom_prod.xml

Build war for qa: 

mvn clean package -f pom_qa.xml

Build war for product: 

mvn clean package -f pom_prod.xml

多个 pom.xml 之间重复配置很多，不容易维护，极不推荐这种方式。

二、结合 maven-war-plugin 和 profile 进行配置

需求假设：

1) 不同环境的数据库连接地址以及 DataSource 类型不一样
开发环境通过普通的DataSource连接数据库：

  1. <bean name="SQLServerDriverDS" destroy-method="close">
  2.     <property name="driverClassName" value="${driver_class}" />
  3.     <property name="username" value="${username}" />
  4.     <property name="password" value="${password}" />
  5.     <property name="url" value="${url}" />
  6.     <property name="maxIdle" value="${maxPoolSize}" />
  7.     <property name="maxActive" value="${minPoolSize}" />
  8. </bean>

测试和产品环境都是通过 JNDI 方式连接数据库：

  1. <bean id="SQLServerDriverDS">
  2.     <property name="jndiName" value="jdbc/AlteraDS" />
  3. </bean>

2) 不同环境的 log4j.properties 不同，文件上传下载路径也不一样。
3) QA 的 war 包名称要带上日期，e.g. xxx-20120830.war

为了实现上述需求，组织工程目录结构如下:

project/
`-- src
    |-- main
    |   |-- java
    |   |-- env
    |   |   |-- dev
    |   |   |   |-- log4j.properties
    |   |   |   |-- spring-dataSource.xml
    |   |   |   `-- variable.propertes
    |   |   |-- prod
    |   |   |   |-- log4j.properties
    |   |   |   |-- spring-dataSource.xml
    |   |   |   `-- variable.propertes
    |   |   `-- qa
    |   |       |-- log4j.properties
    |   |       |-- spring-dataSource.xml
    |   |       `-- variable.propertes
    |   |-- resources
    |   `-- webapp
    `-- test

pom.xml里定义三个环境的profile：

  1. <profile>
  2.     <id>dev</id>
  3.     <activation>
  4.         <activeByDefault>true</activeByDefault>
  5.     </activation>
  6.     <properties>
  7.         <runtime.env>src/main/env/dev</runtime.env>
  8.         <final.name>webapp</final.name>
  9.     </properties>
  10.     <dependencies>
  11.         <dependency>
  12.             <groupId>com.eightqiu</groupId>
  13.             <artifactId>CodeCmns</artifactId>
  14.             <version>0.0.1-SNAPSHOT</version>
  15.         </dependency>
  16.     </dependencies>
  17. </profile>
  18. <profile>
  19.     <id>qa</id>
  20.     <properties>
  21.         <runtime.env>src/main/env/qa</runtime.env>
  22.         <final.name>webapp_${buildNumber}</final.name>
  23.     </properties>
  24.     <build>
  25.         <plugins>
  26.             <plugin>
  27.                 <groupId>org.codehaus.mojo</groupId>
  28.                 <artifactId>buildnumber-maven-plugin</artifactId>
  29.                 <version>1.1</version>
  30.                 <executions>
  31.                     <execution>
  32.                         <phase>validate</phase>
  33.                         <goals>
  34.                             <goal>create</goal>
  35.                         </goals>
  36.                     </execution>
  37.                 </executions>
  38.                 <configuration>
  39.                     <format>{0,date,yyyyMMdd}</format>
  40.                     <items>
  41.                         <item>timestamp</item>
  42.                     </items>
  43.                 </configuration>
  44.             </plugin>
  45.         </plugins>
  46.     </build>
  47.     <reporting>
  48.         <plugins>
  49.             <plugin>
  50.                 <groupId>org.apache.maven.plugins</groupId>
  51.                 <artifactId>maven-javadoc-plugin</artifactId>
  52.                 <version>2.8.1</version>
  53.             </plugin>
  54.         </plugins>
  55.     </reporting>
  56.     <dependencies>
  57.         <dependency>
  58.             <groupId>com.eightqiu</groupId>
  59.             <artifactId>CodeCmns</artifactId>
  60.             <version>0.0.1-SNAPSHOT</version>
  61.             <scope>provided</scope>
  62.         </dependency>
  63.     </dependencies>
  64. </profile>
  65. <profile>
  66.     <id>prod</id>
  67.     <properties>
  68.         <runtime.env>src/main/env/prod</runtime.env>
  69.         <final.name>webapp</final.name>
  70.     </properties>
  71.     <dependencies>
  72.         <dependency>
  73.             <groupId>com.eightqiu</groupId>
  74.             <artifactId>CodeCmns</artifactId>
  75.             <version>0.0.1-SNAPSHOT</version>
  76.             <scope>provided</scope>
  77.         </dependency>
  78.     </dependencies>
  79. </profile>

Maven-war-plugin里配置additional resource folder

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-war-plugin</artifactId>
  4.     <version>2.1.1</version>
  5.     <configuration>
  6.         <overlays>
  7.             <overlay>
  8.                 <groupId>TransactionResource</groupId>
  9.                 <artifactId>TransactionResource</artifactId>
  10.                 <excludes>
  11.                     <exclude>WEB-INF/web.xml</exclude>
  12.                 </excludes>
  13.             </overlay>
  14.         </overlays>
  15.         <webResources>
  16.             <resource>
  17.                 <directory>${runtime.env}</directory>
  18.                 <targetPath>WEB-INF/classes</targetPath>
  19.             </resource>
  20.         </webResources>
  21.     </configuration>
  22. </plugin>
  1. <finalName>${final.name}</finalName>

${runtime.env} & ${final.name}就是profile里定义的两个properties。
打包的时候使用-P <profile>指定需要打哪个环境的包。
e.g. 

mvn clean package -Pdev
mvn clean package -Pqa

附上完整的pom.xml

  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/maven-v4_0_0.xsd">
  3.     <modelVersion>4.0.0</modelVersion>
  4.     <packaging>war</packaging>
  5.     <version>0.0.1-SNAPSHOT</version>
  6.     <name>demo Maven Webapp</name>
  7.     <groupId>webapp</groupId>
  8.     <artifactId>webapp</artifactId>
  10.     <scm>
  11.         <connection>scm:svn:http://127.0.0.1/dummy</connection>
  12.         <developerConnection>scm:svn:https://127.0.0.1/dummy</developerConnection>
  13.         <tag>HEAD</tag>
  14.         <url>http://127.0.0.1/dummy</url>
  15.     </scm>
  17.     <properties>
  18.         <spring-version>3.1.0.RELEASE</spring-version>
  19.     </properties>
  20.     <build>
  21.         <finalName>${final.name}</finalName>
  22.         <plugins>
  23.             <plugin>
  24.                 <groupId>org.mortbay.jetty</groupId>
  25.                 <artifactId>maven-jetty-plugin</artifactId>
  26.                 <version>6.1.10</version>
  27.                 <configuration>
  28.                     <connectors>
  29.                         <connector implementation="org.mortbay.jetty.nio.SelectChannelConnector">
  30.                             <port>9090</port>
  31.                             <maxIdleTime>60000</maxIdleTime>
  32.                         </connector>
  33.                     </connectors>
  34.                 </configuration>
  35.             </plugin>
  36.             <plugin>
  37.                 <groupId>org.apache.maven.plugins</groupId>
  38.                 <artifactId>maven-war-plugin</artifactId>
  39.                 <version>2.1.1</version>
  40.                 <configuration>
  41.                     <overlays>
  42.                         <overlay>
  43.                             <groupId>TransactionResource</groupId>
  44.                             <artifactId>TransactionResource</artifactId>
  45.                             <excludes>
  46.                                 <exclude>WEB-INF/web.xml</exclude>
  47.                             </excludes>
  48.                         </overlay>
  49.                     </overlays>
  50.                     <webResources>
  51.                         <resource>
  52.                             <directory>${runtime.env}</directory>
  53.                             <targetPath>WEB-INF/classes</targetPath>
  54.                         </resource>
  55.                     </webResources>
  56.                 </configuration>
  57.             </plugin>
  58.             <plugin>
  59.                 <groupId>org.apache.maven.plugins</groupId>
  60.                 <artifactId>maven-compiler-plugin</artifactId>
  61.                 <version>2.3.2</version>
  62.                 <configuration>
  63.                     <source>1.6</source>
  64.                     <target>1.6</target>
  65.                 </configuration>
  66.             </plugin>
  67.         </plugins>
  68.     </build>
  69.     <dependencies>
  70.         <dependency>
  71.             <groupId>org.springframework</groupId>
  72.             <artifactId>spring-webmvc</artifactId>
  73.             <version>${spring-version}</version>
  74.             <exclusions>
  75.                 <exclusion>
  76.                     <artifactId>spring-core</artifactId>
  77.                     <groupId>org.springframework</groupId>
  78.                 </exclusion>
  79.             </exclusions>
  80.         </dependency>
  81.         <dependency>
  82.             <groupId>opensymphony</groupId>
  83.             <artifactId>sitemesh</artifactId>
  84.             <version>2.4.2</version>
  85.         </dependency>
  86.         <dependency>
  87.             <groupId>jstl</groupId>
  88.             <artifactId>jstl</artifactId>
  89.             <version>1.2</version>
  90.         </dependency>
  91.         <dependency>
  92.             <groupId>javax.servlet</groupId>
  93.             <artifactId>servlet-api</artifactId>
  94.             <version>2.5</version>
  95.             <scope>provided</scope>
  96.         </dependency>
  97.         <dependency>
  98.             <groupId>javax.servlet.jsp</groupId>
  99.             <artifactId>jsp-api</artifactId>
  100.             <version>2.2</version>
  101.             <scope>provided</scope>
  102.         </dependency>
  103.         <dependency>
  104.             <groupId>TransactionResource</groupId>
  105.             <artifactId>TransactionResource</artifactId>
  106.             <version>0.0.1-SNAPSHOT</version>
  107.             <type>war</type>
  108.         </dependency>
  109.         <dependency>
  110.             <groupId>org.hibernate</groupId>
  111.             <artifactId>hibernate-validator</artifactId>
  112.             <version>4.2.0.Final</version>
  113.         </dependency>
  114.         <dependency>
  115.             <groupId>org.codehaus.jackson</groupId>
  116.             <artifactId>jackson-mapper-asl</artifactId>
  117.             <version>1.9.4</version>
  118.         </dependency>
  119.         <dependency>
  120.             <groupId>log4j</groupId>
  121.             <artifactId>log4j</artifactId>
  122.             <version>1.2.16</version>
  123.         </dependency>
  124.         <dependency>
  125.             <groupId>commons-logging</groupId>
  126.             <artifactId>commons-logging</artifactId>
  127.             <version>1.1.1</version>
  128.         </dependency>
  129.         <dependency>
  130.             <groupId>net.sf.dozer</groupId>
  131.             <artifactId>dozer</artifactId>
  132.             <version>5.3.2</version>
  133.         </dependency>
  134.         <dependency>
  135.             <groupId>org.springframework</groupId>
  136.             <artifactId>spring-jdbc</artifactId>
  137.             <version>${spring-version}</version>
  138.         </dependency>
  139.         <dependency>
  140.             <groupId>commons-dbcp</groupId>
  141.             <artifactId>commons-dbcp</artifactId>
  142.             <version>1.4</version>
  143.         </dependency>
  144.         <dependency>
  145.             <groupId>com.microsoft.sqlserver</groupId>
  146.             <artifactId>sqljdbc</artifactId>
  147.             <version>4</version>
  148.         </dependency>
  149.         <dependency>
  150.             <groupId>org.springframework</groupId>
  151.             <artifactId>spring-test</artifactId>
  152.             <version>${spring-version}</version>
  153.         </dependency>
  154.         <dependency>
  155.             <groupId>junit</groupId>
  156.             <artifactId>junit</artifactId>
  157.             <version>4.8.2</version>
  158.         </dependency>
  159.         <dependency>
  160.             <groupId>org.slf4j</groupId>
  161.             <artifactId>slf4j-api</artifactId>
  162.             <version>1.6.4</version>
  163.         </dependency>
  164.         <dependency>
  165.             <groupId>org.slf4j</groupId>
  166.             <artifactId>slf4j-log4j12</artifactId>
  167.             <version>1.6.4</version>
  168.         </dependency>
  169.         <dependency>
  170.             <groupId>javax.mail</groupId>
  171.             <artifactId>mail</artifactId>
  172.             <version>1.4</version>
  173.         </dependency>
  174.         <dependency>
  175.             <groupId>commons-fileupload</groupId>
  176.             <artifactId>commons-fileupload</artifactId>
  177.             <version>1.2.1</version>
  178.         </dependency>
  179.         <dependency>
  180.             <groupId>commons-io</groupId>
  181.             <artifactId>commons-io</artifactId>
  182.             <version>1.4</version>
  183.         </dependency>
  184.         <dependency>
  185.             <groupId>commons-beanutils</groupId>
  186.             <artifactId>commons-beanutils</artifactId>
  187.             <version>1.8.3</version>
  188.         </dependency>
  189.         <dependency>
  190.             <groupId>commons-collections</groupId>
  191.             <artifactId>commons-collections</artifactId>
  192.             <version>3.2.1</version>
  193.         </dependency>
  194.         <dependency>
  195.             <groupId>commons-codec</groupId>
  196.             <artifactId>commons-codec</artifactId>
  197.             <version>1.5</version>
  198.         </dependency>
  199.     </dependencies>
  200.     <profiles>
  201.         <profile>
  202.             <id>dev</id>
  203.             <activation>
  204.                 <activeByDefault>true</activeByDefault>
  205.             </activation>
  206.             <properties>
  207.                 <runtime.env>src/main/env/dev</runtime.env>
  208.                 <final.name>webapp</final.name>
  209.             </properties>
  210.             <dependencies>
  211.                 <dependency>
  212.                     <groupId>com.eightqiu</groupId>
  213.                     <artifactId>CodeCmns</artifactId>
  214.                     <version>0.0.1-SNAPSHOT</version>
  215.                 </dependency>
  216.             </dependencies>
  217.         </profile>
  218.         <profile>
  219.             <id>qa</id>
  220.             <properties>
  221.                 <runtime.env>src/main/env/qa</runtime.env>
  222.                 <final.name>webapp_${buildNumber}</final.name>
  223.             </properties>
  224.             <build>
  225.                 <plugins>
  226.                     <plugin>
  227.                         <groupId>org.codehaus.mojo</groupId>
  228.                         <artifactId>buildnumber-maven-plugin</artifactId>
  229.                         <version>1.1</version>
  230.                         <executions>
  231.                             <execution>
  232.                                 <phase>validate</phase>
  233.                                 <goals>
  234.                                     <goal>create</goal>
  235.                                 </goals>
  236.                             </execution>
  237.                         </executions>
  238.                         <configuration>
  239.                             <format>{0,date,yyyyMMdd}</format>
  240.                             <items>
  241.                                 <item>timestamp</item>
  242.                             </items>
  243.                         </configuration>
  244.                     </plugin>
  245.                 </plugins>
  246.             </build>
  247.             <reporting>
  248.                 <plugins>
  249.                     <plugin>
  250.                         <groupId>org.apache.maven.plugins</groupId>
  251.                         <artifactId>maven-javadoc-plugin</artifactId>
  252.                         <version>2.8.1</version>
  253.                     </plugin>
  254.                 </plugins>
  255.             </reporting>
  256.             <dependencies>
  257.                 <dependency>
  258.                     <groupId>com.eightqiu</groupId>
  259.                     <artifactId>CodeCmns</artifactId>
  260.                     <version>0.0.1-SNAPSHOT</version>
  261.                     <scope>provided</scope>
  262.                 </dependency>
  263.             </dependencies>
  264.         </profile>
  265.         <profile>
  266.             <id>prod</id>
  267.             <properties>
  268.                 <runtime.env>src/main/env/prod</runtime.env>
  269.                 <final.name>webapp</final.name>
  270.             </properties>
  271.             <dependencies>
  272.                 <dependency>
  273.                     <groupId>com.eightqiu</groupId>
  274.                     <artifactId>CodeCmns</artifactId>
  275.                     <version>0.0.1-SNAPSHOT</version>
  276.                     <scope>provided</scope>
  277.                 </dependency>
  278.             </dependencies>
  279.         </profile>
  280.     </profiles>
  281. </project>

转载自：http://www.8qiu.cn/archives/1096

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注