TOC

Jacksonとカスタム基準を満たすフィールドのみを直列化する

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

1. 概要

このチュートリアルでは、use Jackson to only serialize a field if it meets a specific, custom criteriaを実行する方法を説明します。

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

さらに深く掘り下げてother cool things you can do with the Jackson 2を学びたい場合は、the main Jackson tutorialに進んでください。

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フィールドをserialized or notにするかどうかを決定する実際のロジックが含まれています。

次に、このフィルターを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フィールドが実際にnot part of the marshalled JSON outputであることを確認できます。 

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

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

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

3.1. 非表示のクラス

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

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

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

Personクラス： 

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

そしてAddressクラス： 

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

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

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

次に、カスタムシリアライザーを示します。 

public class HidableSerializer extends JsonSerializer {

    private JsonSerializer defaultSerializer;

    public HidableSerializer(JsonSerializer 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) 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 




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






最初のケース、nothing is hidden： 








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








次に、only address is hidden： 








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








さて、entire person is hidden： 








@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出力を制御することです。したがって、このソリューションの柔軟性が十分でない場合は、調査する価値があります。 






これらすべての例とコードスニペットcan be found in my github projectの実装–これはEclipseベースのプロジェクトであるため、そのままインポートして実行するのは簡単です。 







                    

                        


    
    
    
    
    
    
    
    
    
    
    
    





                    

                
                



            
            

                

    
    
    


                

    
    
    


                

    
Related