{"id":162,"date":"2024-01-11T23:56:39","date_gmt":"2024-01-11T22:56:39","guid":{"rendered":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=162"},"modified":"2024-01-24T00:17:41","modified_gmt":"2024-01-23T23:17:41","slug":"uebersicht-ueber-jackson-annotations-zur-serialisierung-von-java-objekten-in-json","status":"publish","type":"post","link":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=162","title":{"rendered":"\u00dcbersicht \u00fcber Jackson-Annotations zur Serialisierung von Java-Objekten in JSON"},"content":{"rendered":"\n

Die Jackson-Bibliothek stellt eine herausragende Ressource f\u00fcr die Verarbeitung von JSON-Daten in Java-Anwendungen dar. Insbesondere bietet sie eine Vielzahl von Annotationsm\u00f6glichkeiten, um den Serialisierungs- und Deserialisierungsprozess von Java-Objekten in JSON zu beeinflussen. Dieser Artikel gibt einen tiefen Einblick in die verschiedenen Jackson-Annotations.<\/p>\n\n\n\n

Einleitung zu Jackson und JSON<\/h2>\n\n\n\n

JSON (JavaScript Object Notation) hat sich als leichtgewichtiges Datenaustauschformat etabliert, das sowohl von Menschen einfach gelesen als auch von Maschinen effizient verarbeitet werden kann. Jackson, als eine leistungsstarke Java-Bibliothek, erm\u00f6glicht die nahtlose Umwandlung von Java-Objekten in JSON und umgekehrt. Neben der hohen Performance bietet Jackson eine breite Palette von Annotations, die Entwicklern die feingranulare Steuerung des Serialisierungs- und Deserialisierungsprozesses erm\u00f6glichen.<\/p>\n\n\n\n

@JsonAutoDetect<\/h2>\n\n\n\n

Die @JsonAutoDetect<\/code>-Annotation erm\u00f6glicht die Kontrolle dar\u00fcber, welche Felder oder Methoden w\u00e4hrend der Serialisierung und Deserialisierung sichtbar sind. Die Standardeinstellung sieht vor, dass alle \u00f6ffentlichen Felder und Methoden sichtbar sind. Mithilfe von @JsonAutoDetect<\/code> k\u00f6nnen Entwickler diese Konfiguration anpassen.<\/p>\n\n\n

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY)\npublic<\/span> class<\/span> MyClass<\/span> <\/span>{\n    private<\/span> String privateField;\n    public<\/span> String publicField;\n    \/\/ getters and setters<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
In diesem Beispiel werden durch die Verwendung von @JsonAutoDetect<\/code> auch private Felder sichtbar gemacht.<\/p>\n\n\n\n
@JsonProperty<\/h2>\n\n\n\n
Die @JsonProperty<\/code>-Annotation erm\u00f6glicht die Festlegung des Namens eines JSON-Felds, das mit einem Java-Feld oder einer Methode verkn\u00fcpft ist.<\/p>\n\n\n
public<\/span> class<\/span> Person<\/span> <\/span>{\n    @JsonProperty(\"fullName\"<\/span>)\n    private<\/span> String name;\n    \/\/ getter and setter<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Hier wird das Java-Feld name<\/code> im generierten JSON als fullName<\/code> repr\u00e4sentiert.<\/p>\n\n\n\n
@JsonIgnore<\/h2>\n\n\n\n
Die @JsonIgnore<\/code>-Annotation dient dazu, Felder oder Methoden zu markieren, die bei der Serialisierung und Deserialisierung ignoriert werden sollen.<\/p>\n\n\n
public<\/span> class<\/span> Employee<\/span> <\/span>{\n    private<\/span> String name;\n    @JsonIgnore\n    private<\/span> String password;\n    \/\/ getters and setters<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
In diesem Beispiel wird das Feld password<\/code> w\u00e4hrend der JSON-Verarbeitung ignoriert.<\/p>\n\n\n\n
@JsonFormat<\/h2>\n\n\n\n
Die @JsonFormat<\/code>-Annotation erm\u00f6glicht die Kontrolle \u00fcber das Format von Datum und Zeit w\u00e4hrend der Serialisierung und Deserialisierung.<\/p>\n\n\n
public<\/span> class<\/span> Event<\/span> <\/span>{\n    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = \"dd-MM-yyyy hh:mm:ss\"<\/span>)\n    private<\/span> Date eventDate;\n    \/\/ getter and setter<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Hier wird das Datumsformat f\u00fcr das Feld eventDate<\/code> auf „dd-MM-yyyy hh:mm:ss“ festgelegt.<\/p>\n\n\n\n
@JsonInclude<\/h2>\n\n\n\n
Die @JsonInclude<\/code>-Annotation wird verwendet, um zu steuern, welche Felder bei der Serialisierung in das JSON-Dokument einbezogen werden sollen und welche nicht.<\/p>\n\n\n
@JsonInclude(JsonInclude.Include<\/span>.NON_NULL)\npublic<\/span> class<\/span> Person<\/span> <\/span>{\n    private<\/span> String name;\n    private<\/span> Integer age;\n    \/\/ getters and setters<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
In diesem Beispiel werden nur nicht-null-Felder in das JSON-Dokument aufgenommen.<\/p>\n\n\n\n
@JsonGetter und @JsonSetter<\/h2>\n\n\n\n
Die @JsonGetter<\/code>– und @JsonSetter<\/code>-Annotationen erm\u00f6glichen die Definition individueller Methoden f\u00fcr das Abrufen und Setzen von Werten w\u00e4hrend der Serialisierung und Deserialisierung.<\/p>\n\n\n
public class<\/span> Person<\/span> <\/span>{\n    private String<\/span> fullName;\n\n    @JsonGetter(\"name\"<\/span>)\n    public String<\/span> getFullName() {\n        return<\/span> fullName;\n    }\n\n    @JsonSetter(\"name\"<\/span>)\n    public void<\/span> setFullName(String<\/span> fullName) {\n        this<\/span>.fullName = fullName;\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Durch die Verwendung dieser Annotations k\u00f6nnen benutzerdefinierte Methoden f\u00fcr das Abrufen und Setzen des Namens festgelegt werden.<\/p>\n\n\n\n
@JsonAlias<\/h2>\n\n\n\n
Die @JsonAlias<\/code>-Annotation erm\u00f6glicht die Definition alternativer Namen f\u00fcr ein Feld, um R\u00fcckw\u00e4rtskompatibilit\u00e4t sicherzustellen.<\/p>\n\n\n
public<\/span> class<\/span> User<\/span> <\/span>{\n    @JsonAlias({\"username\"<\/span>, \"user_name\"<\/span>})\n    private<\/span> String name;\n    \/\/ getter and setter<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Hier wird das Feld name<\/code> durch die Aliase username<\/code> und user_name<\/code> repr\u00e4sentiert.<\/p>\n\n\n\n
@JsonAnyGetter<\/h2>\n\n\n\n
Die @JsonAnyGetter<\/code>-Annotation wird verwendet, um eine Map darzustellen, die zus\u00e4tzliche Eigenschaften enth\u00e4lt und w\u00e4hrend der Serialisierung in das JSON-Dokument einflie\u00dft.<\/p>\n\n\n
public class<\/span> CustomObject<\/span> <\/span>{\n    private Map<\/span><String<\/span>, String<\/span>> additionalProperties = new<\/span> HashMap<>();\n\n    @JsonAnyGetter\n    public Map<\/span><String<\/span>, String<\/span>> getAdditionalProperties() {\n        return<\/span> additionalProperties;\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
In diesem Beispiel k\u00f6nnen zus\u00e4tzliche Eigenschaften dynamisch zur Map hinzugef\u00fcgt werden und werden dann in das JSON-Dokument aufgenommen.<\/p>\n\n\n\n
@JsonPropertyOrder<\/h2>\n\n\n\n
Die @JsonPropertyOrder<\/code>-Annotation erm\u00f6glicht die Festlegung der Reihenfolge der Felder im generierten JSON-Dokument.<\/p>\n\n\n
@JsonPropertyOrder({\"name\"<\/span>, \"age\"<\/span>, \"address\"<\/span>})\npublic<\/span> class<\/span> Person<\/span> <\/span>{\n    private<\/span> String name;\n    private<\/span> int age;\n    private<\/span> String address;\n    \/\/ getters and setters<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Hier wird die Reihenfolge der Felder im JSON-Dokument durch die @JsonPropertyOrder<\/code>-Annotation spezifiziert.<\/p>\n\n\n\n
@JsonRawValue<\/h2>\n\n\n\n
Die @JsonRawValue<\/code>-Annotation wird verwendet, um anzugeben, dass ein String-Feld im JSON-Dokument als roher JSON-Text behandelt werden soll.<\/p>\n\n\n
public<\/span> class<\/span> RawValueExample<\/span> <\/span>{\n    @JsonRawValue\n    private<\/span> String rawJson;\n    \/\/ getter and setter<\/span>\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Durch die Verwendung von @JsonRawValue<\/code> wird der Inhalt des Felds rawJson<\/code> als Roh-JSON-Text behandelt und nicht weiter verarbeitet.<\/p>\n\n\n\n
Fazit<\/h2>\n\n\n\n
Die Jackson-Annotations bieten eine umfangreiche Palette von M\u00f6glichkeiten zur pr\u00e4zisen Steuerung der Serialisierung und Deserialisierung von Java-Objekten in JSON. Die hier vorgestellten Annotations erm\u00f6glichen Entwicklern, den JSON-Verarbeitungsprozess noch pr\u00e4ziser an ihre Anforderungen anzupassen. Eine detaillierte Kenntnis dieser Annotationsm\u00f6glichkeiten ist entscheidend, um die Flexibilit\u00e4t und Leistungsf\u00e4higkeit der Jackson-Bibliothek voll auszusch\u00f6pfen und optimale Ergebnisse bei der Verarbeitung von JSON-Daten in Java-Anwendungen zu erzielen.<\/p>\n","protected":false},"excerpt":{"rendered":"
Die Jackson-Bibliothek stellt eine herausragende Ressource f\u00fcr die Verarbeitung von JSON-Daten in Java-Anwendungen dar. Insbesondere bietet sie eine Vielzahl von Annotationsm\u00f6glichkeiten, um den Serialisierungs- und Deserialisierungsprozess von Java-Objekten in JSON zu beeinflussen. Dieser Artikel gibt einen tiefen Einblick in die verschiedenen Jackson-Annotations. Einleitung zu Jackson und JSON JSON (JavaScript Object Notation) hat sich als leichtgewichtiges […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[],"class_list":["post-162","post","type-post","status-publish","format-standard","hentry","category-plain_java"],"_links":{"self":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/162","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=162"}],"version-history":[{"count":1,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/162\/revisions"}],"predecessor-version":[{"id":163,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/162\/revisions\/163"}],"wp:attachment":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=162"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=162"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=162"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}