在Java开发中，Jackson是最常用的JSON处理库之一，它提供了丰富的功能来处理JSON的序列化与反序列化。当我们遇到JSON结构无法直接匹配目标显式类，且无法修改目标类源码的场景时，Jackson Mixin是一个非常实用的解决方案。
什么是Jackson Mixin
Jackson Mixin是一种注解混合机制，它允许我们创建一个单独的Mixin类，在这个类中为目标类添加Jackson相关的注解，而不需要直接修改目标类的源码。Jackson在序列化或反序列化目标类时，会自动读取Mixin类中的注解配置，按照Mixin类定义的规则来处理目标类的实例。
这种方式特别适合处理第三方库中的类、没有源码的类，或者我们不希望直接修改源码的类，避免了为了适配JSON结构而修改原有类的风险。
常见的反序列化场景问题
我们先来看一个常见的需要反序列化的显式类场景，假设我们有一个用户类User，这个类来自第三方库，我们无法修改它的源码：
// 目标显式类，无法修改源码
public class User {
private String userName;
private Integer userAge;
// 只有有参构造器，没有无参构造器
public User(String userName, Integer userAge) {
this.userName = userName;
this.userAge = userAge;
}
// getter和setter方法
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public Integer getUserAge() {
return userAge;
}
public void setUserAge(Integer userAge) {
this.userAge = userAge;
}
}
现在我们有一个JSON字符串，它的字段名是name和age，和目标类的userName、userAge不匹配，同时目标类没有无参构造器，直接使用Jackson反序列化会失败：
import com.fasterxml.jackson.databind.ObjectMapper;
public class Test {
public static void main(String[] args) throws Exception {
String json = "{"name":"张三","age":20}";
ObjectMapper objectMapper = new ObjectMapper();
// 直接反序列化会报错，因为User没有无参构造器，且字段名不匹配
User user = objectMapper.readValue(json, User.class);
}
}
使用Mixin解决反序列化问题
步骤1：创建Mixin类
我们创建一个Mixin类，为目标User类添加所需的注解，解决构造器和字段名匹配的问题：
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
// Mixin类，不需要实现或继承目标类
public abstract class UserMixin {
// 标记构造器，解决无参构造器缺失的问题，同时映射JSON字段到构造器参数
@JsonCreator
public UserMixin(
@JsonProperty("name") String userName,
@JsonProperty("age") Integer userAge
) {
// Mixin类的构造器不需要实际实现，只是用来承载注解
}
// 也可以在这里添加字段级别的注解，不过构造器注解已经可以处理字段映射
}
步骤2：注册Mixin到ObjectMapper
接下来我们需要将Mixin类和目标类关联起来，通过ObjectMapper的addMixIn方法完成注册：
import com.fasterxml.jackson.databind.ObjectMapper;
public class Test {
public static void main(String[] args) throws Exception {
String json = "{"name":"张三","age":20}";
ObjectMapper objectMapper = new ObjectMapper();
// 将User类和UserMixin类关联
objectMapper.addMixIn(User.class, UserMixin.class);
// 此时反序列化可以正常执行
User user = objectMapper.readValue(json, User.class);
System.out.println("用户名：" + user.getUserName());
System.out.println("年龄：" + user.getUserAge());
}
}
运行上述代码，输出结果如下：
用户名：张三 年龄：20
Mixin的其他常用场景
忽略不需要的字段
如果JSON中有目标类不存在的字段，或者我们不想反序列化某些字段，可以在Mixin类中使用@JsonIgnoreProperties注解：
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@JsonIgnoreProperties(ignoreUnknown = true)
public abstract class UserMixin {
// 其他注解配置
}
字段格式转换
如果JSON中的日期字段是字符串格式，而目标类的日期字段是Date类型，可以在Mixin类中添加日期格式注解：
import com.fasterxml.jackson.annotation.JsonFormat;
import java.util.Date;
public abstract class UserMixin {
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
private Date birthday; // 假设User类有birthday字段
}
注意事项
- Mixin类通常是抽象类，不需要实例化，也不需要继承或实现目标类。
- Mixin类中的注解会覆盖目标类中已有的同类型注解，如果目标类本身有Jackson注解，需要注意优先级问题。
- 一个目标类可以关联多个Mixin类吗？不可以，一个目标类只能关联一个Mixin类，如果有多个配置需求，需要整合到一个Mixin类中。
- Mixin类的作用范围是针对注册了它的
ObjectMapper实例，不同的ObjectMapper实例可以注册不同的Mixin配置。