Gson：深入理解与实战应用

Aaron_945

于 2024-08-11 22:11:21 发布

阅读量424

点赞数 3

分类专栏： Java 文章标签：开发语言 java

本文链接：https://blog.csdn.net/Aaron_945/article/details/141113010

版权

Java 专栏收录该内容

20 篇文章 0 订阅

订阅专栏

引言

Gson（Google Gson）是Google开发的一个Java库，用于将Java对象序列化为JSON字符串，以及将JSON字符串反序列化为Java对象。Gson因其简单易用、功能强大、性能优越而广受欢迎，成为Java开发中处理JSON数据的首选库之一。

官网链接

Gson 官网

Gson的原理

Gson的工作原理基于反射（Reflection）和动态代理（Dynamic Proxy，仅在高级功能中涉及，如Gson的TypeAdapter）。当Gson需要将一个Java对象序列化为JSON字符串时，它会遍历对象的所有属性（包括继承的属性），并使用反射机制读取这些属性的值，然后按照JSON格式组装成字符串。反序列化过程则相反，Gson解析JSON字符串，根据JSON的结构和提供的Java类型信息，使用反射机制创建Java对象并设置其属性值。

基础使用

1. 引入依赖

如果你使用Maven，可以在pom.xml文件中添加Gson的依赖：

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.8</version> <!-- 请检查最新版本 -->
</dependency>

2. 序列化

将Java对象转换为JSON字符串。

import com.google.gson.Gson;

public class Example {
    public static void main(String[] args) {
        Person person = new Person();
        person.setName("张三");
        person.setAge(30);

        Gson gson = new Gson();
        String json = gson.toJson(person);
        System.out.println(json);
    }

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

        // 省略getter和setter方法
    }
}

3. 反序列化

将JSON字符串转换为Java对象。

Person person = gson.fromJson(json, Person.class);

高级使用

1. 自定义序列化/反序列化

当Gson的默认序列化/反序列化行为不满足需求时，可以通过实现JsonSerializer和JsonDeserializer接口来自定义序列化/反序列化逻辑。

import com.google.gson.*;

public class CustomSerializerDeserializer {
    // 自定义序列化器
    public static class PersonSerializer implements JsonSerializer<Person> {
        @Override
        public JsonElement serialize(Person src, Type typeOfSrc, JsonSerializationContext context) {
            JsonObject jsonObject = new JsonObject();
            jsonObject.addProperty("name", src.getName());
            jsonObject.addProperty("customAge", "Age: " + src.getAge()); // 自定义格式
            return jsonObject;
        }
    }

    // 自定义反序列化器（略）

    // 使用自定义序列化器
    Gson gson = new GsonBuilder()
            .registerTypeAdapter(Person.class, new PersonSerializer())
            .create();

    // 序列化
    String json = gson.toJson(person);
}

2. 处理复杂类型

Gson能够处理复杂类型，如集合、Map等，但可能需要额外的类型信息来正确地进行反序列化。

Type listType = new TypeToken<List<Person>>(){}.getType();
List<Person> people = gson.fromJson(jsonArray, listType);

3. 排除或包含特定字段

Gson允许通过注解或GsonBuilder的配置来排除或包含特定的字段。

// 使用注解排除字段
@Expose(serialize = false)
private String password;

// 使用GsonBuilder排除/包含带@Expose注解的字段
Gson gson = new GsonBuilder()
    .excludeFieldsWithoutExposeAnnotation()
    .create();

优点

简单易用：Gson的API设计简洁，学习成本低。
功能强大：支持复杂的序列化/反序列化场景，包括自定义序列化器/反序列化器、处理复杂类型等。
性能优越：Gson在处理JSON数据时具有较高的效率。
广泛支持：Gson是Google开发的，得到了广泛的认可和支持，社区活跃。
灵活性：Gson提供了多种配置选项，可以根据不同的需求进行灵活配置。