Spring Boot 获取 Resources 资源文件方法

本文旨在提供在 Spring Boot 应用中安全可靠地读取 src/main/resources 目录下资源文件的实用方法。重点介绍如何使用 ClassPathResource 和 FileCopyUtils 类，避免在打包成 JAR 文件后可能出现的问题，并提供代码示例和注意事项，帮助开发者轻松获取资源文件内容。

在 Spring Boot 应用开发中，经常需要读取位于 src/main/resources 目录下的配置文件、密钥文件或其他静态资源。直接使用文件路径读取在开发环境中可能有效，但当应用打包成 JAR 文件后，这种方式往往会失效。这是因为 JAR 文件内部的文件结构与普通文件系统不同。本文将介绍一种利用 Spring Framework 提供的工具类，安全可靠地读取资源文件内容的方法。

使用 ClassPathResource 和 FileCopyUtils

Spring Framework 提供了 ClassPathResource 类，它能够方便地访问类路径下的资源。结合 FileCopyUtils 类，我们可以轻松地将资源文件内容读取到字节数组或字符串中。

以下是一个示例工具方法，用于读取指定路径的资源文件内容：

import org.springframework.core.io.ClassPathResource;
import org.springframework.util.FileCopyUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.Objects;

public class ResourceUtil {

    private static final Logger log = LoggerFactory.getLogger(ResourceUtil.class);

    public static String getResourceFileContent(String resourcePath) {
        Objects.requireNonNull(resourcePath, "Resource path cannot be null");
        ClassPathResource resource = new ClassPathResource(resourcePath);
        try {
            byte[] bytes = FileCopyUtils.copyToByteArray(resource.getInputStream());
            return new String(bytes);
        } catch (IOException ex) {
            log.error("Failed to parse resource file: " + resourcePath, ex);
            return null; // Or throw an exception, depending on your needs
        }
    }
}

代码解释：

1. Objects.requireNonNull(resourcePath, "Resource path cannot be null"): 首先，对传入的 resourcePath 进行非空校验，防止出现空指针异常。
2. ClassPathResource resource = new ClassPathResource(resourcePath): 创建一个 ClassPathResource 对象，指定要读取的资源路径。 resourcePath 是相对于 src/main/resources 目录的路径。例如，要读取 src/main/resources/key/private.pem 文件，resourcePath 应为 "key/private.pem"。
3. FileCopyUtils.copyToByteArray(resource.getInputStream()): 使用 FileCopyUtils 类的 copyToByteArray() 方法，将资源文件的输入流读取到字节数组中。
4. new String(bytes): 将字节数组转换为字符串，并返回。
5. try-catch 块: 捕获可能发生的 IOException，例如文件不存在或读取失败。在 catch 块中，记录错误日志，并根据实际需求选择返回 null 或抛出异常。

使用示例：

String privateKeyContent = ResourceUtil.getResourceFileContent("key/private.pem");
if (privateKeyContent != null) {
    System.out.println("Private Key Content: " + privateKeyContent);
} else {
    System.out.println("Failed to read private key file.");
}

注意事项

• 资源路径： 确保 resourcePath 参数正确，它是相对于 src/main/resources 目录的相对路径。
• 异常处理： 在 catch 块中进行适当的异常处理。根据业务需求，可以选择记录日志、返回 null 或抛出自定义异常。
• 字符编码： 如果资源文件包含特殊字符，需要考虑字符编码问题。可以在创建字符串时指定字符编码，例如 new String(bytes, StandardCharsets.UTF_8)。
• 依赖： 确保你的 Spring Boot 项目中包含了 spring-core 和 spring-util 依赖。通常 Spring Boot 项目会自动引入这些依赖，但最好还是检查一下。

总结

使用 ClassPathResource 和 FileCopyUtils 是在 Spring Boot 应用中读取 src/main/resources 目录下资源文件的推荐方法。它不仅简单易用，而且能够保证在开发环境和打包后的 JAR 文件中都能正常工作。通过本文提供的示例代码和注意事项，你可以轻松地将这种方法应用到你的项目中，提高代码的可靠性和可维护性。