gson怎么把list转成json对象

使用Gson将List转换为JSON对象的完整指南

在Java开发中，经常需要将List集合转换为JSON格式的字符串或对象以便于数据传输和存储，Google的Gson库是处理JSON数据的首选工具之一，它提供了简单而强大的API来实现这种转换，本文将详细介绍如何使用Gson将List转换为JSON对象，包括基本用法、自定义配置以及常见问题的解决方案。

Gson基础准备

确保你的项目中已经添加了Gson依赖，如果你使用Maven，可以在pom.xml中添加：

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.9</version>
</dependency>

简单List转JSON

对于简单的List（如List或List）,Gson可以直接转换：

import com.google.gson.Gson;
import java.util.Arrays;
import java.util.List;
public class GsonListToJson {
    public static void main(String[] args) {
        // 创建Gson实例
        Gson gson = new Gson();
        // 创建一个简单的List
        List<String> stringList = Arrays.asList("apple", "banana", "orange");
        // 将List转换为JSON字符串
        String jsonString = gson.toJson(stringList);
        System.out.println(jsonString);
        // 输出: ["apple", "banana", "orange"]
    }
}

复杂对象List转JSON

当List中包含自定义对象时，需要确保这些对象可以被正确序列化,假设我们有以下Person类：

public class Person {
    private String name;
    private int age;
    private String email;
    // 构造方法、getter和setter省略
}

将List转换为JSON的示例：

import com.google.gson.Gson;
import java.util.Arrays;
import java.util.List;
public class GsonObjectListToJson {
    public static void main(String[] args) {
        Gson gson = new Gson();
        // 创建Person对象列表
        List<Person> personList = Arrays.asList(
            new Person("张三", 25, "zhangsan@example.com"),
            new Person("李四", 30, "lisi@example.com")
        );
        // 转换为JSON字符串
        String jsonString = gson.toJson(personList);
        System.out.println(jsonString);
        // 输出: 
        // [
        //   {"name":"张三","age":25,"email":"zhangsan@example.com"},
        //   {"name":"李四","age":30,"email":"lisi@example.com"}
        // ]
    }
}

使用TypeToken处理泛型

当需要将JSON字符串转换回List时，Gson需要知道List的具体类型,这时需要使用TypeToken：

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.List;
public class GsonJsonToList {
    public static void main(String[] args) {
        Gson gson = new Gson();
        String jsonString = "[{\"name\":\"张三\",\"age\":25,\"email\":\"zhangsan@example.com\"},{\"name\":\"李四\",\"age\":30,\"email\":\"lisi@example.com\"}]";
        // 创建TypeToken来指定List的类型
        Type listType = new TypeToken<List<Person>>() {}.getType();
        // 将JSON字符串转换回List
        List<Person> personList = gson.fromJson(jsonString, listType);
        personList.forEach(person -> 
            System.out.println(person.getName() + " - " + person.getAge())
        );
    }
}

Gson配置选项

Gson提供了多种配置选项来控制JSON的生成方式：

Gson gson = new GsonBuilder()
    .setPrettyPrinting() // 美化输出
    .serializeNulls()    // 序列化null值
    .setDateFormat("yyyy-MM-dd") // 设置日期格式
    .create();

处理特殊场景

处理循环引用

如果对象之间存在循环引用，Gson默认会抛出异常,可以使用ExclusionStrategy来处理：

Gson gson = new GsonBuilder()
    .addSerializationExclusionStrategy(new ExclusionStrategy() {
        @Override
        public boolean shouldSkipField(FieldAttributes f) {
            // 跳过某些字段
            return f.getName().equals("循环引用字段");
        }
        @Override
        public boolean shouldSkipClass(Class<?> clazz) {
            return false;
        }
    })
    .create();

自定义序列化

对于特殊类型的对象,可以实现自定义的序列化器：

public class PersonSerializer implements JsonSerializer<Person> {
    @Override
    public JsonElement serialize(Person person, Type type, JsonSerializationContext context) {
        JsonObject jsonObject = new JsonObject();
        jsonObject.addProperty("fullName", person.getName());
        jsonObject.addProperty("years", person.getAge());
        return jsonObject;
    }
}
// 使用自定义序列化器
Gson gson = new GsonBuilder()
    .registerTypeAdapter(Person.class, new PersonSerializer())
    .create();

完整示例

下面是一个完整的示例,展示了从List到JSON再转回List的完整流程：

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.List;
public class CompleteExample {
    public static void main(String[] args) {
        // 1. 创建配置好的Gson实例
        Gson gson = new GsonBuilder()
            .setPrettyPrinting()
            .create();
        // 2. 创建Person列表
        List<Person> personList = Arrays.asList(
            new Person("张三", 25, "zhangsan@example.com"),
            new Person("李四", 30, "lisi@example.com")
        );
        // 3. 将List转换为JSON字符串
        String jsonString = gson.toJson(personList);
        System.out.println("转换后的JSON:");
        System.out.println(jsonString);
        // 4. 将JSON字符串转换回List
        Type listType = new TypeToken<List<Person>>() {}.getType();
        List<Person> convertedList = gson.fromJson(jsonString, listType);
        System.out.println("\n转换回的List:");
        convertedList.forEach(person -> 
            System.out.println(person.getName() + " - " + person.getAge())
        );
    }
}

使用Gson将List转换为JSON对象非常简单,主要步骤如下：