如何在Spring/Jackson中基于固定JSON自动识别Value接口的具体实现类

问题场景 #

现有Value接口的两个实现类：

• RangeValue：包含min、max两个int类型属性
• FileValue：包含contentType、value两个String类型属性

对应的JSON格式无额外type标识字段：

• RangeValue的JSON：

{
    "min": 200,
    "max": 300
}

• FileValue的JSON：

{
    "contentType": "application/octet-stream",
    "value": "fileValue"
}

需求：请求参数以Value类型接收，不修改现有JSON格式，自动反序列化为对应的具体实现类。此前使用@JsonTypeInfo与@JsonSubTypes需要添加type字段，不符合规范要求。

解决方案：自定义Jackson反序列化器 #

通过自定义JsonDeserializer，根据JSON中的字段特征判断应该实例化哪个实现类，步骤如下：

1. 实现自定义反序列化器 #

创建ValueDeserializer类，继承JsonDeserializer<Value>，重写deserialize方法：

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import java.io.IOException;

public class ValueDeserializer extends StdDeserializer<Value> {

    protected ValueDeserializer() {
        super(Value.class);
    }

    @Override
    public Value deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
        JsonNode node = jsonParser.getCodec().readTree(jsonParser);
        
        // 根据字段特征判断类型：包含min和max则为RangeValue
        if (node.has("min") && node.has("max")) {
            int min = node.get("min").asInt();
            int max = node.get("max").asInt();
            return new RangeValue(min, max);
        } 
        // 包含contentType和value则为FileValue
        else if (node.has("contentType") && node.has("value")) {
            String contentType = node.get("contentType").asText();
            String value = node.get("value").asText();
            return new FileValue(contentType, value);
        }
        // 无法匹配时抛出异常或返回默认值
        throw new IOException("无法识别的Value类型JSON");
    }
}

2. 在Value接口上标注反序列化器 #

在Value接口上添加@JsonDeserialize注解，指定使用自定义的反序列化器：

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

@JsonDeserialize(using = ValueDeserializer.class)
public interface Value {
    // 接口方法（如果有）
}

3. 验证反序列化逻辑 #

使用Jackson的ObjectMapper进行测试：

import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;

public class TestDeserialization {
    public static void main(String[] args) throws IOException {
        ObjectMapper mapper = new ObjectMapper();
        
        // 测试RangeValue反序列化
        String rangeJson = "{\"min\":200,\"max\":300}";
        Value rangeValue = mapper.readValue(rangeJson, Value.class);
        System.out.println(rangeValue.getClass().getSimpleName()); // 输出：RangeValue
        
        // 测试FileValue反序列化
        String fileJson = "{\"contentType\":\"application/octet-stream\",\"value\":\"fileValue\"}";
        Value fileValue = mapper.readValue(fileJson, Value.class);
        System.out.println(fileValue.getClass().getSimpleName()); // 输出：FileValue
    }
}

注意事项 #

• 确保各实现类的字段特征唯一，避免出现字段重叠导致的判断错误
• 如果后续新增Value的实现类，只需在ValueDeserializer的deserialize方法中添加对应的字段判断逻辑即可
• 若JSON格式存在字段缺失的情况，可根据业务需求添加默认值处理或异常捕获逻辑

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