dev-resources.site

for different kinds of informations.

💾 Java Records 💿 with Jackson 2.12

Published at

3/4/2021

Categories

jackson

java14

records

serialization

Author

cchacin

Main Article

https://dev.to/cchacin/java-records-with-jackson-2-12-c81

Categories

4 categories in total

Author

7 person written this

💾 Java Records 💿 with Jackson 2.12

In the previous article about Java 14 Records, we saw how to start creating Records to avoid writing much boilerplate code that the compiler would generate for us.

Now the next steps are to see how we can serialize records to JSON and deserialize JSON to records to be able to use them as a request/response representation for microservices.

In this case, we would use the Jackson 2.12+.

Continuing with the same example that we used in the previous article, we would need to add Jackson Dependencies to our existing pom.xml file:

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.12.0</version>
</dependency>

💾 Now let’s see our example Record:

record Person(
    @JsonProperty("first_name") String firstName,
    @JsonProperty("last_name") String lastName,
    String address,
    Date birthday,
    List<String> achievements) {
}

💡 Java 14+ compiler would generate all of the following:

$ javap -p Person.class


final class Person extends java.lang.Record {
  private final java.lang.String firstName;
  private final java.lang.String lastName;
  private final java.lang.String address;
  private final java.util.Date birthday;
  private final java.util.List<java.lang.String> achievements;
  public Person(
    java.lang.String,
    java.lang.String,
    java.lang.String,
    java.util.Date,
    java.util.List<java.lang.String>);
  public final java.lang.String toString();
  public final int hashCode();
  public final boolean equals(java.lang.Object);
  public java.lang.String firstName();
  public java.lang.String lastName();
  public java.lang.String address();
  public java.util.Date birthday();
  public java.util.List<java.lang.String> achievements();
}

🔨 Our test setup:

final ObjectMapper mapper = new ObjectMapper()
      .enable(SerializationFeature.INDENT_OUTPUT);

To serialize/deserialize a record like this:

var person = new Person(
    "John",
    "Doe",
    "USA",
    new Date(981291289182L),
    List.of("Speaker")
);

To/From a json string like this:

{
  "first_name" : "John",
  "last_name" : "Doe",
  "address" : "USA",
  "birthday" : 981291289182,
  "achievements" : ["Speaker"]
}

💊 Testing Serialization

@Test
void serializeRecord() throws Exception {
    // Given
    var person = new Person(
            "John",
            "Doe",
            "USA",
            new Date(981291289182L),
            List.of("Speaker")
    );

    var json = """
            {
              "first_name" : "John",
              "last_name" : "Doe",
              "address" : "USA",
              "birthday" : 981291289182,
              "achievements" : ["Speaker"]
            }""";

    // When
    var serialized = mapper.writeValueAsString(person);

    // Then
    assertThat(serialized).isEqualTo(json);
}

💊 Testing Deserialization

Let’s use the same record to try the deserialization using also the same configuration:

@Test
void deserializeRecord() throws Exception {
    // Given
    var person = new Person(
            "John",
            "Doe",
            "USA",
            new Date(981291289182L),
            List.of("Speaker")
    );

    var json = """
            {
              "first_name" : "John",
              "last_name" : "Doe",
              "address" : "USA",
              "birthday" : 981291289182,
              "achievements" : ["Speaker"]
            }""";

    // When
    var deserialized = mapper.readValue(json, Person.class);

    // Then
    assertThat(deserialized).isEqualTo(person);
}

🔆 Conclusions

✅ We can start using Jackson >= 2.12.0 to serialize/deserialize Java Records.
👷 This is a new feature, and there can be edge cases, try it out with caution.
🐞 Report issues here if you find any

jackson Article's

30 articles in total

Why Do We Still Need Jackson or Gson in Java?

A simple GeoJSON serializer for Jackson

[Java Spring Boot] Como Criar Serializador Personalizado para seus Responses ou Json de saída

[Java Spring Boot] How to implement a Custom Serializer for your Responses or Json

[Java SpringBoot] Como Criar Deserializador Personalizado para seus Requests

[Java SpringBoot] How to implement a Custom Deserializer for your Requests

Java Jackson JSON: How to Handle Custom Keys?

Create a custom Jackson JsonSerializer und JsonDeserializer for mapping values

Anotación @JsonUnwrapped

A tale of fixing a tiny OpenAPI bug

Kotlin Springboot -- Part 21 任意の key value の json を POST する API E2E を書く

Formatting json Date/LocalDateTime/LocalDate in Spring Boot

Jackson's @JsonView with SpringBoot Tutorial

Jackson JSON parsing top-level map into records

Using Jackson Subtypes to Write Better Code

Java – Convert Excel File to/from JSON (String/File) – using Apache Poi + Jackson

How to resolve Json Infinite Recursion problem when working with Jackson

Java – Convert Excel File to/from JSON (String/File) – using Apache Poi + Jackson

Practical Java 16 - Using Jackson to serialize Records

Kotlin – Convert Object to/from JSON with Jackson 2.x

💾 Java Records 💿 with Jackson 2.12

currently reading

Jackson, JSON and the Proper Handling of Unknown Fields in APIs

Polymorphic deserialization with Jackson and no annotations

Playing around with Kotlin Sealed Classes

Moonwlker: JSON without annotation

Jackson Readonly properties and swagger UI

Registering Jackson sub-types at runtime in Kotlin

Parsing JSON in Spring Boot, part 1

Customize how Jackson does LocalDate Parsing

Painless JSON with Kotlin and jackson

Featured ones:

abubakersiddique761