Spring Bootで@JsonComponentを使う

1概要

この簡単な記事は、Spring Bootで @JsonComponent アノテーションを使用する方法に焦点を当てています。 。

このアノテーションを使用すると、手動で ObjectMapper に追加する必要なく、アノテーション付きクラスをJacksonのシリアライザやデシリアライザ、またはその両方に公開できます。

これはコアのSpring Bootモジュールの一部なので、普通のSpring Bootアプリケーションには追加の依存関係は必要ありません。

2直列化

お気に入りの色を含む次の User オブジェクトから始めましょう。

public class User {
    private Color favoriteColor;

   //standard getters/constructors
}

デフォルトの設定でJacksonを使用してこのオブジェクトをシリアル化すると、次のようになります。

…… {   "好きな色": {     "赤":0.9411764740943909、     "緑":0.9725490212440491、     "青":1.0、     "不透明度":1.0、     "不透明":真、     "色相":208.00000000000003、     「彩度」:0.05882352590560913、     "明るさ":1.0   } } ……

たとえばCSSで使用するために、RGB値を印刷するだけで、JSONをより簡潔にし、読みやすくすることができます。

この点では、 JsonSerializer を実装するクラスを作成するだけです。

@JsonComponent
public class UserJsonSerializer extends JsonSerializer<User> {

    @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);
    }
}

このシリアライザでは、結果のJSONは次のようになりました。

…… {"favoriteColor": "#f0f8ff"} ……

@ JsonComponent アノテーションが原因で、シリアライザはSpring BootアプリケーションのJackson ObjectMapper に登録されています。次のJUnitテストでこれをテストできます。

@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逆シリアル化

同じ例を続けて、Webの色 String をJavaFXのColorオブジェクトに変えるデシリアライザを書くことができます。

@JsonComponent
public class UserJsonDeserializer extends JsonDeserializer<User> {

    @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()));
    }
}

新しいデシリアライザをテストして、すべてが期待通りに機能することを確認しましょう。

@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 1つのクラス内の Serializer Deserializer

必要に応じて、2つの内部クラスを使用し、それを囲むクラスに @ JsonComponent を追加することによって、シリアライザとデシリアライザを1つのクラスに接続できます。

@JsonComponent
public class UserCombinedSerializer {

    public static class UserJsonSerializer
      extends JsonSerializer<User> {

        @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<User> {

        @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結論

このクイックチュートリアルでは、 @ JsonComponent アノテーションを使用したコンポーネントスキャンを活用して、Spring BootアプリケーションにJacksonシリアライザ/デシリアライザをすばやく追加する方法を示しました。

コードスニペットはhttps://github.com/eugenp/tutorials/tree/master/spring-boot[over on GitHub]にあります。