经验——SpringBoot 获取 resource 目录下的文件

本人个人博客网站，欢迎访问：学教府

一、背景

介绍： 在业务开发中，我们可能会将几个文件打包成一个压缩文件，而有些文件是固定不变的，可以提前放在资源文件 resource 下面。
这时我们只需要根据相对路径来获取文件。功能看起来很简单，但是遇到的坑倒是不少啊！

二、配置 maven

1. 在文件编译时，需要将 resource 目录下的文件拷贝到 target 目录的 classes 目录下面，这个才是运行时的文件。因为是使用了 maven ，所以此处是在 pom 文件进行配置。如下(只贴出关键点)，这是最终能使用的版本：

   	<profiles>
   		<profile>
   			<id>dev</id>
   			<activation>
   				<activeByDefault>true</activeByDefault>
   			</activation>
   			<build>
   				<resources>
   					<!-- 把资源文件拷贝到classs目录下 -->
   					<resource>
   						<targetPath>${project.build.directory}/classes</targetPath>
   						<directory>src/main/resources</directory>
   						<!-- 开启过滤，用指定的参数替换directory下的文件中的参数 -->
   						<filtering>true</filtering>
   						<!-- 指定具体的文件，带扩展名 -->
   						<includes>
   							<include>**/*.xml</include>
   							<include>**/*.properties</include>
   							<include>**/*.Filter</include>
   						</includes>
   						<!-- 排除文件 -->
   						<excludes>
   							<exclude>**/*.exe</exclude>
   							<exclude>**/*.EXE</exclude>
   						</excludes>
   					</resource>
   					<resource>
   						<targetPath>${project.build.directory}/classes</targetPath>
   						<directory>src/main/resources</directory>
   						<!-- 不开启过滤 -->
   						<filtering>false</filtering>
   						<includes>
   							<!-- 改匹配规则是将 resource 目录下的所有文件夹及文件都包含 -->
   							<include>**/*</include>
   						</includes>
   					</resource>
   					<!-- 把资源文件log4j到classs目录下 -->
   					<resource>
   						<targetPath>${project.build.directory}/classes</targetPath>
   						<directory>${project.basedir}../../build/template/log-template</directory>
   						<filtering>true</filtering>
   						<includes>
   							<include>**/*</include>
   						</includes>
   					</resource>
   				</resources>
   			</build>
   		</profile>
   	</profiles>
   

2. 开启过滤的效果，可以查看博客： maven filtering 标签说明
3. 遇到的问题：
   1. 在 resource 目录下放 exe 文件时，打包到 target 的目录下时，文件大小总是会多出 几百kb ，并且文件不能使用。解决：将 exe 文件的拷贝配置需要放在 filtering 标签为 false 下面。
   2. 当文件没有后缀时，获取文件失败。原因是在配置资源拷贝时，总是设置了后缀名，导致无后缀文件没有匹配上。解决: 将资源的配置设置为目录，即上面配置第二个 resource 下的 include 标签 。

三、获取文件

1. 此时就应该对文件进行获取了，获取资源的方法很多种。我下面就说出两种：

   // 1. 第一种
   file = ResourceUtils.getFile("classpath:" + path);
   
   // 2.第二种（推荐）
   ClassPathResource cpr = new ClassPathResource(path);
   file = cpr.getFile();
   

2. 说明：此处的 path 是相对路径（记得文件的路径分隔符使用：File.separator）。推荐使用第二种方式，因为在网上搜到文章说第一种在 centOS 会出问题，可以查看：SpringBoot 不要使用 ResourceUtils 读取资源文件

四、总结

1. 步骤为：配置maven --> 将文件放置对应 resource 目录 --> 使用 ClassPathResource 根据相对路径获取文件
2. 我们在开发时，即使是很小的功能，也可能会遇到很多意想不到的问题，需要静心慢慢排查