SpringBoot如何读取资源目录中的JSON文件

在Spring Boot应用程序中，读取资源目录（src/main/resources）中的JSON文件是一个常见的需求。无论是用于配置、初始化数据，还是其他用途，Spring Boot提供了多种方式来实现这一目标。本文将介绍几种常用的方法，帮助开发者轻松读取资源目录中的JSON文件。

1. 使用ClassPathResource类

ClassPathResource是Spring框架提供的一个工具类，用于访问类路径下的资源文件。通过它，我们可以轻松地读取资源目录中的JSON文件。

示例代码

import org.springframework.core.io.ClassPathResource;
import org.springframework.util.FileCopyUtils;

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

public class JsonFileReader {

    public String readJsonFile(String filePath) throws IOException {
        ClassPathResource resource = new ClassPathResource(filePath);
        InputStream inputStream = resource.getInputStream();
        byte[] bytes = FileCopyUtils.copyToByteArray(inputStream);
        return new String(bytes, StandardCharsets.UTF_8);
    }
}

使用方式

public class Main {
    public static void main(String[] args) {
        JsonFileReader reader = new JsonFileReader();
        try {
            String jsonContent = reader.readJsonFile("data.json");
            System.out.println(jsonContent);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

解释

• ClassPathResource用于定位类路径下的资源文件。
• getInputStream()方法返回一个输入流，用于读取文件内容。
• FileCopyUtils.copyToByteArray()将输入流转换为字节数组，最后将其转换为字符串。

2. 使用ResourceLoader接口

ResourceLoader是Spring框架中用于加载资源的接口。通过注入ResourceLoader，我们可以更方便地读取资源文件。

示例代码

import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.stereotype.Service;
import org.springframework.util.FileCopyUtils;

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

@Service
public class JsonFileReaderService {

    private final ResourceLoader resourceLoader;

    public JsonFileReaderService(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    public String readJsonFile(String filePath) throws IOException {
        Resource resource = resourceLoader.getResource("classpath:" + filePath);
        InputStream inputStream = resource.getInputStream();
        byte[] bytes = FileCopyUtils.copyToByteArray(inputStream);
        return new String(bytes, StandardCharsets.UTF_8);
    }
}

使用方式

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class JsonFileReaderRunner implements CommandLineRunner {

    @Autowired
    private JsonFileReaderService jsonFileReaderService;

    @Override
    public void run(String... args) throws Exception {
        String jsonContent = jsonFileReaderService.readJsonFile("data.json");
        System.out.println(jsonContent);
    }
}

解释

• ResourceLoader接口提供了getResource()方法，用于加载资源文件。
• classpath:前缀表示从类路径下加载资源。
• 通过@Autowired注入ResourceLoader，可以在Spring管理的Bean中使用。

3. 使用@Value注解

Spring Boot还支持通过@Value注解直接将资源文件的内容注入到字段中。这种方式适用于较小的JSON文件。

示例代码

import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Service;
import org.springframework.util.FileCopyUtils;

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

@Service
public class JsonFileReaderService {

    @Value("classpath:data.json")
    private Resource resource;

    public String readJsonFile() throws IOException {
        InputStream inputStream = resource.getInputStream();
        byte[] bytes = FileCopyUtils.copyToByteArray(inputStream);
        return new String(bytes, StandardCharsets.UTF_8);
    }
}

使用方式

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class JsonFileReaderRunner implements CommandLineRunner {

    @Autowired
    private JsonFileReaderService jsonFileReaderService;

    @Override
    public void run(String... args) throws Exception {
        String jsonContent = jsonFileReaderService.readJsonFile();
        System.out.println(jsonContent);
    }
}

解释

• @Value注解用于将资源文件直接注入到字段中。
• classpath:前缀表示从类路径下加载资源。
• 通过Resource对象获取输入流并读取文件内容。

4. 使用Jackson库解析JSON

在读取JSON文件后，通常需要将其解析为Java对象。Spring Boot默认集成了Jackson库，可以方便地将JSON字符串转换为Java对象。

示例代码

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Service;

import java.io.IOException;

@Service
public class JsonFileReaderService {

    private final ObjectMapper objectMapper = new ObjectMapper();

    public <T> T readJsonFile(String filePath, Class<T> clazz) throws IOException {
        ClassPathResource resource = new ClassPathResource(filePath);
        return objectMapper.readValue(resource.getInputStream(), clazz);
    }
}

使用方式

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class JsonFileReaderRunner implements CommandLineRunner {

    @Autowired
    private JsonFileReaderService jsonFileReaderService;

    @Override
    public void run(String... args) throws Exception {
        MyDataObject data = jsonFileReaderService.readJsonFile("data.json", MyDataObject.class);
        System.out.println(data);
    }
}

解释

• ObjectMapper是Jackson库的核心类，用于将JSON字符串转换为Java对象。
• readValue()方法将输入流中的JSON数据解析为指定类型的Java对象。

总结

Spring Boot提供了多种方式来读取资源目录中的JSON文件。无论是使用ClassPathResource、ResourceLoader，还是@Value注解，开发者都可以根据具体需求选择合适的方法。此外，结合Jackson库，可以轻松地将JSON数据解析为Java对象，进一步简化开发流程。希望本文的介绍能帮助你在Spring Boot项目中高效地处理JSON文件。