Verwendung von @JsonComponent im Spring Boot

Verwenden von @JsonComponent in Spring Boot

1. Überblick

Dieser kurze Artikel befasst sich mit der Verwendung der Annotation@JsonComponentin Spring Boot.

Mit der Annotation können wir eine annotierte Klasse als Jackson-Serializer und / oder Deserializer verfügbar machen, ohne sie manuell zuObjectMapperhinzufügen zu müssen.

Dies ist Teil des Spring Boot-Kernmoduls, sodass in einer einfachen Spring Boot-Anwendung keine zusätzlichen Abhängigkeiten erforderlich sind.

2. Serialisierung

Beginnen wir mit dem folgendenUser-Objekt, das eine Lieblingsfarbe enthält:

public class User {
    private Color favoriteColor;

    // standard getters/constructors
}

Wenn wir dieses Objekt unter Verwendung von Jackson mit Standardeinstellungen serialisieren, erhalten wir:

{
  "favoriteColor": {
    "red": 0.9411764740943909,
    "green": 0.9725490212440491,
    "blue": 1.0,
    "opacity": 1.0,
    "opaque": true,
    "hue": 208.00000000000003,
    "saturation": 0.05882352590560913,
    "brightness": 1.0
  }
}

Wir können den JSON-Code wesentlich komprimierter und lesbarer machen, indem wir nur die RGB-Werte drucken - zum Beispiel zur Verwendung in CSS.

Insofern müssen wir nur eine Klasse erstellen, dieJsonSerializer implementiert:

@JsonComponent
public class UserJsonSerializer extends JsonSerializer {

    @Override
    public void serialize(User user, JsonGenerator jsonGenerator,
      SerializerProvider serializerProvider) throws IOException,
      JsonProcessingException {

        jsonGenerator.writeStartObject();
        jsonGenerator.writeStringField(
          "favoriteColor",
          getColorAsWebColor(user.getFavoriteColor()));
        jsonGenerator.writeEndObject();
    }

    private static String getColorAsWebColor(Color color) {
        int r = (int) Math.round(color.getRed() * 255.0);
        int g = (int) Math.round(color.getGreen() * 255.0);
        int b = (int) Math.round(color.getBlue() * 255.0);
        return String.format("#%02x%02x%02x", r, g, b);
    }
}

Mit diesem Serializer wurde der resultierende JSON auf Folgendes reduziert:

{"favoriteColor":"#f0f8ff"}

Aufgrund der Annotation@JsonComponent ist der Serializer in JacksonObjectMapper in der Spring Boot-Anwendung registriert. Wir können dies mit dem folgenden JUnit-Test testen:

@JsonTest
@RunWith(SpringRunner.class)
public class UserJsonSerializerTest {

    @Autowired
    private ObjectMapper objectMapper;

    @Test
    public void testSerialization() throws JsonProcessingException {
        User user = new User(Color.ALICEBLUE);
        String json = objectMapper.writeValueAsString(user);

        assertEquals("{\"favoriteColor\":\"#f0f8ff\"}", json);
    }
}

3. Deserialisierung

Wenn wir mit demselben Beispiel fortfahren, können wir einen Deserializer schreiben, der die WebfarbeString in ein JavaFX-Farbobjekt verwandelt:

@JsonComponent
public class UserJsonDeserializer extends JsonDeserializer {

    @Override
    public User deserialize(JsonParser jsonParser,
      DeserializationContext deserializationContext) throws IOException,
      JsonProcessingException {

        TreeNode treeNode = jsonParser.getCodec().readTree(jsonParser);
        TextNode favoriteColor
          = (TextNode) treeNode.get("favoriteColor");
        return new User(Color.web(favoriteColor.asText()));
    }
}

Testen wir den neuen Deserializer und stellen Sie sicher, dass alles wie erwartet funktioniert:

@JsonTest
@RunWith(SpringRunner.class)
public class UserJsonDeserializerTest {

    @Autowired
    private ObjectMapper objectMapper;

    @Test
    public void testDeserialize() throws IOException {
        String json = "{\"favoriteColor\":\"#f0f8ff\"}"
        User user = objectMapper.readValue(json, User.class);

        assertEquals(Color.ALICEBLUE, user.getFavoriteColor());
    }
}

**4. Serializer undDeserializer in einer Klasse**

Auf Wunsch können wir den Serializer und den Deserializer in einer Klasse verbinden, indem wir zwei innere Klassen verwenden und@JsonComponent zur umschließenden Klasse hinzufügen:

@JsonComponent
public class UserCombinedSerializer {

    public static class UserJsonSerializer
      extends JsonSerializer {

        @Override
        public void serialize(User user, JsonGenerator jsonGenerator,
          SerializerProvider serializerProvider) throws IOException,
          JsonProcessingException {

            jsonGenerator.writeStartObject();
            jsonGenerator.writeStringField(
              "favoriteColor", getColorAsWebColor(user.getFavoriteColor()));
            jsonGenerator.writeEndObject();
        }

        private static String getColorAsWebColor(Color color) {
            int r = (int) Math.round(color.getRed() * 255.0);
            int g = (int) Math.round(color.getGreen() * 255.0);
            int b = (int) Math.round(color.getBlue() * 255.0);
            return String.format("#%02x%02x%02x", r, g, b);
        }
    }

    public static class UserJsonDeserializer
      extends JsonDeserializer {

        @Override
        public User deserialize(JsonParser jsonParser,
          DeserializationContext deserializationContext)
          throws IOException, JsonProcessingException {

            TreeNode treeNode = jsonParser.getCodec().readTree(jsonParser);
            TextNode favoriteColor = (TextNode) treeNode.get(
              "favoriteColor");
            return new User(Color.web(favoriteColor.asText()));
        }
    }
}

5. Fazit

In diesem kurzen Tutorial wurde gezeigt, wie Sie schnell einen Jackson-Serializer / Deserializer in eine Spring Boot-Anwendung einfügen können, indem Sie das Scannen von Komponenten mit der Annotation@JsonComponentnutzen.

Die Codefragmente könnenover on GitHub gefunden werden.

TOC