使用Jackson进行复杂类的自定义反序列化

霞舞

发布时间：2025-09-09 19:40:01

390人浏览过

来源于php中文网

原创

使用jackson进行复杂类的自定义反序列化

本文介绍了如何使用Jackson库对复杂的Java类进行自定义反序列化。当默认的反序列化规则无法满足需求，例如需要对特定字段进行特殊处理时，可以使用自定义反序列化器。本文将展示如何利用ObjectMapper和自定义Deserializer来实现将JSON数据直接映射到复杂的类结构中，并提供示例代码进行演示。

在许多情况下，Jackson的ObjectMapper的默认反序列化功能已经足够强大，能够将JSON数据自动映射到复杂的Java类结构中。然而，当我们需要对某些字段进行特殊处理，或者JSON结构与类结构存在差异时，就需要使用自定义的反序列化器。

使用ObjectMapper进行基本反序列化

首先，我们来看一个使用ObjectMapper进行基本反序列化的示例。假设我们有以下两个类：

public class Class1 {
    public String name;
    public int id;

    // Getters and setters (omitted for brevity)
}

public class TestClass {
    public Class1 first;
    public Class2 second;
    // ... other classes

    // Getters and setters (omitted for brevity)
}

public class Class2 {
    public String description;
    public boolean enabled;

    // Getters and setters (omitted for brevity)
}

以及一个对应的JSON字符串：

{
  "first": {
    "name": "Example Name",
    "id": 123
  },
  "second": {
    "description": "Example Description",
    "enabled": true
  }
  // ... other class data
}

我们可以使用ObjectMapper直接将JSON字符串反序列化为TestClass对象：

import com.fasterxml.jackson.databind.ObjectMapper;

public class Main {
    public static void main(String[] args) throws Exception {
        ObjectMapper objectMapper = new ObjectMapper();
        String json = "{\"first\": {\"name\": \"Example Name\", \"id\": 123}, \"second\": {\"description\": \"Example Description\", \"enabled\": true}}";
        TestClass result = objectMapper.readValue(json, TestClass.class);

        System.out.println("Class1 Name: " + result.first.name);
        System.out.println("Class1 ID: " + result.first.id);
        System.out.println("Class2 Description: " + result.second.description);
        System.out.println("Class2 Enabled: " + result.second.enabled);
    }
}

这段代码会自动将JSON数据映射到TestClass及其内部的Class1和Class2对象。

自定义反序列化器

然而，如果我们需要对Class10进行特殊处理，例如从JSON中的特定字段获取数据，或者进行一些转换，我们就需要自定义反序列化器。

Melodrive

Melodrive -一个AI音乐引擎，根据用户的情绪状态和喜好生成个性化的音乐。

下载

首先，我们需要创建一个自定义的反序列化器：

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
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 Class10Deserializer extends StdDeserializer {

    public Class10Deserializer() {
        this(null);
    }

    public Class10Deserializer(Class vc) {
        super(vc);
    }

    @Override
    public Class10 deserialize(JsonParser jp, DeserializationContext ctxt)
      throws IOException, JsonProcessingException {
        JsonNode node = jp.getCodec().readTree(jp);
        //  自定义反序列化逻辑
        Class10 class10 = new Class10();
        class10.setField1(node.get("class10").get("field1").asText());
        // ... 其他字段的处理

        return class10;
    }
}

//假设Class10定义如下
class Class10 {
    private String field1;

    public String getField1() {
        return field1;
    }

    public void setField1(String field1) {
        this.field1 = field1;
    }
}

然后，我们需要将这个自定义的反序列化器注册到ObjectMapper中。为了让Jackson知道在反序列化TestClass时使用这个自定义的反序列化器，我们需要修改TestClass，使用@JsonDeserialize注解：

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

public class TestClass {
    public Class1 first;
    public Class2 second;
    @JsonDeserialize(using = Class10Deserializer.class)
    public Class10 ten;
    // ... other classes

    // Getters and setters (omitted for brevity)
}

现在，当ObjectMapper反序列化TestClass时，它会使用Class10Deserializer来处理ten字段。

完整示例

以下是一个完整的示例，展示了如何使用自定义的反序列化器：

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;

import java.io.IOException;

public class Main {

    public static void main(String[] args) throws Exception {
        ObjectMapper objectMapper = new ObjectMapper();
        String json = "{\"first\": {\"name\": \"Example Name\", \"id\": 123}, \"second\": {\"description\": \"Example Description\", \"enabled\": true}, \"class10\": {\"field1\": \"Value10\"}}";
        TestClass result = objectMapper.readValue(json, TestClass.class);

        System.out.println("Class1 Name: " + result.first.name);
        System.out.println("Class1 ID: " + result.first.id);
        System.out.println("Class2 Description: " + result.second.description);
        System.out.println("Class2 Enabled: " + result.second.enabled);
        System.out.println("Class10 Field1: " + result.ten.getField1());
    }
}

class Class1 {
    public String name;
    public int id;

    // Getters and setters (omitted for brevity)
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }
}

class Class2 {
    public String description;
    public boolean enabled;

    // Getters and setters (omitted for brevity)

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }
}

class Class10 {
    private String field1;

    public String getField1() {
        return field1;
    }

    public void setField1(String field1) {
        this.field1 = field1;
    }
}

class Class10Deserializer extends StdDeserializer {

    public Class10Deserializer() {
        this(null);
    }

    public Class10Deserializer(Class vc) {
        super(vc);
    }

    @Override
    public Class10 deserialize(JsonParser jp, DeserializationContext ctxt)
            throws IOException, JsonProcessingException {
        JsonNode node = jp.getCodec().readTree(jp);
        Class10 class10 = new Class10();
        if(node.has("class10") && node.get("class10").has("field1")) {
            class10.setField1(node.get("class10").get("field1").asText());
        }
        return class10;
    }
}


class TestClass {
    public Class1 first;
    public Class2 second;
    @JsonDeserialize(using = Class10Deserializer.class)
    public Class10 ten;

    public Class1 getFirst() {
        return first;
    }

    public void setFirst(Class1 first) {
        this.first = first;
    }

    public Class2 getSecond() {
        return second;
    }

    public void setSecond(Class2 second) {
        this.second = second;
    }

    public Class10 getTen() {
        return ten;
    }

    public void setTen(Class10 ten) {
        this.ten = ten;
    }
}

注意事项

在自定义反序列化器中，需要处理所有可能的异常情况，例如JSON中缺少字段或字段类型不匹配。
自定义反序列化器应该尽可能地重用ObjectMapper的默认反序列化功能，只处理需要特殊处理的字段。
对于复杂的JSON结构，可以考虑使用JsonNode来遍历JSON树，并根据需要提取数据。

总结

使用Jackson的ObjectMapper和自定义反序列化器，我们可以灵活地将JSON数据映射到复杂的Java类结构中。通过自定义反序列化器，我们可以对特定字段进行特殊处理，满足各种复杂的反序列化需求。记住，在大多数情况下，默认的反序列化功能已经足够强大，只有在需要特殊处理时才需要使用自定义的反序列化器。

在Java里do while循环的特点是什么_Java循环执行机制解析

在Java中如何设置IDE的编译级别_Java编译环境说明

Docker 镜像该用哪个 Java 版本容器化 JDK 选型技巧【实战】

Java初学者项目实战：开发一个基本的网络爬虫应用

在Java中注释有哪几种形式_Java代码注释规范解析