Spring Boot 访问静态资源缺少 scr/main/resources

Posted 2023-02-26

【中文标题】Spring Boot 访问静态资源缺少 scr/main/resources

【英文标题】：Spring Boot access static resources missing scr/main/resources

【发布时间】：2016-07-22 04:05:23

【问题描述】：

我正在开发一个 Spring Boot 应用程序。我需要在开始时解析一个 XML 文件 (countries.xml)。问题是我不知道把它放在哪里以便我可以访问它。 我的文件夹结构是

ProjectDirectory/src/main/java
ProjectDirectory/src/main/resources/countries.xml

我的第一个想法是将它放在 src/main/resources 中，但是当我尝试创建文件 (countries.xml) 时，我得到一个 NPE，并且堆栈跟踪显示我的文件在 ProjectDirectory 中查找（所以 src/main /resources/ 未添加）。我尝试创建文件（resources/countries.xml），路径看起来像 ProjectDirectory/resources/countries.xml（所以再次没有添加 src/main）。

我尝试添加这个没有结果

@Override
public void addResourceHandlers(final ResourceHandlerRegistry registry) 
    registry.addResourceHandler("/resources/**").addResourceLocations("/resources/");
    registry.setOrder(Ordered.HIGHEST_PRECEDENCE);
    super.addResourceHandlers(registry);

我知道我可以手动添加 src/main/，但我想了解它为什么不能正常工作。我还尝试了 ResourceLoader 的示例 - 同样没有结果。

谁能指出问题出在哪里？

更新： 仅供参考——在构建项目后，我遇到了访问文件的问题，所以我将 File 更改为 InputStream

InputStream is = new ClassPathResource("countries.xml").getInputStream();

【问题讨论】：

你是在 web.xml 或任何配置文件中添加这个文件来告诉应用它存在

仅将文件添加到文件夹不会帮助应用扫描文件

我没有 web.xml，我有一个基于 Java 的配置。你能告诉我我应该考虑什么吗？也许你有任何样品？非常感谢！！！

luboskrnac 的好推荐

对于基于注释的解决方案：***.com/a/39472514/159837

【参考方案1】：

只需使用 Spring 类型ClassPathResource。

File file = new ClassPathResource("countries.xml").getFile();

只要这个文件在类路径中的某个地方，Spring 就会找到它。在开发和测试期间可以是src/main/resources。在生产中，它可以是当前运行目录。

编辑： 如果文件在胖 JAR 中，则此方法不起作用。在这种情况下，您需要使用：

InputStream is = new ClassPathResource("countries.xml").getInputStream();

【讨论】：

非常感谢！！这真的救了我！它现在确实按预期工作

如何将此文件转换为 JSONObejct？ （起初数据是 JSONobject）

只是添加到@luboskrnac 的答案，也尝试使用File file = new ClassPathResource(".\countries.xml").getFile();

Per this answer resource.getFile() 期望文件位于实际文件系统上，并且此解决方案在 JAR 中无法用于访问存储在 src/main/resources 下的资源。我已经用一个简单的 Spring Boot 应用程序确认了。

@smeeb 谢谢。使用 InputStream inputStream = new ClassPathResource("countries.xml").getInputStream(); 对我有用

【参考方案2】：

获取类路径中的文件：

Resource resource = new ClassPathResource("countries.xml");
File file = resource.getFile();

要读取文件 onStartup 使用@PostConstruct:

@Configuration
public class ReadFileOnStartUp 

    @PostConstruct
    public void afterPropertiesSet() throws Exception 

        //Gets the XML file under src/main/resources folder
        Resource resource = new ClassPathResource("countries.xml");
        File file = resource.getFile();
        //Logic to read File.
    

这是一个Small example，用于在 Spring Boot App 启动时读取 XML 文件。

【讨论】：

感谢您的回答！第一部分，按照你和 luboskrnac 的建议救了我！

@ElenaChubukina 看看示例。你说你需要在启动时解析 xml....

谢谢！解析文件的部分没有问题（只有在类路径上查找文件的部分） - 我使用 CommandLineRunner，它对我来说很好

【参考方案3】：

在使用 Spring Boot 应用程序时，当它部署为 JAR 时，很难使用 resource.getFile() 获取类路径资源，因为我遇到了同样的问题。 此扫描使用 Stream 解决，它将找出放置在类路径中任何位置的所有资源。

下面是相同的代码sn-p -

ClassPathResource classPathResource = new ClassPathResource("fileName");
InputStream inputStream = classPathResource.getInputStream();
content = IOUtils.toString(inputStream);

【讨论】：

它有效。还有一件事，请在你的springboot应用程序中使用依赖：commons-iocommons-io2.6。旧的“toString”函数已弃用。您必须使用新版本：IOUtils.toString(inputStream, "UTF-8")

【参考方案4】：

你需要使用以下构造

InputStream in = getClass().getResourceAsStream("/yourFile");

请注意，您必须在文件名前添加此斜杠。

【参考方案5】：

您可以使用以下代码从资源文件夹中读取字符串中的文件。

final Resource resource = new ClassPathResource("public.key");
String publicKey = null;
try 
     publicKey = new String(Files.readAllBytes(resource.getFile().toPath()), StandardCharsets.UTF_8);
 catch (IOException e) 
     e.printStackTrace();

【参考方案6】：

我用的是spring boot，所以我可以简单使用：

File file = ResourceUtils.getFile("classpath:myfile.xml");

【参考方案7】：

我用的是Spring Boot，我的解决方法是

"src/main/resources/myfile.extension"

希望对某人有所帮助。

【参考方案8】：

由于java.net.URL不足以处理各种底层资源，Spring引入了org.springframework.core.io.Resource。要访问资源，我们可以使用@Value 注解或 ResourceLoader 类。 @自动连线 私有资源加载器资源加载器；

@覆盖 public void run(String... args) 抛出异常

    Resource res = resourceLoader.getResource("classpath:thermopylae.txt");

    Map<String, Integer> words =  countWords.getWordsCount(res);

    for (String key : words.keySet()) 

        System.out.println(key + ": " + words.get(key));