如何在 Java 中读取 JSON 文件

简介

在现代的软件开发中，JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式被广泛应用。它简洁易读，便于在不同的系统和编程语言之间传输和存储数据。在 Java 开发中，经常需要读取 JSON 文件来获取其中的数据并进行处理。本文将详细介绍在 Java 中读取 JSON 文件的基础概念、使用方法、常见实践以及最佳实践。

目录

1. 基础概念
   • 什么是 JSON
   • JSON 语法结构
2. 使用方法
   • 使用 Jackson 库读取 JSON 文件
   • 使用 Gson 库读取 JSON 文件
   • 使用内置的 JSON 解析器（Java 9+）
3. 常见实践
   • 将 JSON 数据映射到 Java 对象
   • 处理复杂的 JSON 结构
4. 最佳实践
   • 错误处理与异常处理
   • 性能优化
5. 小结
6. 参考资料

基础概念

什么是 JSON

JSON 是一种基于文本的开放标准格式，它以键值对的形式存储数据，常用于数据交换。它源于 JavaScript 语言，但现在被多种编程语言广泛支持。JSON 数据可以表示简单的值（如数字、字符串、布尔值），也可以表示复杂的数据结构，如数组和对象。

JSON 语法结构

• 对象：用花括号 {} 表示，包含一系列键值对。例如：{"name": "John", "age": 30}
• 数组：用方括号 [] 表示，包含有序的值序列。例如：[1, 2, 3, "four"]
• 值：可以是数字、字符串、布尔值（true 或 false）、null、对象或数组。

使用方法

使用 Jackson 库读取 JSON 文件

Jackson 是一个流行的 JSON 处理库，提供了强大的功能来读写 JSON 数据。

1. 添加依赖 如果使用 Maven，在 pom.xml 中添加以下依赖： xml <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.13.3</version> </dependency>

2. 读取 JSON 文件并转换为 Java 对象 ```java import com.fasterxml.jackson.databind.ObjectMapper;

   import java.io.File; import java.io.IOException;

   public class JsonReaderWithJackson { public static void main(String[] args) { ObjectMapper objectMapper = new ObjectMapper(); try { // 假设 JSON 文件名为 example.json File jsonFile = new File("example.json"); // 将 JSON 文件转换为 Java 对象（这里假设 JSON 数据对应一个名为 Person 的类） Person person = objectMapper.readValue(jsonFile, Person.class); System.out.println(person.getName()); } catch (IOException e) { e.printStackTrace(); } } }

   class Person { private String name; private int age;

   // Getters and Setters
   public String getName() {
       return name;
   }
   
   public void setName(String name) {
       this.name = name;
   }
   
   public int getAge() {
       return age;
   }
   
   public void setAge(int age) {
       this.age = age;
   }
   

   } ```

使用 Gson 库读取 JSON 文件

Gson 是 Google 开发的 JSON 处理库，同样非常易于使用。

1. 添加依赖 如果使用 Maven，在 pom.xml 中添加以下依赖： xml <dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.6</version> </dependency>

2. 读取 JSON 文件并转换为 Java 对象 ```java import com.google.gson.Gson;

   import java.io.FileReader; import java.io.IOException; import java.io.Reader;

   public class JsonReaderWithGson { public static void main(String[] args) { Gson gson = new Gson(); try (Reader reader = new FileReader("example.json")) { // 将 JSON 文件转换为 Java 对象（这里假设 JSON 数据对应一个名为 Person 的类） Person person = gson.fromJson(reader, Person.class); System.out.println(person.getName()); } catch (IOException e) { e.printStackTrace(); } } }

   class Person { private String name; private int age;

   // Getters and Setters
   public String getName() {
       return name;
   }
   
   public void setName(String name) {
       this.name = name;
   }
   
   public int getAge() {
       return age;
   }
   
   public void setAge(int age) {
       this.age = age;
   }
   

   } ```

使用内置的 JSON 解析器（Java 9+）

从 Java 9 开始，Java 自带了 JSON 解析器。

1. 读取 JSON 文件并解析 ```java import java.io.IOException; import java.nio.file.Files; import java.nio.file.Paths; import java.util.Map;

   import javax.json.Json; import javax.json.JsonObject; import javax.json.JsonReader;

   public class JsonReaderWithJavaBuiltIn { public static void main(String[] args) { try { String jsonString = Files.readString(Paths.get("example.json")); JsonReader jsonReader = Json.createReader(jsonString); JsonObject jsonObject = jsonReader.readObject(); jsonReader.close();

           System.out.println(jsonObject.getString("name"));
       } catch (IOException e) {
           e.printStackTrace();
       }
   }
   

   } ```

常见实践

将 JSON 数据映射到 Java 对象

通常，我们希望将 JSON 数据映射到 Java 对象，以便更方便地进行操作。上述代码示例中已经展示了如何使用 Jackson 和 Gson 库将 JSON 数据映射到自定义的 Person 类对象。通过定义合适的 Java 类结构，库可以自动将 JSON 数据填充到对象的属性中。

处理复杂的 JSON 结构

对于复杂的 JSON 结构，例如包含嵌套对象和数组的情况，我们需要相应地调整 Java 类结构。例如，如果 JSON 数据如下：

{
    "person": {
        "name": "John",
        "age": 30,
        "hobbies": ["reading", "swimming"]
    }
}

我们可以定义如下的 Java 类：

class Person {
    private String name;
    private int age;
    private String[] hobbies;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String[] getHobbies() {
        return hobbies;
    }

    public void setHobbies(String[] hobbies) {
        this.hobbies = hobbies;
    }
}

然后使用 Jackson 或 Gson 库进行读取和映射。

最佳实践

错误处理与异常处理

在读取 JSON 文件时，可能会遇到各种错误，如文件不存在、JSON 格式错误等。因此，进行适当的错误处理和异常处理非常重要。在上述代码示例中，我们使用 try-catch 块来捕获可能的 IOException。此外，Jackson 和 Gson 库在解析 JSON 数据时也可能抛出特定的异常，我们应该根据具体情况进行处理。

性能优化

对于大型 JSON 文件，性能可能成为一个问题。以下是一些性能优化的建议： - 使用流式解析：Jackson 和 Gson 都支持流式解析，对于大型文件可以减少内存占用。 - 缓存解析结果：如果需要多次读取相同的 JSON 文件，可以考虑缓存解析结果，避免重复解析。

小结

在 Java 中读取 JSON 文件有多种方法，每种方法都有其特点和适用场景。Jackson 和 Gson 库提供了强大且灵活的功能，适用于大多数情况。而 Java 9 及以上版本的内置 JSON 解析器则提供了一种轻量级的解决方案。在实际开发中，我们需要根据项目的需求、性能要求和代码的简洁性来选择合适的方法。同时，注意错误处理和性能优化，以确保程序的稳定性和高效性。

参考资料

• Jackson 官方文档
• Gson 官方文档
• Java JSON 教程