SpringBootでの@JsonComponentの使用

投稿日: 2019-10-18 2022-11-08
タグ: JSON, Spring Boot

1. 概要

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

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

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

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
  }
}

たとえば、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 アノテーションにより、シリアライザーはSpringBootアプリケーションの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<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つのクラスに**

必要に応じて、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 アノテーションを使用したコンポーネントスキャンを活用して、SpringBootアプリケーションにJacksonシリアライザー/デシリアライザーをすばやく追加する方法を示しました。

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

getdocs

13036