引言

在现代的软件开发中，处理 JSON 数据是非常常见的任务。而为了简化 JSON 数据的解析和生成过程，我们可以借助一个强大而灵活的 Java 库——Gson。作为一个非常流行的开源 Java 库，它的主要用途是将 Java 对象序列化为 JSON 字符串，或者将 JSON 字符串反序列化为 Java 对象。它提供了简单易用的 API，使得处理 JSON 数据变得轻而易举。本篇博文将详细介绍 Gson 库的特性和使用方法，并通过示例代码展示其在实际场景中的应用。

Gson 经历了多个版本的迭代，目前已经成熟而稳定，处于维护模式。这意味着它会继续修复现有的错误，但可能不会添加大型的新功能。

Gson的特性

  1. 简单易用：Gson 提供了简洁的 API，使得将 Java 对象序列化为 JSON 或将 JSON 反序列化为 Java 对象变得非常简单。
  2. 高度灵活：Gson 支持自定义序列化和反序列化的规则，可以满足各种复杂的数据结构和业务需求（具有深度继承层次结构并广泛使用泛型类型）。
  3. 配置灵活：通过设置不同的配置选项，如日期格式、字段排除策略等，可以灵活地控制 Gson 的行为。
  4. 完善的异常处理：当遇到无法序列化或反序列化的情况时，Gson 会抛出明确的异常信息，方便开发者进行错误处理。
  5. 允许已存在的不可修改对象与 JSON 相互转换；
  6. 广泛支持 Java 泛型。

Gson的使用方法

  1. 导入 Gson 库：在项目中添加 Gson 库的依赖，可以通过 Maven 或 Gradle 等构建工具进行导入。

Maven：

1
2
3
4
5
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.10</version>
</dependency>

gson 版本根据实际情况进行选择，建议使用最新版本（见 Maven Central ）。

  1. 序列化：
    （1）将 Java 对象转换为 JSON 字符串： 
    1
    2
    Gson gson = new Gson();
    String json = gson.toJson(object);

这里的object是要转换的 Java 对象。
（2）使用 Gson 的配置选项：

1
2
3
4
Gson gson = new GsonBuilder()
                .setDateFormat("yyyy-MM-dd")
                .excludeFieldsWithoutExposeAnnotation()
                .create();

通过GsonBuilder可以设置不同的配置选项，例如日期格式化、字段排除策略等。

  1. 反序列化：
    （1）将 JSON 字符串转换为 Java 对象： 
    1
    2
    Gson gson = new Gson();
    MyClass object = gson.fromJson(json, MyClass.class);

这里的MyClass是目标 Java 对象的类。
（2）处理复杂数据结构：
Gson 可以正确地解析包含嵌套对象、集合、泛型等复杂数据结构的 JSON 数据。

Gson用户

Gson 最初是为谷歌内部使用而创建的，并且目前在谷歌的多个项目中被广泛使用。由于其出色的功能和易用性，许多公共项目和公司也选择在它们的项目中使用 Gson。它已经成为 Java 开发社区中最受欢迎和广泛采用的 JSON 处理库之一。Gson 提供了简单而强大的 API，能够轻松地将 Java 对象转换为 JSON 格式，并支持反向操作。同时，它还具备处理复杂对象结构、支持泛型和自定义对象表示等高级功能。这些特点使得 Gson 成为许多开发者首选的 JSON 处理工具。

需要注意的是，尽管 Gson 最初是由谷歌开发和使用的，但目前由一个开源社区维护和支持，并非谷歌官方支持的产品。

Gson性能

以下是在配备双 Opteron 处理器、8GB 内存和 64 位 Ubuntu 操作系统的台式机上进行的一些测试，并得到了如下结果。你也可以使用 Gson 源码中的 PerformanceTest 类重新运行这些测试。

  • 字符串：反序列化超过 25MB 的字符串时没有出现任何问题（请参阅 PerformanceTest 中的 disabled_testStringDeserializationPerformance 方法）。
  • 大型集合：
    • 序列化一个包含 140 万个对象的集合（请参阅 PerformanceTest 中的 disabled_testLargeCollectionSerialization 方法）。
    • 反序列化一个包含 87,000 个对象的集合（请参阅 PerformanceTest 中的disabled_testLargeCollectionDeserialization 方法）。
  • Gson 1.4 将字节数组和集合的反序列化限制从 80KB 提高到 11MB 以上。

注意：要运行这些测试，请删除 disabled_ 前缀。我们使用该前缀是为了防止每次运行 JUnit 测试时都运行这些测试。

Gson开源许可证

Gson 根据 Apache 2.0 许可证发布。

1
2
3
4
5
6
7
8
9
10
11
12
13
Copyright 2008 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

示例应用

现在我们以一个简单的示例来介绍 Gson 在实际场景中的应用。假设我们有一个 Person 类，包含姓名和年龄两个字段。我们希望将 Person 对象序列化为 JSON 字符串，并将其保存到文件中。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
import com.google.gson.Gson;

import java.io.FileWriter;
import java.io.IOException;

public class Person {
    private String name;
    private int age;

    public Person() {
    }

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    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 static void main(String[] args) {
        Person person = new Person("Johnson", 25);

        Gson gson = new Gson();
        String json = gson.toJson(person);

        // 打印：{"name":"Johnson","age":25}
        System.out.println(json);

        // 将JSON字符串保存到文件
        try (FileWriter writer = new FileWriter("person.json")) {
            writer.write(json);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

通过上述代码，我们可以将 Person 对象序列化为 JSON 字符串，并将其保存到名为 person.json 的文件中。

结论

Gson 作为一个强大而灵活的 Java JSON 库，极大地简化了处理 JSON 数据的过程。本文介绍了 Gson 的特性、使用方法以及示例应用，希望能够帮助读者更好地理解和使用 Gson 库。无论是在 Web 开发、移动应用还是其他领域，Gson 都是处理 JSON 数据的绝佳选择。

（END）