冠军资讯
CoderPunk在使用 Spring Boot 开发 RESTful API 接口时，JSON 序列化和反序列化是绕不开的环节。 Jackson 作为 Spring Boot 默认的 JSON 处理库，其提供的各种注解极大地简化了开发工作，让我们无需编写大量的样板代码就能轻松实现对象与 JSON 之间的转换。但 Jackson 注解众多，用法灵活，如果理解不透彻，很容易掉入各种坑。本文将深入探讨 Jackson 注解的原理与使用技巧，助你成为 Jackson 高手。
问题场景：复杂对象的序列化与反序列化
想象这样一个场景：我们需要将一个包含复杂嵌套关系的对象序列化成 JSON 字符串，例如一个User对象包含Address对象，Address对象又包含Country对象。 如果使用默认的序列化方式，可能会出现字段命名不规范、忽略特定字段、循环引用等问题，导致生成的 JSON 结构不符合预期，甚至导致程序崩溃。
例如，我们可能遇到以下问题：
- 字段命名不一致: Java 属性使用驼峰命名法，而 JSON 字段可能要求使用下划线命名法。
- 忽略不需要的字段: 某些字段不需要序列化到 JSON 中，例如用户的密码。
- 处理日期格式: 日期类型字段需要按照特定格式进行序列化和反序列化。
- 处理枚举类型: 枚举类型需要序列化成字符串或数字。
- 处理循环引用: 对象之间存在循环引用，导致 StackOverflowError。
Jackson 核心注解详解
下面我们来逐一讲解 Jackson 中常用的核心注解及其用法，包括 @JsonProperty、@JsonIgnore、@JsonFormat、@JsonNaming、@JsonCreator、@JsonValue、@JsonDeserialize 和 @JsonSerialize 等。
1. @JsonProperty：自定义 JSON 字段名称
@JsonProperty 用于指定 Java 属性对应的 JSON 字段名称。这在解决字段命名不一致的问题时非常有用。例如：
public class User {
@JsonProperty("user_name") // 指定 JSON 字段名为 user_name
private String userName;
private String password;
// getter and setter
}
2. @JsonIgnore：忽略特定字段
@JsonIgnore 用于忽略不需要序列化或反序列化的字段。例如，我们不希望将用户的密码序列化到 JSON 中：
public class User {
private String userName;
@JsonIgnore // 忽略 password 字段
private String password;
// getter and setter
}
3. @JsonFormat：格式化日期类型
@JsonFormat 用于指定日期类型字段的格式。例如：
import com.fasterxml.jackson.annotation.JsonFormat;
import java.util.Date;
public class Event {
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date eventDate;
// getter and setter
}
4. @JsonNaming：全局配置命名策略
@JsonNaming 用于指定全局的命名策略，例如将驼峰命名法转换为下划线命名法。 Spring Boot 2.x 默认使用 PropertyNamingStrategies.SNAKE_CASE策略。
import com.fasterxml.jackson.databind.PropertyNamingStrategies;
import com.fasterxml.jackson.databind.annotation.JsonNaming;
@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
public class User {
private String userName;
private String password;
// getter and setter
}
5. @JsonCreator：自定义反序列化构造器
@JsonCreator 用于指定用于反序列化的构造器或工厂方法。这在处理复杂对象或需要自定义反序列化逻辑时非常有用。
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
public class Point {
private final int x;
private final int y;
@JsonCreator
public Point(@JsonProperty("x") int x, @JsonProperty("y") int y) {
this.x = x;
this.y = y;
}
// getter
}
6. @JsonValue：自定义枚举序列化值
@JsonValue 用于指定枚举类型的序列化值。例如，我们可以将枚举值序列化成对应的字符串描述：
import com.fasterxml.jackson.annotation.JsonValue;
public enum Color {
RED("红色"),
GREEN("绿色"),
BLUE("蓝色");
private final String description;
Color(String description) {
this.description = description;
}
@JsonValue
public String getDescription() {
return description;
}
}
7. @JsonSerialize 和 @JsonDeserialize：自定义序列化器和反序列化器
@JsonSerialize 和 @JsonDeserialize 允许完全自定义序列化和反序列化的逻辑。这在处理非常复杂的数据结构或需要特殊处理的字段时非常有用。你需要实现 JsonSerializer 和 JsonDeserializer 接口。
例如，自定义一个序列化器将数字格式化为人民币格式：
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
import java.text.NumberFormat;
import java.util.Locale;
public class CurrencySerializer extends JsonSerializer<Number> {
@Override
public void serialize(Number value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
NumberFormat formatter = NumberFormat.getCurrencyInstance(Locale.CHINA);
gen.writeString(formatter.format(value));
}
}
//使用
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
public class Product {
@JsonSerialize(using = CurrencySerializer.class)
private double price;
// getter and setter
}
实战避坑经验总结
- 版本兼容性: 不同版本的 Jackson 库可能存在差异，需要注意版本兼容性问题。 特别是 Spring Boot 升级时，需要检查 Jackson 依赖版本。
- 循环引用: 使用
@JsonManagedReference和@JsonBackReference注解解决循环引用问题。 或者使用@JsonIdentityInfo注解，但这会增加@id字段。 - 空指针异常: 在反序列化时，如果 JSON 字符串中缺少某些字段，可能会导致空指针异常。可以使用
@JsonInclude(JsonInclude.Include.NON_NULL)注解忽略空值字段。 - 配置优先级：注解配置 > 全局配置 > 默认配置，理解优先级有助于快速定位问题。
- 配合 Spring Boot 配置: Jackson 可以通过
application.properties或application.yml文件进行全局配置，例如日期格式、时区等。
熟练掌握 Jackson 注解能够帮助我们编写更简洁、更高效的代码，避免不必要的 Bug。 记得结合实际场景灵活运用，不断积累经验。 例如，在处理高并发场景时，可以考虑使用对象池来复用 ObjectMapper 实例，提高性能。 此外，还可以结合 Nginx 的反向代理和负载均衡技术，构建高可用、高扩展性的 RESTful API 服务。
