Jackson Databind 自定义序列化器中的注解信息获取实践

在开发基于 Jackson Databind 的 JSON 序列化功能时，开发者经常会遇到需要自定义序列化逻辑的场景。本文将通过一个典型案例，深入探讨如何在自定义序列化器中正确处理注解信息，特别是处理循环引用和动态属性过滤的情况。

核心问题场景

考虑一个典型的父子对象循环引用场景：

data class Parent(
  val name: String,
  @JsonIgnoreProperties("parent") 
  val child: Child
)

data class Child(
  val name: String,
  val parent: Parent
)

当我们需要自定义 Child 类的序列化器时，关键挑战在于：

1. 当 Child 作为 Parent 的属性被序列化时，需要忽略 parent 属性
2. 当直接序列化 Child 对象时，则需要包含 parent 属性

技术实现方案

ContextualSerializer 接口的应用

Jackson 设计上要求所有注解访问必须在序列化器构造阶段完成，而不是在运行时。这通过 ContextualSerializer 接口实现：

class ChildSerializer(private val ignoreParent: Boolean = false) : 
    StdSerializer<Child>(Child::class.java),
    ContextualSerializer {
    
    override fun serialize(obj: Child, gen: JsonGenerator, provider: SerializerProvider) {
        gen.writeStartObject()
        gen.writeStringField("name", obj.name)
        if (!ignoreParent) {
            gen.writeObjectField("parent", obj.parent)
        }
        gen.writeEndObject()
    }

    override fun createContextual(prov: SerializerProvider, 
                                property: BeanProperty?): JsonSerializer<*> {
        val ignore = property?.getAnnotation(JsonIgnoreProperties::class.java)
            ?.value?.contains("parent") ?: false
        return ChildSerializer(ignore)
    }
}

BeanSerializerModifier 的高级用法

对于更复杂的场景，如处理 ORM 框架中的延迟加载集合，可以结合 BeanSerializerModifier：

class SerializerModifier : BeanSerializerModifier() {
    override fun modifySerializer(
        config: SerializationConfig,
        beanDesc: BeanDescription,
        serializer: JsonSerializer<*>
    ): JsonSerializer<*> {
        if (isEntityClass(beanDesc.beanClass)) {
            return EntitySerializer(serializer as JsonSerializer<Any>)
        }
        return serializer
    }
}

class EntitySerializer(
    private val delegate: JsonSerializer<Any>,
    private val ignoredProps: Set<String> = emptySet()
) : StdSerializer<Entity<*>>(Entity::class.java), ContextualSerializer {
    
    override fun createContextual(prov: SerializerProvider, 
                               property: BeanProperty?): JsonSerializer<*> {
        val ignored = property?.getAnnotation(JsonIgnoreProperties::class.java)
            ?.value?.toSet() ?: emptySet()
        return EntitySerializer(delegate, ignored)
    }

    override fun serialize(value: Entity<*>, gen: JsonGenerator, 
                         provider: SerializerProvider) {
        // 实现自定义序列化逻辑
    }
}

性能优化建议

1. 预计算注解信息：在 createContextual 阶段解析所有需要的注解信息，避免运行时重复解析

2. 合理使用 PropertySerializerMap：对于动态解析的序列化器，考虑使用 Jackson 内置的缓存机制

3. 异常处理优化：对于 ORM 延迟加载场景，建议在实体类层面添加状态检查方法，而非依赖异常捕获

最佳实践总结

1. 始终通过 ContextualSerializer 接口访问注解信息
2. 复杂场景考虑结合 BeanSerializerModifier 实现全局控制
3. 性能敏感场景避免在 serialize() 方法中动态解析序列化器
4. 对于 ORM 集成，优先考虑框架层面的解决方案而非纯序列化器方案

通过合理应用这些模式，开发者可以构建出既灵活又高效的 Jackson 自定义序列化解决方案，完美处理包括循环引用、动态过滤在内的各种复杂场景。