利用maven中resources插件的copy-resources目标进行资源copy和过滤

Posted 2020-09-27 再见理想

一篇值得一看的博文，主要涉及处理maven工程中的resources的内容。转自:http://xigua366.iteye.com/blog/2080668

 

 

maven用可以利用如下配置进行资源过滤，pom.xml的配置如下：

 

Xml代码  

1. <build>    
2.             
3.         <!-- 主资源目录 -->    
4.         <resources>    
5.             <resource>    
6.                 <!-- 设定主资源目录  -->    
7.                 <directory>src/main/resources</directory>    
8.                     
9.                 <!-- maven default生命周期，process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时，只处理如下配置中包含的资源类型     
10.                 <includes>    
11.                     <include>*.xml</include>    
12.                 </includes>    
13.                  -->    
14.                      
15.                 <!-- maven default生命周期，process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时，不处理如下配置中包含的资源类型（剔除下如下配置中包含的资源类型）     
16.                 <excludes>    
17.                     <exclude>*.xml</exclude>    
18.                 </excludes>    
19.                 -->    
20.                     
21.                 <!-- maven default生命周期，process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时，指定处理后的资源文件输出目录，默认是${build.outputDirectory}指定的目录    
22.                 <targetPath>d:/</targetPath>    
23.                    -->    
24.                       
25.                 <!-- maven default生命周期，process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时，是否对主资源目录开启资源过滤 -->    
26.                 <filtering>true</filtering>    
27.                     
28.             </resource>    
29.         </resources>    
30.     </build>  

利用这个特性可以解决开发跟生产环境数据库连接配置等问题，但有时这个特性并不符合实际。比如，开发环境我们使用tomcat应用服务器，使用dbcp数据源，但是生产则使用jboss应用服务器，使用jndi来管理数据源。开发环境跟生产环境spring容器中对于id=dataSources的bean的配置如下所示：

 

开发环境：

 

Xml代码  

1. <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">  
2.         <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver" />  
3.         <property name="url" value="jdbc:oracle:thin:@localhost:1521:gbst" /> <!-- 开发库 -->  
4.         <property name="username" value="admin" />  
5.         <property name="password" value="admin" />  
6.         <property name="initialSize" value="1"/>  
7.         <property name="maxActive" value="2"/>  
8.     </bean>  

 生产环境：

 

 

Xml代码  

1. <bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">  
2.         <property name="jndiName">  
3.             <value>PrdDS</value>  
4.         </property>  
5.         <property name="resourceRef">  
6.             <value>false</value>  
7.         </property>  
8.     </bean>  

 像这种情况，靠<build><resources><resource>的资源过滤功能就不太实用了，这时可以采用resources插件的copy-resources目标进行资源copy，来达到分别配置开发环境与生产环境的数据库连接信息及其它一些配置（缓存服务器地址、短信网关系统连接配置等等），下面分步骤来达到这一目的。

 

第一步，实用maven穿件一个maven 工程（maven-demo），工程结构如下图：

第二部，在resources下定义spring的配置文件、log4j.properties等文件，并同时在main目录下创建一个deploy的目录，在deploy目录下创建一个prd的目录，然后在prd的目录下也定义一个spring的配置文件、log4j的文件，文件名相同，只是里面的配置的内容不同。添加文件后的maven-demo工程目录结构如下图：

 
 main/resoures下的spring配置文件内容如下：

 

Xml代码  

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" xmlns:jdbc="http://www.springframework.org/schema/jdbc"  
4.     xmlns:tx="http://www.springframework.org/schema/tx" xmlns:util="http://www.springframework.org/schema/util"  
5.     xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context"  
6.     xsi:schemaLocation="  
7.     http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd  
8.     http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd  
9.     http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd  
10.     http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd  
11.     http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd  
12.     http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">  
13.       
14.     <!-- 开发环境采用tomcat应用服务器，dbcp数据源管理 -->  
15.     <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">  
16.         <property name="url" value="jdbc:oracle:thin:@localhost:1521:shell"/>   
17.         <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver"/>    
18.         <property name="username" value="scott"/>  
19.         <property name="password" value="admin123"/>  
20.         <property name="initialSize" value="1"/>  
21.         <property name="maxActive" value="2"/>  
22.     </bean>  
23.       
24.     <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">  
25.         <property name="dataSource" ref="dataSource"></property>  
26.     </bean>  
27. </beans>  

 

 

main/deploy/prd目录下的spring配置文件内容如下：

 

Xml代码  

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" xmlns:jdbc="http://www.springframework.org/schema/jdbc"  
4.     xmlns:tx="http://www.springframework.org/schema/tx" xmlns:util="http://www.springframework.org/schema/util"  
5.     xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context"  
6.     xsi:schemaLocation="  
7.     http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd  
8.     http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd  
9.     http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd  
10.     http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd  
11.     http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd  
12.     http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">  
13.       
14.     <bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">  
15.         <property name="jndiName">  
16.             <value>prdDS</value>  
17.         </property>  
18.         <property name="resourceRef">  
19.             <value>false</value>  
20.         </property>  
21.     </bean>  
22.       
23.     <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">  
24.         <property name="dataSource" ref="dataSource"></property>  
25.     </bean>  
26. </beans>  

 

 

（log4j.properties内容就不列出了，如果要想使得开发环境跟生产环境不一样的配置，原理跟spring的配置文件一样的）

 

第三步，配置pom.xml文件，内容如下：

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
4.     <modelVersion>4.0.0</modelVersion>  
5.   
6.   
7.     <groupId>com.shell.maven.demo</groupId>  
8.     <artifactId>maven-demo</artifactId>  
9.     <version>1.0.0-SNAPSHOT</version>  
10.   
11.     <name>maven-demo</name>  
12.     <url>http://maven.apache.org</url>  
13.       
14.     <properties>  
15.         <!-- system property -->  
16.         <encoding>UTF-8</encoding>  
17.         <maven.test.skip>true</maven.test.skip>  
18.         <skipTests>true</skipTests>  
19.           
20.         <!-- spring版本 -->  
21.         <springframework.version>3.1.0.RELEASE</springframework.version>  
22.     </properties>  
23.       
24.     <profiles>  
25.         <profile>  
26.             <id>prd</id>  
27.             <build>  
28.                 <plugins>  
29.                     <plugin>  
30.                     <groupId>org.apache.maven.plugins</groupId>  
31.                     <artifactId>maven-resources-plugin</artifactId>  
32.                     <version>2.6</version>  
33.                     <executions>  
34.                         <execution>  
35.                             <id>copy-resources</id>  
36.                             <!-- 在default生命周期的 validate阶段就执行resources插件的copy-resources目标 -->  
37.                             <phase>validate</phase>  
38.                             <goals>  
39.                                 <goal>copy-resources</goal>  
40.                             </goals>  
41.                             <configuration>  
42.                                 <!-- 指定resources插件处理资源文件到哪个目录下 -->  
43.                                 <outputDirectory>${project.build.outputDirectory}</outputDirectory>  
44.                                 <!--  也可以用下面这样的方式（指定相对url的方式指定outputDirectory）  
45.                                 <outputDirectory>target/classes</outputDirectory>  
46.                                  -->  
47.                                 <!-- 待处理的资源定义 -->  
48.                                 <resources>  
49.                                     <resource>  
50.                                         <!-- 指定resources插件处理哪个目录下的资源文件 -->  
51.                                         <directory>src/main/deploy/prd</directory>  
52.                                         <!-- 指定不需要处理的资源   
53.                                         <excludes>  
54.                                           <exclude>WEB-INF/*.*</exclude>  
55.                                         </excludes>  
56.                                         -->  
57.                                         <!-- 是否对待处理的资源开启过滤模式 (resources插件的copy-resources目标也有资源过滤的功能，这里配置的  
58.                                         这个功能的效果跟<build><resources><resource>下配置的资源过滤是一样的，只不过可能执行的阶段不一样，  
59.                                         这里执行的阶段是插件指定的validate阶段，<build><resources><resource>下的配置将是在resources插件的resources目标执行时起作用（在process-resources阶段）)-->  
60.                                         <filtering>false</filtering>  
61.                                     </resource>  
62.                                 </resources>  
63.                             </configuration>  
64.                             <inherited></inherited>  
65.                         </execution>  
66.                     </executions>  
67.                       
68.                     </plugin>           
69.                 </plugins>  
70.             </build>  
71.         </profile>  
72.     </profiles>  
73.       
74.     <repositories>  
75.         <repository>  
76.             <id>myRepo</id>  
77.             <name>myRepo Repository</name>  
78.             <url>http://maven.infinitus.com.cn:8081/nexus/content/groups/public/</url>  
79.             <releases>  
80.                 <enabled>true</enabled>  
81.             </releases>  
82.             <snapshots>  
83.                 <enabled>true</enabled>  
84.             </snapshots>  
85.         </repository>  
86.     </repositories>  
87.     <pluginRepositories>  
88.         <pluginRepository>  
89.             <id>myRepo</id>  
90.             <name>myRepo Repository</name>  
91.             <url>http://maven.infinitus.com.cn:8081/nexus/content/groups/public/</url>  
92.             <releases>  
93.                 <enabled>true</enabled>  
94.             </releases>  
95.             <snapshots>  
96.                 <enabled>true</enabled>  
97.             </snapshots>  
98.         </pluginRepository>  
99.     </pluginRepositories>  
100.       
101.     <build>  
102.           
103.         <!--   
104.         <resources>  
105.             <resource>  
106.                 <directory>src/main/resources</directory>  
107.                 <filtering>true</filtering>  
108.             </resource>  
109.         </resources>  
110.          -->  
111.         <plugins>  
112.         <!-- 指定在jdk1.6环境下编译 -->  
113.           
114.             <plugin>  
115.                 <groupId>org.apache.maven.plugins</groupId>  
116.                 <artifactId>maven-compiler-plugin</artifactId>  
117.                 <version>3.1</version>  
118.                 <configuration>  
119.                     <source>1.6</source>  
120.                     <target>1.6</target>  
121.                 </configuration>  
122.             </plugin>  
123.         </plugins>  
124.     </build>  
125.   
126.     <dependencies>  
127.         <!-- spring 有关jar -->  
128.         <dependency>  
129.             <groupId>org.springframework</groupId>  
130.             <artifactId>spring-core</artifactId>  
131.             <version>${springframework.version}</version>  
132.         </dependency>  
133.         <dependency>  
134.             <groupId>org.springframework</groupId>  
135.             <artifactId>spring-context</artifactId>  
136.             <version>${springframework.version}</version>  
137.         </dependency>  
138.         <dependency>  
139.             <groupId>org.springframework</groupId>  
140.             <artifactId>spring-beans</artifactId>  
141.             <version>${springframework.version}</version>  
142.         </dependency>  
143.         <dependency>  
144.             <groupId>org.springframework</groupId>  
145.             <artifactId>spring-web</artifactId>  
146.             <version>${springframework.version}</version>  
147.         </dependency>  
148.         <dependency>  
149.             <groupId>org.springframework</groupId>  
150.             <artifactId>spring-jdbc</artifactId>  
151.             <version>${springframework.version}</version>  
152.         </dependency>  
153.   
154.         <!-- oracle 驱动 -->  
155.         <dependency>  
156.             <groupId>com.oracle</groupId>  
157.             <artifactId>ojdbc6</artifactId>  
158.             <version>11.2.0.3.0</version>  
159.         </dependency>  
160.   
161.         <!-- 采用dbcp数据源 -->  
162.             <dependency>  
163.                 <groupId>commons-dbcp</groupId>  
164.                 <artifactId>commons-dbcp</artifactId>  
165.                 <version>1.4</version>  
166.             </dependency>  
167.   
168.             <!-- comomons jar -->  
169.             <dependency>  
170.                 <groupId>commons-lang</groupId>  
171.                 <artifactId>commons-lang</artifactId>  
172.                 <version>2.4</version>  
173.             </dependency>  
174.   
175.             <dependency>  
176.                 <groupId>commons-io</groupId>  
177.                 <artifactId>commons-io</artifactId>  
178.                 <version>2.4</version>  
179.             </dependency>  
180.   
181.             <dependency>  
182.                 <groupId>commons-logging</groupId>  
183.                 <artifactId>commons-logging</artifactId>  
184.                 <version>1.1.1</version>  
185.             </dependency>  
186.   
187.             <dependency>  
188.                 <groupId>commons-collections</groupId>  
189.                 <artifactId>commons-collections</artifactId>  
190.                 <version>3.2</version>  
191.             </dependency>  
192.   
193.             <dependency>  
194.                 <groupId>commons-beanutils</groupId>  
195.                 <artifactId>commons-beanutils</artifactId>  
196.                 <version>1.8.3</version>  
197.             </dependency>  
198.     </dependencies>  
199.       
200.       
201. </project>  

 resources插件的目标共有三个，见下图：（截图自Apache官网）

 

 分别是resources目标  testResources目标 及copy-resources目标。

resources目标默认绑定到了default生命周期的process-resources阶段， testResources目标默认绑定到了default生命周期的process-test-resources阶段。default生命周期阶段及resources插件这两个目标绑定的阶段和主要作用见下图：

 对于上图中说到的这两个插件目标的主要功能需要进行一下补充：

如果配置了如下代码，那么这个时候resources插件的resources目标会进行资源过滤处理，pom.xml配置如下：

 

Xml代码  

1. <build>  
2.           
3.            
4.         <resources>  
5.             <resource>  
6.                 <directory>src/main/resources</directory>  
7.                 <filtering>true</filtering>  
8.             </resource>  
9.         </resources>  
10.    </build>  

 

同样，如果配置了如下代码，那么这个时候resources的testResources目标会进行资源过滤处理，pom.xml配置如下：

 

Xml代码  

1. <build>  
2.         <testResources>  
3.             <testResource>  
4.                 <directory>src/test/resources</directory>  
5.                 <filtering>true</filtering>  
6.             </testResource>  
7.         </testResources>  
8.    </build>  

 

 

现在回到讲解resources插件的copy-resources目标上来，这个插件目标有两项内容是必须配置的，见下图：

 

resources插件的resources目标跟testResources目标都只有outputDirectory一个必须的配置项（都表示要讲资源文件处理到那个目录下去），而copy-resources目标多了一个resources的必须配置项，我个人的理解是这样的。首先这个resources配置项也是用来处理资源的，也包含资源过滤等功能，而copy-resources插件目标往往需要配置到resources插件目标及testResources插件目标的绑定的阶段的前面的阶段去执行，所以在resources插件目标还没有起作用执行时，可以利用copy-resources的resources必须配置项做一些预处理，比如资源过滤等（这里的resources必须项配置了之后由copy-resoueces插件目标来执行，与<build><resources><resources>下的配置没有直接关系，而且互不干涉。可以这么去理解，在main/deploy/prd下的spring配置文件，如果里面也有一些内容是用${properties}来写的，那里在copy-resources插件目标执行拷贝操作前做一个资源过滤的处理，这个功能实现就得靠copy-resouces插件目标的resources必须配置项来完成了）。

 

第四步，验证效果。先运行mvn clean install命令，然后查看applicationContext.xml文件的内容，再运行mvn clean install -P prd 命令，然后查看applicationContext.xml文件的内容，比较两次有何不同。

执行mvn clean install命令如下图：

 

运行成功，如下图：

 

编译成功后查看编译后的applicationContext.xml文件内容，如下图：

 从图中可以看到，id=dataSource的配置是开发环境的。

 

现在运行mvn clean install -P prd命令，如下图：

 

运行成功，如下图：

 

此时再来查看编译后的applicationContext.xml文件的内容，如下图：

 从上图中可以看到，applicationContext.xml文件被替换成生产环境下的了。

以上就是resources插件的copy-resources插件目标的作用。对于该插件目标下的resources必须配置项的验证，有兴趣的可以敲代码验证。