[转]SpringBoot读取Resource下文件的几种方式

SpringBoot读取Resource下文件的几种方式

最近在项目中涉及到Excle的导入功能，通常是我们定义完模板供用户下载，用户按照模板填写完后上传；这里模板位置resource/excelTemplate/test.xlsx，尝试了四种读取方式，并且测试了四种读取方式分别的windows开发环境下(IDE中)读取和生产环境(linux下jar包运行读取)。
第一种：

ClassPathResource classPathResource = new ClassPathResource("excleTemplate/test.xlsx");
InputStream inputStream =classPathResource.getInputStream();

第二种：

InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("excleTemplate/test.xlsx");

第三种：

InputStream inputStream = this.getClass().getResourceAsStream("/excleTemplate/test.xlsx");

第四种：

File file = ResourceUtils.getFile("classpath:excleTemplate/test.xlsx");
InputStream inputStream = new FileInputStream(file);

经测试：
前三种方法在开发环境(IDE中)和生产环境(linux部署成jar包)都可以读取到，第四种只有开发环境 时可以读取到，生产环境读取失败。
推测主要原因是springboot内置tomcat，打包后是一个jar包，因此通过文件读取获取流的方式行不通，因为无法直接读取压缩包中的文件，读取只能通过类加载器读取。
前三种都可以读取到其实殊途同归，直接查看底层代码都是通过类加载器读取文件流，类加载器可以读取jar包中的编译后的class文件，当然也是可以读取jar包中的文件流了。
用解压软件打开jar包查看结果如下：

 

 其中cst文件中是编译后class文件存放位置，excleTemplate是模板存放位置，类加载器读取的是cst下class文件，同样可以读取excleTemplate下的模板的文件流了。

springboot项目获取resources路径（相对路径）

springboot文件上传保存到resources里,用

System.getProperty("user.dir");参数即可获得项目相对路径。（ps：不知道是不是springboot内嵌tomcat容器的原因，用网上的request.getServletContext().getRealPath("/")方法获得的路径不是项目路径，而是c盘下一个tomcat目录路径）

File directory = new File("src/main/resources");
String courseFile = directory.getCanonicalPath();这种方式也能获取到一样的结果

 

最终版：ResourcesController.java

package tb.view.sbmsm.easyuidemo.controller;

import org.apache.commons.lang3.StringUtils;
import org.springframework.core.io.ClassPathResource;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import tb.helper.IOHelper;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * <pre>
 *
 * </pre>
 *
 * @author wangyunpeng
 * @date 2020/1/19 13:55
 */

@Controller
@RequestMapping("/Resources")
public class ResourcesController {
    /**
     * http://stackoverflow.com/questions/19721820/pattern-matching-to-get-only-class-names-from-css-file
     */
    private final Pattern _regex = Pattern.compile("\\.(.*)\\s?\\{", Pattern.MULTILINE);
    private String _icons;
    /**
     * Logger for this class
     */
    private final org.slf4j.Logger _logger = org.slf4j.LoggerFactory.getLogger(this.getClass());

    @RequestMapping(value = "IconData", produces = "application/json;charset=UTF-8")
    @ResponseBody
    public String iconData(HttpServletRequest request, HttpServletResponse response) throws IOException {
        if (this._icons == null) {

            // region 第一种方式：springboot项目获取resources路径（相对路径），只能开发用，部署路径不知道什么
//            //https://blog.csdn.net/qq_29669265/article/details/89678077?depth_1-utm_source=distribute.pc_relevant.none-task&utm_source=distribute.pc_relevant.none-task
//            String physicalUserDir = System.getProperty("user.dir");//项目的物理路径
//            File virtualPathFile = new File("src/main/resources/static/Content/jquery.easyUI/1.5.1/themes/icon.css");//相对路径，只能开发用，部署路径不知道什么
//            String physicalPath = virtualPathFile.getCanonicalPath();//物理路径
//            if (!IOHelper.isExistFilePath(physicalPath)) {
//                return "[]";
//            }
//            String iconsText = null;
//            try {
//                iconsText = IOHelper.readAllText(physicalPath);
//            } catch (IOException e) {
//                this._logger.error("ResourcesController.iconData()", e);
//            }
            // endregion

            // region SpringBoot读取Resource下文件的几种方式（通过类加载器读取文件流，类加载器可以读取jar包中的编译后的class文件，当然也是可以读取jar包中的文件流了）
            //https://www.jianshu.com/p/7d7e5e4e8ae3
            ClassPathResource classPathResource = new ClassPathResource("static/Content/jquery.easyUI/1.5.1/themes/icon.css");
            if (classPathResource == null) {
                return "[]";
            }
            String iconsText = null;
            try (InputStream inputStream = classPathResource.getInputStream()) {
                iconsText = IOHelper.readAllText(inputStream);
            } catch (IOException e) {
                this._logger.error("ResourcesController.iconData()", e);
                return "[]";
            }
            // endregion

            StringBuilder sb = new StringBuilder("[{\"text\":\"无\",\"value\":\"\"}");
            if (StringUtils.isNotBlank(iconsText)) {
                Matcher matcher = this._regex.matcher(iconsText);
                String value = null;
                while (matcher.find()) {
                    value = matcher.group(1).trim();
                    sb.append(String.format(",{\"text\":\"%s\",\"value\":\"%s\"}", value, value));
                }
            }
            sb.append("]");
            this._icons = sb.toString();
            sb = null;
        }
        return this._icons;
    }
}