Версии: Swagger-codegen (v3): 3.0.11 |Джексон: 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"
, который генерирует два класса:
Notification.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);
}
}
И EmailNotification:
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 передается JSON, соответствующий классу User
, который имеет одно свойство типа 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 - не лучшее решение IMO.