Maven教程之.application文件.yml文件.xml文件等资源配置-IT乾坤技术博客

[TOC]

全网教程，请访问
> <a href="https://www.itqiankun.com/" target ='_blank'>itqiankun.com</a>

## 前言

构建Maven项目的时候，如果没有进行特殊的配置，Maven会按照标准的目录结构查找和处理各种类型文件。

```java 
src/main/java和src/test/java 
```

这两个目录中的所有\*.java文件会分别在comile和test-comiple阶段被编译，编译结果分别放到了target/classes和targe/test-classes目录中，但是这两个目录中的其他文件都会被忽略掉，所以如果`Mybatis的xml文件放到了src/main/java中，此时就会再打包文件里面丢失`

```java 
src/main/resouces和src/test/resources
```

如下所示:

![itqiankun.com.790527251.png][]

## 打包时资源文件的配置

### 打包src/main/java目录下的xml

一般情况下，我们用到的资源文件(各种xml，properites，xsd文件等)都放在src/main/resources下面，利用maven打包时，maven能把这些资源文件打包到相应的jar或者war里。

有时候，比如mybatis的mapper.xml文件，我们习惯把它和Mapper.java放一起，都在src/main/java下面，这样利用maven打包时，就需要修改pom.xml文件，来把mapper.xml文件一起打包进jar或者war里了，否则，这些文件不会被打包的。(maven认为src/main/java只是java的源代码路径)

下面通过一个简单的示例来说明:

项目结构如下所示，有两个UserMaper.xml文件，所在目录不同

![itqiankun.com.790527252.png][]

默认情况下，在POM.XML目录下执行: mvn clean package 打包命令在target\\classes目录下不会把UserMapper.xml打包到下mapper目录下

![itqiankun.com.790527253.png][]

而resources目录下的文件始终都会打包进jar包或war包

![itqiankun.com.790527254.png][]

这个时候使用mybatis就会出一些问题，找不到UserMapper所对应的xml文件解决方法有如下几种:

#### pom.xml的resources实现

```java 
        <build>
               
            <resources>    
                <resource>    
                        
                    <directory>src/main/java</directory>    
    
                         
    				 <includes>
    					  <include>**/*.xml</include>
    				 </includes>  
                    
    				<excludes>  
    					<exclude>**/*.yaml</exclude>  
    				</excludes>  
    
                          
                          
       
                        
                    <filtering>true</filtering>     
                </resource>  			
            </resources> 	
      </build>
```

其中\*\*/\*这样的写法，是为了保证各级子目录下的资源文件被打包。resources是可以看做是容器，这个容器里面可以放很多个像resource这样的配置。而directory就是配置文件所在的路径，includes从英文单词角度看，就是包含的意思，此时在执行命令，就会把xml也打包到mapper目录下了

![itqiankun.com.790527255.png][]

##### 注意此时默认的resources会失效

默认情况下，如果没有指定resources，目前认为自动会将src/main/resources下的.xml文件放到target里头的classes文件夹下的package下的文件夹里。

如果设定了resources，那么默认的就会失效，因此此时必须手动设置`src/main/resources`的资源配置路径

#### maven-resources-plugin插件实现

为了使项目结构更为清晰，Maven区别对待Java代码文件和资源文件，maven-compiler-plugin用来编译Java代码，maven-resources-plugin则用来处理资源文件。

默认的主资源文件目录是src/main/resources，很多用户会需要添加额外的资源文件目录，这个时候就可以通过配置maven-resources-plugin来实现。

```java 
                
                <plugin>
                    <artifactId>maven-resources-plugin</artifactId>
                    <version>2.5</version>
                    <executions>
                        <execution>
                            <id>copy-xmls</id>
                            <phase>process-sources</phase>
                            <goals>
                                <goal>copy-resources</goal>
                            </goals>
                            <configuration>
                                <outputDirectory>${basedir}/target/classes</outputDirectory>
                                <resources>
                                    <resource>
                                        <directory>${basedir}/src/main/java</directory>
                                        <includes>
                                            <include>**/*.xml</include>
                                        </includes>
                                    </resource>
                                </resources>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
```

此外，资源文件过滤也是Maven的一大特性，你可以在资源文件中使用$\{propertyName\}形式的Maven属性，然后配置maven-resources-plugin开启对资源文件的过滤，之后就可以针对不同环境通过命令行或者Profile传入属性的值，以实现更为灵活的构建。

```java 
    <plugin>
    	<groupId>org.apache.maven.plugins</groupId>
    	<artifactId>maven-resources-plugin</artifactId>
    	<configuration>
    		<encoding>UTF-8</encoding>
    		
    		<nonFilteredFileExtensions>
    			<nonFilteredFileExtension>pem</nonFilteredFileExtension>
    			<nonFilteredFileExtension>pfx</nonFilteredFileExtension>
    			<nonFilteredFileExtension>p12</nonFilteredFileExtension>
    		</nonFilteredFileExtensions>
    	</configuration>
    </plugin>
```

### src/main/resources目录下的xml等资源文件不被打包

#### pom.xml的resources配置实现

默认resources目录下的文件都会被打包，如果想resources目录下的xml文件不被打包，可通过如下配置:

```java 
    	
    	<resources>  
            <resource>  
                <directory>src/main/resources</directory>  
                <includes>  
                    <include>*.properties</include>  
                </includes>  
                <excludes>  
                    <exclude>*.xml</exclude>  
                    <exclude>*.yaml</exclude>  
                </excludes>  
            </resource>  
        </resources>
```

编译之后如下:

![itqiankun.com.790527256.png][]

#### maven-resources-plugin插件实现

```java 
        <plugin>  
            <artifactId>maven-resources-plugin</artifactId>  
            <executions>  
                <execution>  
                    <id>copy-resources</id>  
                    <phase>validate</phase>  
                    <goals>  
                        <goal>copy-resources</goal>  
                    </goals>  
                    <configuration>  
    
    					
                        <outputDirectory>${project.build.directory}/conf</outputDirectory>  
                        <resources>  
                            <resource>  
                                <directory>src/main/resources</directory>  
    							  
    							<excludes> <exclude>**/*.xml</exclude> </excludes>
                                <filtering>true</filtering>  
                            </resource>  
                        </resources>  
                    </configuration>  
                </execution>  
            </executions>  
        </plugin> 
```

实现的效果如下:

![itqiankun.com.790527257.png][]

编译好之后，会在target目录下生成conf目录并且把resources目录下的所有文件都自动拷贝到target/conf/目录下

[itqiankun.com.790527251.png]: https://itqiankun.oss-cn-beijing.aliyuncs.com/new_picture/myblog/2021/10/27/itqiankun.com.790527251.png
[itqiankun.com.790527252.png]: https://itqiankun.oss-cn-beijing.aliyuncs.com/new_picture/myblog/2021/10/27/itqiankun.com.790527252.png
[itqiankun.com.790527253.png]: https://itqiankun.oss-cn-beijing.aliyuncs.com/new_picture/myblog/2021/10/27/itqiankun.com.790527253.png
[itqiankun.com.790527254.png]: https://itqiankun.oss-cn-beijing.aliyuncs.com/new_picture/myblog/2021/10/27/itqiankun.com.790527254.png
[itqiankun.com.790527255.png]: https://itqiankun.oss-cn-beijing.aliyuncs.com/new_picture/myblog/2021/10/27/itqiankun.com.790527255.png
[http_maven.apache.org_pom.html_Resources]: http://maven.apache.org/pom.html#Resources
[itqiankun.com.790527256.png]: https://itqiankun.oss-cn-beijing.aliyuncs.com/new_picture/myblog/2021/10/27/itqiankun.com.790527256.png
[itqiankun.com.790527257.png]: https://itqiankun.oss-cn-beijing.aliyuncs.com/new_picture/myblog/2021/10/27/itqiankun.com.790527257.png

Maven教程之.application文件.yml文件.xml文件等资源配置

全部教程