如何在 Jackson 中忽略未知属性的同时收集所有未识别字段名

大强大大_3097

大强大大_3097

2026-07-22

594人浏览

原创

如何在 Jackson 中忽略未知属性的同时收集所有未识别字段名

本文介绍如何通过自定义 DeserializationProblemHandler,在禁用 FAIL_ON_UNKNOWN_PROPERTIES 的前提下,捕获并记录所有 JSON 中存在的、目标 Java 类未声明的字段名,实现“静默忽略 + 可追溯审计”的反序列化策略。

本文介绍如何通过自定义 `deserializationproblemhandler`,在禁用 `fail_on_unknown_properties` 的前提下,捕获并记录所有 json 中存在的、目标 java 类未声明的字段名,实现“静默忽略 + 可追溯审计”的反序列化策略。

Jackson 默认在遇到未知 JSON 字段时会抛出 UnrecognizedPropertyException(当 FAIL_ON_UNKNOWN_PROPERTIES = true)。虽然可通过 objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) 全局忽略,但这会导致问题“静默丢失”——你无法得知哪些字段被跳过了。为兼顾兼容性与可观测性,推荐使用 DeserializationProblemHandler 机制,在忽略的同时主动收集未知属性名。

核心思路是:继承 DeserializationProblemHandler,重写 handleUnknownProperty 方法,返回 true 表示“已处理,继续反序列化”,并在其中将 propertyName 记录到线程安全的容器(如 ThreadLocal> 或外部日志/监控系统)中。

以下是一个生产就绪的示例实现:

ChatCut
ChatCut

一款AI视频创作工具,主要用于AI视频剪辑工具,适合需要提升相关任务效率的用户。

下载
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.deser.DeserializationProblemHandler;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.DeserializationFeature;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

public class CollectingUnknownPropertyHandler extends DeserializationProblemHandler {
    // 使用线程安全集合,避免并发反序列化时数据污染
    private final List<string> collectedUnknownProperties = new CopyOnWriteArrayList();

    @Override
    public boolean handleUnknownProperty(
            DeserializationContext ctxt,
            JsonParser p,
            JsonDeserializer> deserializer,
            Object beanOrClass,
            String propertyName) throws IOException {

        collectedUnknownProperties.add(propertyName);
        // 返回 true:表示该问题已被处理,反序列化流程继续
        return true;
    }

    public List<string> getCollectedUnknownProperties() {
        return new ArrayList(collectedUnknownProperties);
    }

    public void clear() {
        collectedUnknownProperties.clear();
    }
}</string></string>

使用方式如下:

ObjectMapper mapper = new ObjectMapper();
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
CollectingUnknownPropertyHandler handler = new CollectingUnknownPropertyHandler();
mapper.addHandler(handler);

// 示例 JSON:包含未知字段 "age" 和 "email"
String json = "{\"name\":\"Alice\",\"age\":30,\"email\":\"a@example.com\"}";
User user = mapper.readValue(json, User.class);

// 获取本次反序列化中发现的所有未知字段
List<string> unknowns = handler.getCollectedUnknownProperties();
System.out.println("Unknown properties detected: " + unknowns); 
// 输出:Unknown properties detected: [age, email]

// 注意:如需支持多请求上下文隔离(如 Web 应用),建议结合 ThreadLocal 或 MDC 封装 handler</string>

⚠️ 重要注意事项:

  • DeserializationProblemHandler 是 ObjectMapper 级别单例,不自动线程隔离。若在高并发场景(如 Spring MVC)中复用同一 ObjectMapper 实例,需确保 handler 实例本身是线程安全的(如上例使用 CopyOnWriteArrayList),或为每次请求创建独立 handler。
  • 若需关联具体请求/业务上下文(如 traceId、接口路径),建议将 handler 封装为 ThreadLocal,并在反序列化前后手动管理生命周期。
  • 此机制仅捕获顶层对象及嵌套对象中直接声明的未知字段;若某嵌套类也配置了 FAIL_ON_UNKNOWN_PROPERTIES=false 且注册了 handler,则其未知字段也会被捕获——需确保 handler 被全局注册或显式传递。

总结:通过 DeserializationProblemHandler,你无需修改领域模型或引入额外注解(如 @JsonAnyGetter),即可低成本实现未知字段的“可观测式忽略”。它特别适用于微服务间 JSON 协议演进期的灰度兼容、API 兼容性审计或遗留系统字段治理场景。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10117

6

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

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

2023.07.05

7242

9

java自学难吗
java自学难吗

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

2023.07.31

6372

8

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

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

2023.08.01

1104

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1336

5

java有什么用
java有什么用

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

2023.08.02

2669

5

java在线网站
java在线网站

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

2023.08.03

19991

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1175

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习