Gson超强指南：5分钟掌握JSON转换核心技巧
项目地址: https://gitcode.com/gh_mirrors/gs/gson 你是否还在为Java对象与JSON格式之间的转换而烦恼？面对复杂的嵌套结构、日期格式化、字段命名不一致等问题时束手无策？本文将带你5分钟内掌握Gson的核心使用技巧，轻松解决90%的JSON转换场景需求。读完本文后，你将能够：
- 快速实现Java对象与JSON字符串的相互转换
- 自定义字段命名规则与JSON键名映射
- 处理日期、集合等特殊类型的序列化与反序列化
- 优雅解决复杂对象转换中的常见问题
Gson简介与基础用法
Gson是Google开发的一个Java库，用于将Java对象序列化为JSON字符串，以及将JSON字符串反序列化为Java对象。它支持任意Java对象（包括没有源代码的第三方类）的转换，且无需注解即可工作。
引入Gson库
使用Gson前需要先引入相关依赖。对于Maven项目，在pom.xml中添加以下依赖：
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.13.2</version>
<scope>compile</scope>
</dependency>
基本转换示例
Gson的核心类是Gson，通过它的toJson()和fromJson()方法可以轻松实现对象与JSON的转换。
// 创建Gson实例
Gson gson = new Gson();
// Java对象转JSON
User user = new User("张三", 25);
String json = gson.toJson(user);
// 输出: {"name":"张三","age":25}
// JSON转Java对象
String jsonStr = "{\"name\":\"李四\",\"age\":30}";
User user = gson.fromJson(jsonStr, User.class);
其中User类定义如下：
class User {
private String name;
private int age;
// 构造函数、getter和setter省略
}
Gson默认会序列化/反序列化对象中的所有非transient字段，无需任何注解配置。核心实现类为Gson，详细源码可查看gson/src/main/java/com/google/gson/Gson.java。
自定义字段命名与映射
在实际开发中，Java类的字段名往往与JSON中的键名不一致，这时需要进行自定义映射。
使用@SerializedName注解
通过@SerializedName注解可以指定字段在JSON中的名称，该注解定义在gson/src/main/java/com/google/gson/annotations/SerializedName.java中。
class User {
@SerializedName("user_name")
private String name;
@SerializedName(value = "user_age", alternate = {"age", "u_age"})
private int age;
// 其他代码省略
}
上述代码中：
name字段在JSON中会被命名为user_nameage字段主要使用user_age作为JSON键名，同时也能接受age和u_age作为备选键名（仅在反序列化时有效）
全局字段命名策略
如果需要统一修改所有字段的命名规则，可以使用GsonBuilder设置全局的字段命名策略：
Gson gson = new GsonBuilder()
.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
.create();
Gson提供了多种内置命名策略，定义在gson/src/main/java/com/google/gson/FieldNamingPolicy.java中：
| 命名策略 | 说明 | 示例 |
|---|---|---|
| IDENTITY | 保持字段名不变 | userName → userName |
| UPPER_CAMEL_CASE | 首字母大写 | userName → UserName |
| UPPER_CAMEL_CASE_WITH_SPACES | 首字母大写并添加空格 | userName → User Name |
| LOWER_CASE_WITH_UNDERSCORES | 小写字母并以下划线连接 | userName → user_name |
| LOWER_CASE_WITH_DASHES | 小写字母并以连字符连接 | userName → user-name |
| LOWER_CASE_WITH_DOTS | 小写字母并以点连接 | userName → user.name |
特殊类型处理
日期时间处理
Gson对日期类型的默认处理可能不符合需求，这时可以自定义日期格式：
Gson gson = new GsonBuilder()
.setDateFormat("yyyy-MM-dd HH:mm:ss")
.create();
也可以使用DefaultDateTypeAdapter自定义日期适配器，源码位于gson/src/main/java/com/google/gson/internal/bind/DefaultDateTypeAdapter.java。
集合类型处理
对于List、Map等集合类型，反序列化时需要使用TypeToken来指定泛型类型：
// 反序列化List
String jsonArray = "[{\"name\":\"张三\"},{\"name\":\"李四\"}]";
Type type = new TypeToken<List<User>>(){}.getType();
List<User> userList = gson.fromJson(jsonArray, type);
// 反序列化Map
String jsonMap = "{\"1\":{\"name\":\"张三\"},\"2\":{\"name\":\"李四\"}}";
Type mapType = new TypeToken<Map<String, User>>(){}.getType();
Map<String, User> userMap = gson.fromJson(jsonMap, mapType);
TypeToken的源码位于gson/src/main/java/com/google/gson/reflect/TypeToken.java，它解决了Java泛型类型擦除导致的类型信息丢失问题。
GsonBuilder高级配置
GsonBuilder类提供了丰富的配置选项，可以定制Gson实例的行为。核心源码位于gson/src/main/java/com/google/gson/GsonBuilder.java。
常用配置项
Gson gson = new GsonBuilder()
.setPrettyPrinting() // 格式化输出JSON
.serializeNulls() // 序列化null值
.excludeFieldsWithModifiers(Modifier.STATIC, Modifier.TRANSIENT) // 排除静态和transient字段
.setDateFormat("yyyy-MM-dd") // 设置日期格式
.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES) // 设置字段命名策略
.registerTypeAdapter(Date.class, new CustomDateAdapter()) // 注册自定义类型适配器
.create();
格式化输出示例
使用setPrettyPrinting()可以生成易读的格式化JSON：
Gson gson = new GsonBuilder().setPrettyPrinting().create();
String json = gson.toJson(user);
输出结果：
{
"name": "张三",
"age": 25,
"address": {
"city": "北京",
"street": "朝阳路"
}
}
自定义类型适配器
对于复杂类型或特殊转换需求，可以通过实现JsonSerializer和JsonDeserializer接口来自定义类型适配器：
// 自定义日期适配器
class CustomDateAdapter implements JsonSerializer<Date>, JsonDeserializer<Date> {
private SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
@Override
public JsonElement serialize(Date src, Type typeOfSrc, JsonSerializationContext context) {
return new JsonPrimitive(sdf.format(src));
}
@Override
public Date deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
throws JsonParseException {
return sdf.parse(json.getAsString());
}
}
// 注册适配器
Gson gson = new GsonBuilder()
.registerTypeAdapter(Date.class, new CustomDateAdapter())
.create();
实战技巧与最佳实践
处理循环引用
当对象中存在循环引用时，直接序列化会导致栈溢出异常。可以使用excludeFieldsWithModifiers方法排除引起循环引用的字段，或使用@Expose注解配合excludeFieldsWithoutExposeAnnotation()方法精确控制需要序列化的字段。
class User {
@Expose
private String name;
@Expose(serialize = false, deserialize = true)
private String password;
private transient String token; // transient字段默认不参与序列化
}
Gson gson = new GsonBuilder()
.excludeFieldsWithoutExposeAnnotation()
.create();
版本控制
Gson支持基于版本的序列化控制，使用@Since和@Until注解标记字段在特定版本范围内才参与序列化：
class User {
private String name;
@Since(1.1)
private String email;
@Until(1.0)
private String oldField;
}
Gson gson = new GsonBuilder()
.setVersion(1.1)
.create();
在上述配置下，email字段会被序列化（因为当前版本1.1 >= 1.1），oldField字段不会被序列化（因为当前版本1.1 > 1.0）。
性能优化
Gson的性能在大多数场景下都表现优秀，但在处理大量数据时，可以通过以下方式进一步优化：
- 重用Gson实例：Gson实例是线程安全的，可以全局共享一个实例
- 使用TypeAdapter代替自定义序列化器：TypeAdapter性能更好，尤其对于频繁使用的类型
- 按需序列化：只包含必要的字段，排除不需要的字段
Gson性能测试相关代码可参考gson/src/test/java/com/google/gson/metrics/PerformanceTest.java。
总结与进阶学习
通过本文的介绍，你已经掌握了Gson的核心使用技巧，包括基本转换、字段映射、特殊类型处理和高级配置等内容。Gson的强大之处在于其简洁的API设计和丰富的功能扩展性，能够满足大多数JSON转换场景的需求。
官方文档：UserGuide.md提供了更详细的使用说明。如果你想深入了解Gson的实现原理，可以从以下几个核心类入手：
Gson: 核心API类，负责协调序列化和反序列化过程TypeAdapter: 类型适配器，负责具体类型的转换逻辑GsonBuilder: 构建器类，用于配置Gson实例Excluder: 负责字段排除逻辑
掌握这些核心概念后，你将能够轻松应对各种复杂的JSON转换场景，解决实际开发中遇到的问题。
常见问题解答
Q: Gson与Jackson哪个性能更好？
A: 在大多数场景下，两者性能相近。Gson的API更简洁易用，无需额外注解；Jackson的功能更丰富，性能在某些特定场景下略优。选择时主要考虑项目需求和团队熟悉度。
Q: 如何处理JSON中的多余字段？
A: Gson默认会忽略JSON中不存在于Java类中的字段。如果需要严格检查，可以通过设置setStrictness(Strictness.STRICT)启用严格模式。
Q: 如何序列化匿名内部类或局部类？
A: Gson不支持直接序列化匿名内部类和局部类，建议将其转换为静态嵌套类或独立类。如果必须使用，可以通过注册自定义InstanceCreator来实现。
通过本文介绍的技巧和最佳实践，你已经具备了使用Gson处理各种JSON转换场景的能力。更多高级用法和最新特性，请参考Gson官方文档和源码实现。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
