Spring Bootで@JsonComponentを使う

Spring Bootで@JsonComponentを使用する

1. 概要

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

アノテーションを使用すると、アノテーション付きのクラスを、ObjectMapperに手動で追加しなくても、Jacksonシリアライザーおよび/またはデシリアライザーとして公開できます。

これはコアスプリングブートモジュールの一部であるため、プレーンなスプリングブートアプリケーションに追加の依存関係は必要ありません。

2. 直列化

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

public class User {
    private Color favoriteColor;

    // standard getters/constructors
}

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

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

RGB値を印刷するだけで、たとえばCSSで使用することで、JSONをさらに圧縮して読みやすくすることができます。

この点で、JsonSerializerを実装するクラスを作成する必要があります。

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

このシリアライザーにより、結果のJSONは次のように削減されました。

{"favoriteColor":"#f0f8ff"}

@JsonComponentアノテーションにより、シリアライザーはSpring BootアプリケーションのJacksonObjectMapperに登録されます。次の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をJavaFXColorオブジェクトに変換するデシリアライザーを作成できます。

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

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

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

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

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

コードスニペットはover on GitHubにあります。

TOC