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

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

2025-06-20 12:10:31作者:廉彬冶Miranda

在开发基于 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 自定义序列化解决方案,完美处理包括循环引用、动态过滤在内的各种复杂场景。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
146
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
965
395
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
513