如何在Spring Boot中从资源中读取JSON文件

Question

使用Spring Boot 2.1.5版本，我们创建了以下示例Spring Boot微服务：

Maven项目结构：

MicroService
    │
    pom.xml
    src
    │
    └───main
        │ 
        ├───java
        │   │ 
        │   └───com
        │       └───microservice
        │           │
        │           └───MicroServiceApplication.java  
        │  
        └───resources
            │
            └───data.json
                │                    
                application.properties

有以下JSON文件（在src/main/Resources/data.json中）：

{"firstName": "John", "lastName": "Doe"}

微服务应用：

@SpringBootApplication
public class MicroServiceApplication {

    @Bean
    CommandLineRunner runner() {
        return args -> {
            String data = FilePathUtils.readFileToString("../src/main/resources/data.json", MicroServiceApplication.class);
            System.out.println(data);
        };
    }

    public static void main(String[] args) {
        SpringApplication.run(MicroServiceApplication.class, args);
    }
}

引发以下异常：

  java.lang.IllegalStateException: Failed to execute CommandLineRunner
  ...
  Caused by: java.io.IOException: Stream is null

FilePathUtils.java：

import io.micrometer.core.instrument.util.IOUtils;

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;

public class FilePathUtils {
    public static String readFileToString(String path, Class aClazz) throws IOException {

        try (InputStream stream = aClazz.getClassLoader().getResourceAsStream(path)) {
            if (stream == null) {
                throw new IOException("Stream is null");
            }
            return IOUtils.toString(stream, Charset.defaultCharset());
        }
    }
}

我可能做错了什么？

Answer 1

您可以使用jakson数据绑定。

JacksonObjectMapper类（com.fasterxml.Jackson.databind.ObjectMapper）是解析JSON的最简单方法之一。Jackson ObjectMapper可以从字符串、流或文件解析JSON，并创建表示解析JSON的Java对象或对象图<代码>将JSON解析为Java对象也被称为从JSON反序列化Java对象。

// create Object Mapper
ObjectMapper mapper = new ObjectMapper();

// read JSON file and map/convert to java POJO
try {
    SomeClass someClassObject = mapper.readValue(new File("../src/main/resources/data.json"), SomeClass.class);
    System.out.println(someClassObject);
} catch (IOException e) {
    e.printStackTrace();
}

您应该在.pom文件中有jakson数据绑定：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.11.4</version>
</dependency>

Answer 2

在Spring Boot项目中，您可以使用ResourceUtils

Path file = ResourceUtils.getFile("data/data.json").toPath();

或ClassPathResource

String clsPath =  new ClassPathResource("data/data.json").getPath();

有时，如果您正在读取不同的扩展文件，如.graphql或.mmdb或.json，则需要使用springResourceLoader将其作为InputStream来读取，本文有明确的解释

@Autowire
private ResourceLoader resourceLoader;

   Resource resource =resourceLoader.getResource("classpath:GeoLite2-Country.mmdb");
   InputStream dbAsStream = resource.getInputStream();

并使用文件将输入流复制到临时文件中。复制

Files.copy(inputStream, outputFile.toPath(), StandardCopyOption.REPLACE_EXISTING);

Answer 3

虽然@Deadpool已经给出了答案，但我想补充一点，当创建spring boot工件时，不再有这样的src/main/文件夹（您可以打开spring boot工件并自己确认）。

因此，您不能像这样加载资源：

FilePathUtils.readFileToString("../src/main/resources/data.json", MicroServiceApplication.class);

Spring确实有一个名为Resources的抽象，可以在应用程序中使用，甚至可以注入到类/配置中：

@Value("classpath:data/data.json")
Resource resourceFile;

请注意前缀类路径这意味着资源将从类路径解析（读取所有正确打包到工件中的内容）。

有一个相当好的教程，可以方便