讲师中心 微信公众号
AI工具推荐 视频效率加速

Java中 Jackson AnnotationIntrospector 怎么读取自定义注解改变序列化行为

云辰大大_1792

云辰大大_1792

发布时间:2026-07-17 14:28:26

|

470人浏览过

|

来源于php中文网

原创

Jackson 的 AnnotationIntrospector 是控制序列化/反序列化行为的核心扩展点,需继承并重写其方法(如 hasIgnoreMarker、findSerializer)以响应自定义注解,再通过 ObjectMapper 注册实现动态行为。

java中 jackson annotationintrospector 怎么读取自定义注解改变序列化行为

Jackson 的 AnnotationIntrospector 是控制序列化/反序列化行为的核心扩展点之一,它负责“读取”类、字段、方法上的注解,并据此决定如何处理属性(比如是否忽略、重命名、使用何种序列化器等)。要通过自定义注解改变序列化行为,关键不是“直接在 AnnotationIntrospector 里写逻辑”,而是**继承并重写其方法,让 Jackson 在遇到你的注解时返回你期望的元数据(如 name、serializer、visibility 等)**。

定义你的自定义注解

先创建一个运行时保留的注解,比如用于动态控制字段是否序列化:

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ConditionalSerialize {
    String value() default ""; // 可用于传条件表达式或 key
    boolean enabled() default true;
}

这个注解本身不带逻辑,只是标记意图。真正的判断和行为由 AnnotationIntrospector 和后续的序列化器协同完成。

继承 AnnotationIntrospector 实现自定义解析逻辑

你需要继承 AnnotationIntrospector(推荐继承 SimpleAnnotationIntrospector,更轻量),并重写关键方法。最常用的是:

立即学习“Java免费学习笔记(深入)”;

  • findSerializer(Annotated):为字段/属性指定自定义序列化器
  • hasIgnoreMarker(Annotated):告诉 Jackson 是否应忽略该字段(比 @JsonIgnore 更灵活)
  • findNameForSerialization(Annotated):动态改字段名

示例:用 @ConditionalSerialize(enabled = false) 让字段跳过序列化:

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载
public class MyAnnotationIntrospector extends SimpleAnnotationIntrospector {
    @Override
    public Boolean hasIgnoreMarker(AnnotatedMember m) {
        ConditionalSerialize ann = m.getAnnotation(ConditionalSerialize.class);
        if (ann != null && !ann.enabled()) {
            return Boolean.TRUE; // 明确告诉 Jackson 忽略它
        }
        return super.hasIgnoreMarker(m); // 委托给默认逻辑(如 @JsonIgnore)
    }
}

注册自定义 AnnotationIntrospector 到 ObjectMapper

不能只 new 一个实例就完事,必须将其“注入”到 Jackson 的模块链中。推荐方式是通过 SimpleModule 或直接设置:

ObjectMapper mapper = new ObjectMapper();
mapper.setAnnotationIntrospector(new MyAnnotationIntrospector());

// 或更推荐:与模块结合(尤其需要配合自定义 Serializer 时)
SimpleModule module = new SimpleModule();
module.setAnnotationIntrospector(new MyAnnotationIntrospector());
mapper.registerModule(module);

注意:setAnnotationIntrospector 会覆盖默认的(包括 JacksonAnnotationIntrospector),所以如果你仍需支持 @JsonProperty 等原生注解,应在自定义类中调用 super.xxx() 委托处理。

进阶:配合自定义 Serializer 实现动态行为

如果仅靠忽略不够,比如你想根据注解参数(如 value())动态决定输出值(如脱敏、格式化),那就需要:

  • 在 findSerializer() 中返回一个自定义 JsonSerializer
  • 把注解信息(如 ann.value())传入 serializer 构造函数或上下文
  • 在 serialize() 方法里做运行时判断

例如:@ConditionalSerialize(value = "mask") → 输出星号掩码;value = "uppercase" → 转大写。

此时 AnnotationIntrospector 的作用就是“桥梁”:它从注解提取配置,交给 serializer 执行。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

9597

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

6742

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

5972

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1044

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

868

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1276

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2509

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19851

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

40

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn