Как де / сериализовать экземпляр с динамически типизированным атрибутом - PullRequest
1 голос
/ 05 марта 2019

Каков наилучший способ сериализации / десериализации экземпляров MyClass с использованием Jackson?

class MyClass {
    private String name;
    private MyInterface classInstance;

    // standard getters setters
}

Атрибут classInstance может быть произвольного типа, который реализует интерфейс MyInterface

В идеале я бынапример, структура yaml выглядит следующим образом

name: com.example.ClassE
classInstance: 
  value: 42
  category: "fancy"

Обратите внимание, что атрибут "name" на самом деле содержит полностью определенный тип объекта внутри атрибута "classInstance".

1 Ответ

1 голос
/ 06 марта 2019

Проверка JsonTypeInfo аннотация.Он может генерировать class свойство для вас и десериализовать YAML полезную нагрузку, используя это свойство.Проверьте приведенный ниже пример:

import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;

import java.math.BigDecimal;

public class JsonApp {

    public static void main(String[] args) throws Exception {
        YAMLFactory yamlFactory = new YAMLFactory();
        yamlFactory.disable(YAMLGenerator.Feature.USE_NATIVE_TYPE_ID);

        ObjectMapper mapper = new ObjectMapper(yamlFactory);

        serialiseAndDeserialise(mapper, new MyValue());
        serialiseAndDeserialise(mapper, new MyBigDecimal());
    }

    private static void serialiseAndDeserialise(ObjectMapper mapper, MyInterface myInterface) throws java.io.IOException {
        MyClass myClass = new MyClass();
        myClass.setInstance(myInterface);

        String yaml = mapper.writeValueAsString(myClass);
        System.out.println(yaml);
        System.out.println(mapper.readValue(yaml, MyClass.class));
    }
}

class MyClass {

    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "name")
    private MyInterface instance;

    public MyInterface getInstance() {
        return instance;
    }

    public void setInstance(MyInterface instance) {
        this.instance = instance;
    }

    @Override
    public String toString() {
        return "MyClass{" +
                "instance=" + instance +
                '}';
    }
}

interface MyInterface {
}

class MyValue implements MyInterface {
    private int value = 42;
    private String category = "fancy";

    public int getValue() {
        return value;
    }

    public void setValue(int value) {
        this.value = value;
    }

    public String getCategory() {
        return category;
    }

    public void setCategory(String category) {
        this.category = category;
    }

    @Override
    public String toString() {
        return "MyValue{" +
                "value=" + value +
                ", category='" + category + '\'' +
                '}';
    }
}

class MyBigDecimal implements MyInterface {
    private BigDecimal pi = BigDecimal.valueOf(Math.PI);

    public BigDecimal getPi() {
        return pi;
    }

    public void setPi(BigDecimal pi) {
        this.pi = pi;
    }

    @Override
    public String toString() {
        return "MyBigDecimal{" +
                "pi=" + pi +
                '}';
    }
}

Над кодом напечатаны:

---
instance:
  name: "com.celoxity.MyValue"
  value: 42
  category: "fancy"

MyClass{instance=MyValue{value=42, category='fancy'}}
---
instance:
  name: "com.celoxity.MyBigDecimal"
  pi: 3.141592653589793

MyClass{instance=MyBigDecimal{pi=3.141592653589793}}

Если вы хотите переместить name на тот же уровень, что и instance, измените только аннотацию на:

@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.EXTERNAL_PROPERTY, property = "name")

И вывод изменится на:

---
instance:
  value: 42
  category: "fancy"
name: "com.celoxity.MyValue"

MyClass{instance=MyValue{value=42, category='fancy'}}
---
instance:
  pi: 3.141592653589793
name: "com.celoxity.MyBigDecimal"

MyClass{instance=MyBigDecimal{pi=3.141592653589793}}

Я предпочитаю первый, потому что он сообщает, что свойство name принадлежит instance.Если вы удалите свойство name из аннотации, Jackson будет использовать имя по умолчанию для этого вида use - '@class'.

См. Также:

...