Spring Boot 读取 resources 文件

模板类的文件咱为了省事，一般都是放在项目的 resources 文件夹的，那么怎么读取呢，而且 Spring Boot 编译后是一个 jar 包，可能在本地启动的时候是可以读取的，但是放在 linux 环境下是 jar，就不行了

场景一：读文本

假如我 resources 里面有这么2个文件
resources/template/Invoice.html
resources/template/Voucher.html

import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import cn.hutool.core.io.IoUtil;

Resource invoiceResource = new ClassPathResource("template/Invoice.html");
Resource voucherResource = new ClassPathResource("template/Voucher.html");

String Invoice = IoUtil.read(invoiceResource.getInputStream(), StandardCharsets.UTF_8);
String Voucher = IoUtil.read(voucherResource.getInputStream(), StandardCharsets.UTF_8);

方法二

InputStream invoiceStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("template/Invoice.html");

【推荐】文本读取工具类

import cn.hutool.core.io.IoUtil;
import cn.hutool.core.util.CharsetUtil;
import lombok.SneakyThrows;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;

import java.io.InputStream;

/**
 * 获取 Resource 文件夹文件，main + jar 都适用
 *
 * @author jason
 */
public class ResourceUtil {

    public static void main(String[] args) {
        System.out.println(readStringGBK("records/content/records-20231004164141.txt"));
    }

    /**
     * 获取 InputStream
     */
    @SneakyThrows
    public static InputStream getInputStream(String path) {
        Resource resource = new ClassPathResource(path);
        return resource.getInputStream();
    }

    /**
     * 获取字符串-urf8
     */
    @SneakyThrows
    public static String readStringUtf8(String path) {
        return IoUtil.readUtf8(getInputStream(path));
    }

    /**
     * 获取字符串-gbk
     */
    @SneakyThrows
    public static String readStringGBK(String path) {
        return IoUtil.read(getInputStream(path), CharsetUtil.GBK);
    }

}

场景二：读路径

假如别人提供的入口只支持路径入参，那么读取文件就不适用了，此时我们可以这样
假如我 resources 里面有这么1个文件，font/SourceSansPro-Black.ttf，怎么读取文件路径，并兼容 Win 和 Linux，只需要这样写就可以了

import cn.hutool.system.SystemUtil;

String fontPath = "font/SourceSansPro-Black.ttf"'

if (SystemUtil.getOsInfo().isWindows()) {
	fontPath = new ClassPathResource(fontPath).getFile().getPath();
}

场景三

需求：目标框架只能读取外部路径，但外部路径难以维护，需要在项目内 resource 管理起来
解决：在启动后，将 resource 内的文件复制到外部路径，方便管理

import cn.hutool.core.io.FileUtil;
import cn.hutool.core.io.IoUtil;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Component;

import java.io.File;

/**
 * 配置文件初始化
 * - 模板
 *
 * @author jason
 */
@Component
public class InitializingBeanInit implements InitializingBean {

    /**
     * 复制至磁盘路径，项目内使用文件路径
     */
    @Value("${spring.freemark.path:/temp/}")
    private String templatePath;

    @Override
    public void afterPropertiesSet() throws Exception {
        List<String> fileNameList = CollUtil.newArrayList(
                "a.word",
                "b.xlsx",
                "c.tl",
        );
        for (String fileName : files) {
            Resource fileResource = new ClassPathResource("templates/" + fileName);
            FileUtil.writeBytes(IoUtil.readBytes(fileResource.getInputStream()), FileUtil.file(templatePath + fileName));
        }
    }

}