FasterXML/jackson-databind 中集合属性反序列化的注意事项

在使用 FasterXML/jackson-databind 进行 Java 对象序列化和反序列化时，当多个属性方法返回同一个集合对象时，可能会遇到意外的数据重复问题。这种情况需要开发者特别注意，以避免潜在的内存问题和数据不一致。

问题现象

当 Java 类中存在多个 getter 方法返回同一个集合对象时，Jackson 在反序列化过程中会将数据重复添加到集合中。例如：

public class Data {
    private List<Long> idList = new ArrayList<>();
    
    public List<Long> getIdList() {
        return idList;
    }
    
    public List<Long> getMyIdList() {
        return idList; // 返回同一个集合对象
    }
}

当对这个类的实例进行序列化和反序列化时，集合中的元素会出现重复。更严重的是，如果多次重复这个过程，集合会不断膨胀，最终可能导致内存溢出。

问题原因

这个问题的根源在于 Jackson 的默认行为：

1. Jackson 会将所有公共 getter 方法识别为可序列化的属性
2. 默认启用了 MapperFeature.USE_GETTERS_AS_SETTERS 特性，允许通过 getter 方法返回的集合进行反序列化
3. 当多个属性方法返回同一个集合对象时，Jackson 会分别向这个集合添加数据

解决方案

1. 避免多个属性返回同一个集合对象

最直接的解决方案是修改数据模型，确保每个属性方法返回独立的集合对象：

public List<Long> getMyIdList() {
    return new ArrayList<>(idList); // 返回副本而非原集合
}

2. 使用 @JsonIgnore 忽略不需要的属性

如果某些属性仅用于内部逻辑而不需要序列化，可以使用 @JsonIgnore 注解：

@JsonIgnore
public List<Long> getMyIdList() {
    return idList;
}

3. 禁用 USE_GETTERS_AS_SETTERS 特性

可以通过配置禁用相关特性：

ObjectMapper mapper = new ObjectMapper();
mapper.disable(MapperFeature.USE_GETTERS_AS_SETTERS);

需要注意的是，这个特性将在 Jackson 3.0 中默认禁用。

4. 使用 @JsonIdentityInfo 处理对象标识

对于需要保持对象引用的复杂场景，可以使用 @JsonIdentityInfo 注解：

@JsonIdentityInfo(
    generator = ObjectIdGenerators.PropertyGenerator.class,
    property = "id")
public class Data {
    // 类定义
}

最佳实践建议

1. 保持属性独立性：尽量避免多个属性方法返回同一个可变对象引用
2. 明确序列化意图：使用适当的注解明确哪些属性应该被序列化/反序列化
3. 防御性拷贝：对于集合属性，考虑返回副本而非原集合
4. 谨慎使用视图属性：对于根据条件返回不同集合的逻辑属性，确保设计上不会导致数据混乱

总结

Jackson 作为一个强大的序列化框架，提供了灵活的配置选项来处理各种场景。理解其默认行为和工作原理对于避免类似问题至关重要。在设计数据模型时，开发者应当考虑序列化/反序列化的影响，特别是在处理共享引用的集合属性时。通过合理的设计和适当的配置，可以避免数据重复和内存问题，确保应用程序的稳定性和数据一致性。