Verwendung der Annotation Jackson @JsonProperty für Kotlin-Datenklassen

kotlin 1.2.10 jackson-modul-kotlin:2.9.0

Ich habe die folgende Datenklasse in Kotlin:

data class CurrencyInfo(
        @JsonProperty("currency_info") var currencyInfo: CurrencyInfoItem?
)

@JsonInclude(JsonInclude.Include.NON_NULL)
data class CurrencyInfoItem(
        @JsonProperty("iso_4217") var iso4217: String?,
        @JsonProperty("name") var name: String?,
        @JsonProperty("name_major") var nameMajor: String?,
        @JsonProperty("name_minor") var nameMinor: String?,
        @JsonProperty("i_ma_currency") var iMaCurrency: Int?,
        @JsonProperty("i_merchant_account") var iMerchantAccount: Int?,
        @JsonProperty("i_x_rate_source") var iXRateSource: Int?,
        @JsonProperty("base_units") var baseUnits: Double?,
        @JsonProperty("min_allowed_payment") var minAllowedPayment: Int?,
        @JsonProperty("decimal_digits") var decimalDigits: Int?,
        @JsonProperty("is_used") var isUsed: Boolean?
)

Wenn ich versuche, diese Datenklasse zu deserialisieren, erhalte ich Folgendes:

{"currency_info":{"iso_4217":"CAD","name":"Canadian Dollar","imerchantAccount":0,"ixrateSource":2}}

Wie Sie sehen können, wurden die letzten beiden Optionen falsch deserialisiert. Dieses Problem könnte gelöst werden, indem Getter @get:JsonProperty direkt eine Anmerkung hinzugefügt wird. Laut Jackson Docs sollte @JsonProperty jedoch Gettern/Settern/Feldern zugewiesen werden

Ich möchte also fragen, ob es eine zuverlässige Möglichkeit gibt, die Eigenschaft für Jackson in Kotlin zu kommentieren, um eine korrekte Serialisierung/Deserialisierung zu haben (außerdem werden alle meine Datenklassen automatisch generiert, sodass es schwierig wäre, einige zwei- oder dreizeilige Anmerkungen separat für Getter zu erstellen und Setzer)

Könnte dieses Problem andernfalls durch einige Jackson-Einstellungen behoben werden?

Gemäß den Antworten unten funktioniert Folgendes für mich

private val mapper = ObjectMapper().registerKotlinModule()
.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY)
.setVisibility(PropertyAccessor.CREATOR, JsonAutoDetect.Visibility.NONE)
.setVisibility(PropertyAccessor.GETTER, JsonAutoDetect.Visibility.NONE)
.setVisibility(PropertyAccessor.SETTER, JsonAutoDetect.Visibility.NONE)
.setVisibility(PropertyAccessor.IS_GETTER, JsonAutoDetect.Visibility.NONE)

@JsonProperty Anmerkungen in Ihrem Code werden alle in private Felder innerhalb Ihrer Datenklasse eingefügt, und standardmäßig scannt Jackson private Felder nicht nach Anmerkungen. Sie müssen es anweisen, etwas anderes zu tun, indem Sie setzen @JsonAutoDetect Anmerkung:

@JsonAutoDetect(fieldVisibility = Visibility.ANY)
data class CurrencyInfo(
    @JsonProperty("currency_info") var currencyInfo: CurrencyInfoItem?
)

Alternativ können Sie Ihre Anmerkungen zu Zugriffsmethoden verschieben:

data class CurrencyInfo(
    @get:JsonProperty("currency_info") var currencyInfo: CurrencyInfoItem?
)

Sie können so etwas tun:

data class CurrencyInfo @JsonCreator constructor (
        @param:JsonProperty("currency_info") 
        @get:JsonProperty("currency_info")
        val currencyInfo: CurrencyInfoItem?
)

Der obige Code wird in Java übersetzt als:

public final class CurrencyInfo {
   @Nullable
   private final String currencyInfo;

   @JsonProperty("currency_info")
   @Nullable
   public final String getCurrencyInfo() {
      return this.currencyInfo;
   }

   @JsonCreator
   public CurrencyInfo(@JsonProperty("currency_info") @Nullable String currencyInfo) {
      this.currencyInfo = currencyInfo;
   }
}

Der Code aus der akzeptierten Antwort wird wie folgt in Java übersetzt:

Erstens (ist nicht rein unveränderlich):

@JsonAutoDetect(
   fieldVisibility = Visibility.ANY
)
public final class CurrencyInfo {
   @Nullable
   private String currencyInfo;

   @Nullable
   public final String getCurrencyInfo() {
      return this.currencyInfo;
   }

   public final void setCurrencyInfo(@Nullable String var1) {
      this.currencyInfo = var1;
   }

   public CurrencyInfo(@JsonProperty("currency_info") @Nullable String currencyInfo) {
      this.currencyInfo = currencyInfo;
   }
}

Zweitens (hat wahrscheinlich Probleme mit der Deserialisierung):

public final class CurrencyInfo {
   @Nullable
   private final String currencyInfo;

   @JsonProperty("currency_info")
   @Nullable
   public final String getCurrencyInfo() {
      return this.currencyInfo;
   }

   public CurrencyInfo(@Nullable String currencyInfo) {
      this.currencyInfo = currencyInfo;
   }
}

Sie können die hinzufügen jackson-module-kotlin (https://github.com/FasterXML/jackson-module-kotlin) und registrieren Sie das Kotlin-Modul bei Jackson:

val mapper = ObjectMapper().registerKotlinModule()

Dann funktioniert es (und vieles andere) automatisch.

Sie können den ObjectMapper aus der Jackson-Bibliothek konfigurieren, indem Sie die Methode aufrufen setPropertyNamingStrategy(...)

Verwenden PropertyNamingStrategy.SNAKE_CASE sollte dein Problem lösen

Siehe auch die anderen verfügbaren Strategien hier: PropertyNamingStrategy

Kotlin unterstützt die Annotationen @param und @get nicht als eine Annotation, also müssen wir diesen Code schreiben:

data class User(
    @param:JsonProperty("id") @get:JsonProperty("id") val id: Int,
    @param:JsonProperty("name") @get:JsonProperty("name") val name: String
)

Hier können Sie JetBrain-Mitarbeitern mitteilen, diese Funktion zu unterstützen und Folgendes zuzulassen:

data class User(
    @JsonProperty("id") val id: Int,
    @JsonProperty("name") val name: String
)

https://youtrack.jetbrains.com/issue/KT-11005

Dieses Problem wurde in behoben

https://github.com/FasterXML/jackson-module-kotlin/issues/237

oder Sie können auch verwenden

data class SignRequest    
    @param:JsonProperty("estamp_request")
    @get:JsonProperty("estamp_request")
    val eStamp: EstampRequest?
}

data class EstampRequest(
    val tags: Map<String,Int>
)

Ich bin heute auf dieses Problem gestoßen und habe KotlinModule() in meinem ObjectMapper() registriert. Faltenbälge folgen einem Beispiel.

@Bean fun objectMapper = ObjectMapper().registreModule(KotlinModule())

Darüber befindet sich ein Dummy-ObjectMapper. Ich glaube, Sie sollten andere Konfigurationen in Ihren ObjectMapper einfügen, z. B. Serializer und so weiter