Jackson反序列化：忽略缺失字段并捕获未映射字段的实现方案

前提配置：关闭未知字段报错 #

先确保ObjectMapper不会因API新增字段抛出异常，配置如下：

ObjectMapper objectMapper = new ObjectMapper();
// 关闭未知字段触发异常的规则
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

方案一：类级别捕获（@JsonAnySetter注解） #

如果仅针对特定API响应类处理未映射字段，直接在实体类中添加@JsonAnySetter注解方法，配合Map存储未知字段并记录日志：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import java.util.HashMap;
import java.util.Map;

public class ApiResponse {
    // 已映射的业务字段
    private String userId;
    private String userName;
    
    // 存储未映射字段的容器
    private final Map<String, Object> unknownFields = new HashMap<>();
    private static final Logger logger = LoggerFactory.getLogger(ApiResponse.class);

    // Jackson遇到未映射字段时自动调用该方法
    @JsonAnySetter
    public void captureUnknownField(String fieldName, Object fieldValue) {
        unknownFields.put(fieldName, fieldValue);
        // 实时记录日志，也可在反序列化完成后统一处理
        logger.warn("捕获到未映射的API字段: [字段名: {}, 值: {}]", fieldName, fieldValue);
    }

    // 可选：提供getter用于后续统计或上报
    public Map<String, Object> getUnknownFields() {
        return unknownFields;
    }

    // 已知字段的getter/setter省略
}

反序列化后，未映射字段会自动存入unknownFields并打印日志，方便后续和API提供者沟通。

方案二：全局捕获（BeanDeserializerModifier） #

如果需要对所有反序列化的类统一处理未映射字段，可通过自定义BeanDeserializerModifier实现全局监听：

1. 自定义反序列化器修改器

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.BeanDescription;
import com.fasterxml.jackson.databind.DeserializationConfig;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.deser.BeanDeserializer;
import com.fasterxml.jackson.databind.deser.BeanDeserializerModifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;

public class GlobalUnknownFieldLogger extends BeanDeserializerModifier {
    private static final Logger logger = LoggerFactory.getLogger(GlobalUnknownFieldLogger.class);

    @Override
    public JsonDeserializer<?> modifyDeserializer(DeserializationConfig config, BeanDescription beanDesc, JsonDeserializer<?> deserializer) {
        // 仅对Bean类型的反序列化器做修改
        if (deserializer instanceof BeanDeserializer) {
            return new BeanDeserializer((BeanDeserializer) deserializer) {
                @Override
                public Object deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
                    // 先完成正常反序列化流程
                    Object targetBean = super.deserialize(p, ctxt);
                    // 读取剩余未处理的JSON节点（即未映射字段）
                    JsonNode remainingNodes = p.readValueAsTree();
                    if (remainingNodes != null && remainingNodes.size() > 0) {
                        logger.warn("类[{}]捕获到未映射的API字段: {}", beanDesc.getBeanClass().getName(), remainingNodes.toString());
                    }
                    return targetBean;
                }
            };
        }
        return deserializer;
    }
}

2. 配置到ObjectMapper

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 注册自定义模块，启用全局未映射字段监听
objectMapper.registerModule(new SimpleModule().setDeserializerModifier(new GlobalUnknownFieldLogger()));

所有通过该ObjectMapper反序列化的类，只要存在未映射字段，都会自动记录日志。

注意事项 #

• 方案一适合单个类的精细化处理，可在反序列化后主动获取unknownFields做统计；方案二适合全局统一管控，无需逐个修改实体类。
• 嵌套JSON结构中，方案一需要在每个嵌套实体类单独添加@JsonAnySetter；方案二会自动处理所有嵌套类（只要用同一个ObjectMapper反序列化）。
• 日志级别建议用WARN，既不会淹没正常日志，又能及时发现API字段变更。

内容的提问来源于stack exchange，提问作者maverickabhi