ジャクソンとのカスタム基準を満たすフィールドのみをシリアル化する

投稿日: 2019-10-18 2022-11-06
タグ: Data, Jackson, JSON

1. 概要

このチュートリアルでは、 Jacksonを使用して、特定のカスタム基準を満たす場合にのみフィールドをシリアル化する方法を説明します。

たとえば、正の場合にのみ整数値をシリアル化し、そうでない場合は完全にスキップしたいとします。

より深く掘り下げてジャクソン2でできる他のクールなことを学びたい場合は、メインのジャクソンチュートリアルに進んでください。

2. JacksonFilterを使用してシリアル化プロセスを制御する

まず、 @JsonFilter アノテーションを使用して、エンティティにフィルターを定義する必要があります。

@JsonFilter("myFilter")
public class MyDto {
    private int intValue;

    public MyDto() {
        super();
    }

    public int getIntValue() {
        return intValue;
    }

    public void setIntValue(int intValue) {
        this.intValue = intValue;
    }
}

次に、カスタムPropertyFilterを定義する必要があります。

PropertyFilter theFilter = new SimpleBeanPropertyFilter() {
   @Override
   public void serializeAsField
    (Object pojo, JsonGenerator jgen, SerializerProvider provider, PropertyWriter writer)
     throws Exception {
      if (include(writer)) {
         if (!writer.getName().equals("intValue")) {
            writer.serializeAsField(pojo, jgen, provider);
            return;
         }
         int intValue = ((MyDtoWithFilter) pojo).getIntValue();
         if (intValue >= 0) {
            writer.serializeAsField(pojo, jgen, provider);
         }
      } else if (!jgen.canOmitFields()) { // since 2.3
         writer.serializeAsOmittedField(pojo, jgen, provider);
      }
   }
   @Override
   protected boolean include(BeanPropertyWriter writer) {
      return true;
   }
   @Override
   protected boolean include(PropertyWriter writer) {
      return true;
   }
};

このフィルターには、intValueフィールドをその値に基づいてシリアル化するかしないかを決定する実際のロジックが含まれています。

次に、このフィルターを ObjectMapper にフックし、エンティティをシリアル化します。

FilterProvider filters = new SimpleFilterProvider().addFilter("myFilter", theFilter);
MyDto dtoObject = new MyDto();
dtoObject.setIntValue(-1);

ObjectMapper mapper = new ObjectMapper();
String dtoAsString = mapper.writer(filters).writeValueAsString(dtoObject);

そして最後に、intValueフィールドが実際にマーシャリングされたJSON出力の一部ではないことを確認できます。

assertThat(dtoAsString, not(containsString("intValue")));

3. 条件付きでオブジェクトをスキップする

次に、プロパティvalueに基づいてシリアル化するときにオブジェクトをスキップする方法について説明します。プロパティhiddenがtrueであるすべてのオブジェクトをスキップします。

3.1. 非表示のクラス

まず、Hidableインターフェイスを見てみましょう。

@JsonIgnoreProperties("hidden")
public interface Hidable {
    boolean isHidden();
}

そして、このインターフェース Person 、Addressを実装する2つの単純なクラスがあります。

人クラス：

public class Person implements Hidable {
    private String name;
    private Address address;
    private boolean hidden;
}

そしてアドレスクラス：

public class Address implements Hidable {
    private String city;
    private String country;
    private boolean hidden;
}

注： @JsonIgnoreProperties（ “hidden”）を使用して、hiddenプロパティ自体がJSONに含まれていないことを確認しました

3.2. カスタムシリアライザー

次へ–カスタムシリアライザーは次のとおりです。

public class HidableSerializer extends JsonSerializer<Hidable> {

    private JsonSerializer<Object> defaultSerializer;

    public HidableSerializer(JsonSerializer<Object> serializer) {
        defaultSerializer = serializer;
    }

    @Override
    public void serialize(Hidable value, JsonGenerator jgen, SerializerProvider provider)
      throws IOException, JsonProcessingException {
        if (value.isHidden())
            return;
        defaultSerializer.serialize(value, jgen, provider);
    }

    @Override
    public boolean isEmpty(SerializerProvider provider, Hidable value) {
        return (value == null || value.isHidden());
    }
}

ご了承ください：

オブジェクトがスキップされない場合、シリアル化をデフォルトの挿入されたシリアライザーに委任します。
メソッドisEmpty（）をオーバーライドしました。これにより、Hidableオブジェクトがプロパティの場合、プロパティ名もJSONから除外されます。

**3.3. BeanSerializerModifierを使用する**

最後に、 BeanSerializerModifier を使用して、カスタム HidableSerializer にデフォルトのシリアライザーを挿入する必要があります–次のようになります。

ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_EMPTY);
mapper.registerModule(new SimpleModule() {
    @Override
    public void setupModule(SetupContext context) {
        super.setupModule(context);
        context.addBeanSerializerModifier(new BeanSerializerModifier() {
            @Override
            public JsonSerializer<?> modifySerializer(
              SerializationConfig config, BeanDescription desc, JsonSerializer<?> serializer) {
                if (Hidable.class.isAssignableFrom(desc.getBeanClass())) {
                    return new HidableSerializer((JsonSerializer<Object>) serializer);
                }
                return serializer;
            }
        });
    }
});

3.4. サンプル出力

簡単なシリアル化の例を次に示します。

Address ad1 = new Address("tokyo", "jp", true);
Address ad2 = new Address("london", "uk", false);
Address ad3 = new Address("ny", "usa", false);
Person p1 = new Person("john", ad1, false);
Person p2 = new Person("tom", ad2, true);
Person p3 = new Person("adam", ad3, false);

System.out.println(mapper.writeValueAsString(Arrays.asList(p1, p2, p3)));

そして、出力は次のとおりです。

[
    {
        "name":"john"
    },
    {
        "name":"adam",
        "address":{
            "city":"ny",
            "country":"usa"
        }
    }
]

3.5. テスト

最後に–ここにいくつかのテストケースがあります：

最初のケース、何も隠されていません：

@Test
public void whenNotHidden_thenCorrect() throws JsonProcessingException {
    Address ad = new Address("ny", "usa", false);
    Person person = new Person("john", ad, false);
    String result = mapper.writeValueAsString(person);

    assertTrue(result.contains("name"));
    assertTrue(result.contains("john"));
    assertTrue(result.contains("address"));
    assertTrue(result.contains("usa"));
}

次に、アドレスのみが非表示になります：

@Test
public void whenAddressHidden_thenCorrect() throws JsonProcessingException {
    Address ad = new Address("ny", "usa", true);
    Person person = new Person("john", ad, false);
    String result = mapper.writeValueAsString(person);

    assertTrue(result.contains("name"));
    assertTrue(result.contains("john"));
    assertFalse(result.contains("address"));
    assertFalse(result.contains("usa"));
}

これで、人全体が非表示になります：

@Test
public void whenAllHidden_thenCorrect() throws JsonProcessingException {
    Address ad = new Address("ny", "usa", false);
    Person person = new Person("john", ad, true);
    String result = mapper.writeValueAsString(person);

    assertTrue(result.length() == 0);
}

4. 結論

このタイプの高度なフィルタリングは非常に強力であり、Jacksonを使用して複雑なオブジェクトをシリアル化するときにjsonを非常に柔軟にカスタマイズできます。

より柔軟ですが、より複雑な代替手段は、完全にカスタムのシリアライザーを使用してJSON出力を制御することです。したがって、このソリューションの柔軟性が十分でない場合は、調査する価値があります。

これらすべての例とコードスニペットの実装は、GitHub にあります。これはMavenベースのプロジェクトであるため、そのままインポートして実行するのは簡単です。

getdocs

13036