如何使用 Java 将 JSON 文件读取为字符串？这三种方法很管用！

news2024/11/15 10:25:54

JSON (JavaScript Object Notation) 是一种轻量级的数据交换格式，它可以用来存储和传输结构化的数据。在 Java 中，有多种方法可以将 JSON 文件读取为字符串，本文将介绍其中的几种。

方法一：使用 java.io 包中的类

java.io 包中提供了一些类，如 FileReader、BufferedReader、InputStreamReader 等，可以用来读取文件的内容。例如，假设有一个名为 data.json 的文件，其内容如下：

{
  "name": "Alice",
  "age": 25,
  "hobbies": ["reading", "coding", "traveling"]
}

要将这个文件读取为字符串，可以使用以下代码：

import java.io.*;

public class ReadJsonFile {

  public static void main(String[] args) {
    // 创建一个 File 对象，表示要读取的文件
    File file = new File("data.json");
    // 创建一个 StringBuilder 对象，用来存储读取到的字符串
    StringBuilder sb = new StringBuilder();
    try {
      // 创建一个 FileReader 对象，用来读取文件的字符流
      FileReader fr = new FileReader(file);
      // 创建一个 BufferedReader 对象，用来缓冲字符流，并提供按行读取的方法
      BufferedReader br = new BufferedReader(fr);
      // 定义一个变量，用来存储每行的内容
      String line;
      // 循环读取每一行，直到文件结束
      while ((line = br.readLine()) != null) {
        // 将每行的内容追加到 StringBuilder 中，并添加换行符
        sb.append(line).append("\n");
      }
      // 关闭 BufferedReader 和 FileReader
      br.close();
      fr.close();
    } catch (IOException e) {
      // 处理异常
      e.printStackTrace();
    }
    // 将 StringBuilder 转换为字符串，并打印输出
    String json = sb.toString();
    System.out.println(json);
  }
}

运行上面的代码，可以得到以下输出：

{
  "name": "Alice",
  "age": 25,
  "hobbies": ["reading", "coding", "traveling"]
}

方法二：使用 java.nio 包中的类

java.nio 包中提供了一些类，如 Path、Files、Charset 等，可以用来处理文件和字符编码。例如，要将上面的 data.json 文件读取为字符串，可以使用以下代码：

import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

public class ReadJsonFile {

  public static void main(String[] args) {
    // 创建一个 Path 对象，表示要读取的文件路径
    Path path = Paths.get("data.json");
    try {
      // 使用 Files 类的 readAllBytes 方法，将文件的所有字节读取到一个 byte 数组中
      byte[] bytes = Files.readAllBytes(path);
      // 使用 Charset 类的 forName 方法，指定字符编码为 UTF-8，并将 byte 数组转换为字符串
      String json = new String(bytes, Charset.forName("UTF-8"));
      // 打印输出字符串
      System.out.println(json);
    } catch (IOException e) {
      // 处理异常
      e.printStackTrace();
    }
  }
}

运行上面的代码，可以得到与方法一相同的输出。

方法三：使用第三方库

除了使用 Java 自带的类，还可以使用一些第三方库来简化 JSON 文件的读取。例如，可以使用 Google 的 Gson 库或者 Jackson 库。这些库不仅可以将 JSON 文件读取为字符串，还可以将 JSON 数据转换为 Java 对象或者反之。下面分别介绍这两个库的用法。

Gson

Gson 是 Google 提供的一个开源库，可以用来将 Java 对象和 JSON 数据相互转换。要使用 Gson，需要先下载并导入 gson.jar 文件到项目中。例如，要将上面的 data.json 文件读取为字符串，可以使用以下代码：

import com.google.gson.Gson;
import com.google.gson.stream.JsonReader;
import java.io.FileReader;
import java.io.IOException;

public class ReadJsonFile {

  public static void main(String[] args) {
    // 创建一个 Gson 对象
    Gson gson = new Gson();
    try {
      // 创建一个 JsonReader 对象，用来读取 JSON 数据流
      JsonReader reader = new JsonReader(new FileReader("data.json"));
      // 使用 Gson 的 fromJson 方法，将 JSON 数据流转换为一个 Java 对象
      // 这里使用 Object 类作为泛型参数，表示任意类型的对象
      Object obj = gson.fromJson(reader, Object.class);
      // 关闭 JsonReader
      reader.close();
      // 使用 Gson 的 toJson 方法，将 Java 对象转换为 JSON 字符串
      String json = gson.toJson(obj);
      // 打印输出字符串
      System.out.println(json);
    } catch (IOException e) {
      // 处理异常
      e.printStackTrace();
    }
  }
}

运行上面的代码，可以得到与方法一相同的输出。

Jackson

Jackson 是另一个流行的开源库，也可以用来将 Java 对象和 JSON 数据相互转换。要使用 Jackson，需要先下载并导入 jackson-core.jar、jackson-annotations.jar 和 jackson-databind.jar 文件到项目中。例如，要将上面的 data.json 文件读取为字符串，可以使用以下代码：

import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.File;
import java.io.IOException;

public class ReadJsonFile {

  public static void main(String[] args) {
    // 创建一个 ObjectMapper 对象
    ObjectMapper mapper = new ObjectMapper();
    try {
      // 使用 ObjectMapper 的 readValue 方法，将文件中的 JSON 数据转换为一个 Java 对象
      // 这里使用 Object 类作为泛型参数，表示任意类型的对象
      Object obj = mapper.readValue(new File("data.json"), Object.class);
      // 使用 ObjectMapper 的 writeValueAsString 方法，将 Java 对象转换为 JSON 字符串
      String json = mapper.writeValueAsString(obj);
      // 打印输出字符串
      System.out.println(json);
    } catch (IOException e) {
      // 处理异常
      e.printStackTrace();
    }
  }
}

运行上面的代码，可以得到与方法一相同的输出。