Spring-boot и полиморфизм в свойствах Джексона - PullRequest
0 голосов
/ 06 августа 2020

Мне сложно использовать Spring-boot для создания клиента REST для Synology FileStation API. Действительно, API использует один и тот же атрибут для хранения различных типов объектов. Используемый атрибут - данные , и он может хранить либо sid , либо содержимое результата поиска, например, общие файлы.

Для результата поиска:

{
  "data": {
    "offset": 0,
    "shares": [
      {
        "isdir": true,
        "name": "config",
        "path": "/config"
      },
      ...
    ],
    "total": 19
  },
  "success": true
}

Для результата входа:

{
  "data": {
    "sid": "blablablabla",
  },
  "success": true
}

Для неправильной ошибки входа:

{
  "error": {
    "code": 400,
  },
  "success": false
}

I пытался спроектировать модель для каждого типа ответа, но я не могу найти подходящий способ использовать Джексон для десериализации.

Чтобы упростить, класс, который используется для получения ответа, - Reponse , в ответе есть поле успеха, а также два других поля: Данные и Ошибка . В зависимости от ответа, экземпляр Data может быть либо объектом LoginResponse , либо ListShares .

Вот код моих классов:

@JsonIgnoreProperties(ignoreUnknown = true)
public class Response {
    @JsonProperty("success")
    private boolean success;
    @JsonProperty(value = "data")
    private Data data;
    @JsonProperty(value = "error")
    private Error error;
    ...
}

@JsonIgnoreProperties(ignoreUnknown = true)
public class Error {
    private int code;
    private Collection<ErrorInfo> errors;

    public Error( int code, Collection<ErrorInfo> errors) {
        super();
        this.code = code;
        this.errors = errors;
    }
    ...
}


@JsonTypeInfo(use=JsonTypeInfo.Id.NAME, include=JsonTypeInfo.As.WRAPPER_OBJECT)
@JsonSubTypes({
        @JsonSubTypes.Type(value = LoginResponse.class),
        @JsonSubTypes.Type(value = ListShares.class),
})
public abstract class Data {

}

@JsonTypeName("LoginResponse")
public class LoginResponse extends Data {

    @JsonProperty("sid")
    private String sid;

    public LoginResponse() {
        super();
    }
    ...
}


@JsonTypeName("ListShares")
public class ListShares extends Data {

    @JsonProperty("offset")
    private int offset;
    @JsonProperty("total")
    private int total;
    @JsonProperty("shares")
    private Set<Share> shares;

    public ListShares() {
        super();
    }

    public ListShares(int offset, int total, Set<Share> shares) {
        super();
        this.offset = offset;
        this.total = total;
        this.shares = shares;
    }

Я получаю это исключение:

Caused by: com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id when trying to resolve subtype of [simple type, class com.heavyrage.syno.apis.genericresponses.Response]: missing type id property 'data'
 at [Source: (PushbackInputStream); line: 1, column: 38]
    at com.fasterxml.jackson.databind.exc.InvalidTypeIdException.from(InvalidTypeIdException.java:43) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.DeserializationContext.missingTypeIdException(DeserializationContext.java:1794) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.DeserializationContext.handleMissingTypeId(DeserializationContext.java:1323) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.jsontype.impl.TypeDeserializerBase._handleMissingTypeId(TypeDeserializerBase.java:303) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer._deserializeTypedUsingDefaultImpl(AsPropertyTypeDeserializer.java:166) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer.deserializeTypedFromObject(AsPropertyTypeDeserializer.java:107) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeWithType(BeanDeserializerBase.java:1209) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.deser.impl.TypeWrappedDeserializer.deserialize(TypeWrappedDeserializer.java:68) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4482) ~[jackson-databind-2.11.1.jar:2.11.1]
    at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3487) ~[jackson-databind-2.11.1.jar:2.11.1]
    at org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.readJavaType(AbstractJackson2HttpMessageConverter.java:273) ~[spring-web-5.2.8.RELEASE.jar:5.2.8.RELEASE]
    ... 17 common frames omitted

Кто-нибудь знает, можно ли правильно создать экземпляр объекта Data (создать экземпляр LoginResponse или ListShare) для заполнения свойство "data" объекта Response?

1 Ответ

0 голосов
/ 21 августа 2020

Наконец-то я нашел этот ответ в системе отслеживания проблем Джексона. Ключ - десериализатор, который будет вызываться при создании экземпляра объекта Data, поэтому возвращается правильный класс реализации, и Джексон может его создать.

{ ссылка }

В любом случае, было хорошей идеей использовать композицию для класса Response, поскольку она отражает его отношения HasA как с классами данных, так и с классами ошибок.

Для самого класса Data использование композиции с интерфейсом Java привело к другому исключению, вызванному Джексон пытается создать экземпляр класса интерфейса.

...