java - 生成的子类结果反序列化到父对象中

Question

版本:Swagger-codegen (v3):3.0.11 | jackson :2.9.8

我目前从 swagger.yaml 文件生成我的类(由于双重复制粘贴，缩进可能会有所不同):

---
swagger: "2.0"
info:
  description: "servicename"
  version: "1.0"
  title: "servicename"
schemes:
  - "http"
  - "https"
paths:

definitions:
  Notification:
    type: "object"
    discriminator: "typeOfNotification"
    properties:
      typeOfNotification:
        description: "Type of notification"
        enum:
          - "EMAIL"
          - "SMS"
        default: "EMAIL"
  EmailNotification:
    allOf:
    - $ref: "#/definitions/Notification"
    - type: "object"
      properties:
        name:
          type: "string"
          example: "Name of reciever"
          description: "Name of the receiver"
        emailAddress:
          type: "string"
          example: "info@stackoverflow.com"
          description: "Email address of the receiver"

生成两个类:

通知.java

package nl.test;

import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.v3.oas.annotations.media.Schema;
import java.io.IOException;
/**
 * Notification
 */

@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2019-09-26T16:01:12.401+02:00[Europe/Amsterdam]")
public abstract class Notification {
  /**
   * Type of notification
   */
  @JsonAdapter(TypeOfNotificationEnum.Adapter.class)
  public enum TypeOfNotificationEnum {
    EMAIL("EMAIL"),
    SMS("SMS");

    private String value;

    TypeOfNotificationEnum(String value) {
      this.value = value;
    }
    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }
    public static TypeOfNotificationEnum fromValue(String text) {
      for (TypeOfNotificationEnum b : TypeOfNotificationEnum.values()) {
        if (String.valueOf(b.value).equals(text)) {
          return b;
        }
      }
      return null;
    }
    public static class Adapter extends TypeAdapter<TypeOfNotificationEnum> {
      @Override
      public void write(final JsonWriter jsonWriter, final TypeOfNotificationEnum enumeration) throws IOException {
        jsonWriter.value(enumeration.getValue());
      }

      @Override
      public TypeOfNotificationEnum read(final JsonReader jsonReader) throws IOException {
        String value = jsonReader.nextString();
        return TypeOfNotificationEnum.fromValue(String.valueOf(value));
      }
    }
  }  @SerializedName("typeOfNotification")
  private TypeOfNotificationEnum typeOfNotification = null;

  public Notification typeOfNotification(TypeOfNotificationEnum typeOfNotification) {
    this.typeOfNotification = typeOfNotification;
    return this;
  }


  @Schema(description = "Type of notification")
  public TypeOfNotificationEnum getTypeOfNotification() {
    return typeOfNotification;
  }

  public void setTypeOfNotification(TypeOfNotificationEnum typeOfNotification) {
    this.typeOfNotification = typeOfNotification;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Notification notification = (Notification) o;
    return Objects.equals(this.typeOfNotification, notification.typeOfNotification);
  }

  @Override
  public int hashCode() {
    return Objects.hash(typeOfNotification);
  }
}

以及电子邮件通知:

package nl.test;

import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.v3.oas.annotations.media.Schema;
import java.io.IOException;
import nl.test.Notification;
/**
 * EmailNotification
 */

@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2019-09-26T16:01:12.401+02:00[Europe/Amsterdam]")
public class EmailNotification extends Notification {
  @SerializedName("name")
  private String name = null;

  @SerializedName("emailAddress")
  private String emailAddress = null;

  public EmailNotification name(String name) {
    this.name = name;
    return this;
  }

   /**
   * Name of the receiver
   * @return name
  **/
  @Schema(example = "Name of receiver", description = "Name of the receiver")
  public String getName() {
    return name;
  }

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

  public EmailNotification emailAddress(String emailAddress) {
    this.emailAddress = emailAddress;
    return this;
  }

   /**
   * Email address of the receiver
   * @return emailAddress
  **/
  @Schema(example = "test@stackoverflow.com", description = "Email address of the receiver")
  public String getEmailAddress() {
    return emailAddress;
  }

  public void setEmailAddress(String emailAddress) {
    this.emailAddress = emailAddress;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
     EmailNotification = (EmailNotification) o;
    return Objects.equals(this.name, emailNotification.name) &&
        Objects.equals(this.emailAddress, emailNotification.emailAddress) &&
        super.equals(o);
  }

  @Override
  public int hashCode() {
    return Objects.hash(name, emailAddress, super.hashCode());
  }

}

这很好。但是现在在JSON的反序列化过程中出现了问题。当向 ObjectMapper 传递与 User 类对应的 JSON 时，该类具有一个 Notification 类型的属性，并且该 JSON 实际上是 EmailNotification 类型，然后由于某种原因，反序列化器不关心并将其反序列化为 Notification，从而忽略 emailAddress 属性。

对应的测试类:

package nl.test;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.junit.MockitoJUnitRunner;
import org.threeten.bp.LocalDate;

import static com.fasterxml.jackson.databind.MapperFeature.ACCEPT_CASE_INSENSITIVE_ENUMS;
import static org.junit.Assert.*;


@RunWith(MockitoJUnitRunner.class)
public class ObjectMappersConfigurationTest {

    @Test
    public void test() throws Exception {
        String json = "{\n" +
                "  \"user\": {\n" +
                "    \"notification\": {\n" +
                "      \"name\": \"somename\",\n" +
                "      \"emailAddress\": \"test@stackoverflow.com\",\n" +
                "      \"typeOfNotification\": \"EMAIL\"\n" +
                "    },\n" +
                "  }\n" +
                "}\n";

        ObjectMapper mapper = createJsonObjectMapper();
        User order = mapper.readValue(json, User.class);

        assertEquals(1, 1);
    }

    public ObjectMapper createJsonObjectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        setDefaultRelaxObjectMappings(objectMapper);
        return objectMapper;
    }

    public static void setDefaultRelaxObjectMappings(ObjectMapper objectMapper) {
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        objectMapper.configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, false);

        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        objectMapper.enable(ACCEPT_CASE_INSENSITIVE_ENUMS);
    }
}

输出将是:

User {
  notification {
     notificationType: EMAIL
  }
}

我期望的地方:

User {
  notification {
     notificationType: EMAIL,
     emailAddress: "...",
     name: "..."
  }
}

现在我知道我可以使用自定义反序列化器来实现此目的，但这似乎有点矫枉过正，我认为通过继承反序列化对象应该是一个简单的设置。我只是似乎找不到它。

启用默认类型是一种替代方案，但我宁愿避免这样做，因为我们的 YAML 文件来自外部方，在我看来，强制他们默认类型的 YAML 并不是最好的解决方案。

Answer 1

事实证明，@JsonSubType 注释丢失了。由于 ObjectMapper 不与 swagger 通信，因此它永远不知道该类应该映射到 EmailNotification ，因此总是会创建一个 Notification 对象。

添加:

<plugin>
   ....
   <configuration>
     ...
     <library>jersey2</library>
   </configuration>
</plugin>

修复了这个问题，Notification 类的类注释现在生成为:

@JsonSubTypes({
  @JsonSubTypes.Type(value = SMSNotification.class, name = "SMSNotification"),
  @JsonSubTypes.Type(value = EmailNotification.class, name = "EmailNotification"),
})
public class Notification {
    ....

这会添加 ObjectMapper 在反序列化时可以理解的映射。

特别感谢您提供的答案在这里swagger-codegen client: How to include jackson annotations on models