[轉]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;
    }
}