maven利用Profile构建不同环境的部署包

今天药忘吃喽~ 2022-07-16 03:16 176阅读 0赞

项目开发好以后，通常要在多个环境部署，象我们公司多达5种环境：本机环境(local)、(开发小组内自测的)开发环境(dev)、(提供给测试团队的)测试环境(test)、预发布环境(pre)、正式生产环境(prod)，每种环境都有各自的配置参数，比如：数据库连接、远程调用的ws地址等等。如果每个环境build前手动修改这些参数，显然太不fashion.

maven早就考虑到了这些问题，看下面的pom片段：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1 <profiles>
     2         <profile>
     3             
     4             <id>local</id>
     5             <properties>                
     6                 <db-url>jdbc:oracle:thin:@localhost:1521:XE</db-url>
     7                 <db-username>***</db-username>
     8                 <db-password>***</db-password>
     9             </properties>
    10         </profile>
    11         <profile>
    12             
    13             <id>dev</id>
    14             <properties>                
    15                 <db-url>jdbc:oracle:thin:@172.21.129.51:1521:orcl</db-url>
    16                 <db-username>***</db-username>
    17                 <db-password>***</db-password>
    18             </properties>
    19             
    20             <activation>
    21                 <activeByDefault>true</activeByDefault>
    22             </activation>
    23         </profile>
    24         ...
    25     </profiles>

![复制代码][copycode.gif]

profiles节点中，定义了二种环境：local、dev(默认激活dev环境)，可以在各自的环境中添加需要的property值，接下来修改build节点，参考下面的示例：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1 <build>
     2         <resources>
     3             <resource>
     4                 <directory>src/main/resources</directory>
     5                 <filtering>true</filtering>
     6             </resource>
     7         </resources>
     8         <plugins>
     9             <plugin>
    10                 <groupId>org.apache.maven.plugins</groupId>
    11                 <artifactId>maven-compiler-plugin</artifactId>
    12                 <version>2.5.1</version>
    13                 <configuration>
    14                     <source>1.6</source>
    15                     <target>1.6</target>
    16                     <encoding>utf-8</encoding>
    17                 </configuration>
    18             </plugin>
    19         </plugins>
    20     </build>

![复制代码][copycode.gif]

resource节点是关键，它表明了哪个目录下的配置文件（不管是xml配置文件，还是properties属性文件），需要根据profile环境来替换属性值。

通常配置文件放在resources目录下，build时该目录下的文件都自动会copy到class目录下

![281044295329658.jpg][]

以上图为例，其中spring-database.xml的内容为：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1 <?xml version="1.0" encoding="UTF-8"?>
     2 <beans xmlns="http://www.springframework.org/schema/beans"
     3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     4     xsi:schemaLocation="http://www.springframework.org/schema/beans 
     5     http://www.springframework.org/schema/beans/spring-beans.xsd">
     6 
     7     <bean id="dataSource"
     8         class="org.springframework.jdbc.datasource.DriverManagerDataSource">
     9         <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver" />
    10         <property name="url" value="${db-url}" />
    11         <property name="username" value="${db-username}" />
    12         <property name="password" value="${db-password}" />        
    13     </bean>
    14 </beans>

![复制代码][copycode.gif]

各属性节点的值，用占位符"$\{属性名\}"占位，maven在package时，会根据profile的环境自动替换这些占位符为实际属性值。

默认情况下：

maven package

将采用默认激活的profile环境来打包，也可以手动指定环境，比如：

maven package \-P dev

将自动打包成dev环境的部署包(注：参数P为大写)

最后再给2个实例的运用例子：

1、开发环境与生产环境数据源采用不同方式的问题

本机开发时为了方便，很多开发人员喜欢直接用JDBC直接连接数据库，这样修改起来方便；

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
     2         destroy-method="close">
     3         <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver" />
     4         <property name="url" value="${db-url}" />
     5         <property name="username" value="${db-username}" />
     6         <property name="password" value="${db-password}" />
     7         <property name="defaultAutoCommit" value="false" />
     8         <property name="initialSize" value="2" />
     9         <property name="maxActive" value="10" />
    10         <property name="maxWait" value="60000" />
    11     </bean>

![复制代码][copycode.gif]

而生产环境，通常是在webserver(比如weblogic上)配置一个JNDI数据源，

![ExpandedBlockStart.gif][]

1     <bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
    2         <property name="jndiName" value="appDS" />        
    3     </bean>

如果每次发布生产前，都要手动修改，未免太原始，可以通过maven的profile来解决

先把配置文件改成

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     <bean id="${db-source-jdbc}" class="org.apache.commons.dbcp.BasicDataSource"
     2         destroy-method="close">
     3         <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver" />
     4         <property name="url" value="${db-url}" />
     5         <property name="username" value="${db-username}" />
     6         <property name="password" value="${db-password}" />
     7         <property name="defaultAutoCommit" value="false" />
     8         <property name="initialSize" value="2" />
     9         <property name="maxActive" value="10" />
    10         <property name="maxWait" value="60000" />
    11     </bean>
    12     
    13     <bean id="${db-source-jndi}" class="org.springframework.jndi.JndiObjectFactoryBean">
    14         <property name="jndiName" value="appDS" />        
    15     </bean>

![复制代码][copycode.gif]

即用占位符来代替bean的id，然后在pom.xml里类似下面设置

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1                <profile>
     2             
     3             <id>local</id>
     4             <properties>
     5                 ...
     6                 <db-source-jdbc>dataSource</db-source-jdbc>
     7                 <db-source-jndi>NONE</db-source-jndi>
     8                 <db-url>jdbc:oracle:thin:@172.21.129.51:1521:orcl</db-url>                
     9                 <db-username>mu_fsu</db-username>
    10                 <db-password>mu_fsu</db-password>
    11                 ...
    12             </properties>
    13             
    14             <activation>
    15                 <activeByDefault>true</activeByDefault>
    16             </activation>
    17         </profile>        
    18         <profile>
    19             
    20             <id>pro</id>
    21             <properties>
    22                 ...
    23                 <db-source-jdbc>NONE</db-source-jdbc>
    24                 <db-source-jndi>dataSource</db-source-jndi>
    25                 ...
    26             </properties>
    27         </profile>
    28     </profiles>

![复制代码][copycode.gif]

这样，mvn clean package -P local打包本地开发环境时，将生成

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
     2         destroy-method="close">
     3         <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver" />
     4         <property name="url" value="jdbc:oracle:thin:@172.21.129.***:1521:orcl" />
     5         <property name="username" value="***" />
     6         <property name="password" value="***" />
     7         <property name="defaultAutoCommit" value="false" />
     8         <property name="initialSize" value="2" />
     9         <property name="maxActive" value="10" />
    10         <property name="maxWait" value="60000" />
    11     </bean>
    12     
    13     <bean id="NONE" class="org.springframework.jndi.JndiObjectFactoryBean">
    14         <property name="jndiName" value="appDS" />        
    15     </bean>

![复制代码][copycode.gif]

而打包生产环境 mvn clean package -P pro时，生成

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     <bean id="NONE" class="org.apache.commons.dbcp.BasicDataSource"
     2         destroy-method="close">
     3         <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver" />
     4         <property name="url" value="${db-url}" />
     5         <property name="username" value="${db-username}" />
     6         <property name="password" value="${db-password}" />
     7         <property name="defaultAutoCommit" value="false" />
     8         <property name="initialSize" value="2" />
     9         <property name="maxActive" value="10" />
    10         <property name="maxWait" value="60000" />
    11     </bean>
    12     
    13     <bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
    14         <property name="jndiName" value="appDS" />        
    15     </bean>

![复制代码][copycode.gif]

spring配置的其它跟数据库相关的bean，约定引用dataSource这个名称的bean即可

2、不同webserver环境，依赖jar包，是否打包的问题

weblogic上，允许多个app，把共用的jar包按约定打包成一个war文件，以library的方式部署，然后各应用在WEB-INF/weblogic.xml中，用类似下面的形式

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1 <?xml version="1.0" encoding="utf-8"?>
    2 <weblogic-web-app xmlns="http://www.bea.com/ns/weblogic/90">
    3     ...
    4     <library-ref>
    5         <library-name>my-share-lib</library-name>
    6     </library-ref>
    7 </weblogic-web-app>

![复制代码][copycode.gif]

指定共享library 的名称即可。这样的好处是，即节省了服务器开销，而且各app打包时，就不必再重复打包这些jar文件，打包后的体积大大减少，上传起来会快很多。

而其它webserver上却未必有这个机制，一般为了方便，我们开发时，往往采用一些轻量级的webserver，比如:tomcat,jetty,jboss 之类，正式部署时才发布到weblogic下，这样带来的问题就是，本机打包时，要求这些依赖jar包，全打包到app的WEB-INF/lib下；而生产环境下，各应用的WEB-INF/lib下并不需要这些jar文件，同样还是用profile来搞定，先处理pom.xml，把依赖项改成类似下面的形式：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1         <dependency>
    2             <groupId>dom4j</groupId>
    3             <artifactId>dom4j</artifactId>
    4             <version>1.6.1</version>
    5             <scope>${jar.scope}</scope>
    6         </dependency>

![复制代码][copycode.gif]

即scope这里，用一个占位符来代替，然后profile这样配置

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1         <profile>
     2             
     3             <id>local</id>
     4             <properties>
     5                 <jar.scope>compile</jar.scope>
     6                 ...
     7             </properties>
     8             
     9             <activation>
    10                 <activeByDefault>true</activeByDefault>
    11             </activation>
    12         </profile>
    13         <profile>
    14             
    15             <id>pro</id>
    16             <properties>
    17                 <jar.scope>provided</jar.scope>
    18                 ...
    19             </properties>
    20         </profile>

![复制代码][copycode.gif]

在maven里，如果一个依赖项的scope是provided，表示由容器提供，打包时将不会打包进最终的package里，所以这样配置后，生产环境打包时，依赖项的scope全变成了provided，即不打包进war文件，而本机环境下，因为scope是compile，所以会打包到war里

[ExpandedBlockStart.gif]: /images/20220716/e088955e9a904ecd854a06f80a23eb85.png
[copycode.gif]: /images/20220716/fed4a652cfc44dfa9cce42eb61380959.png
[281044295329658.jpg]: /images/20220716/fae272d36b2f4493b2942a64ef9f898d.png