JavaでExcludeFilter（PropertyFilter）を使ってBeanをJSONオブジェクトに変換する方法

JsonConfigクラスを使用すると、JSONへのシリアライズ処理を柔軟にカスタマイズできます。JsonConfigが提供するsetJsonPropertyFilter()メソッドを呼び出すことで、変換時に適用されるプロパティフィルターを設定できます。フィルター本体は、PropertyFilterインターフェースのapply()メソッドをオーバーライドしたカスタムクラスとして実装します。このメソッドがtrueを返したプロパティはJSON出力から除外され、falseを返したプロパティはそのまま出力されます。

構文

public void setJsonPropertyFilter(PropertyFilter jsonPropertyFilter)

実装例

以下の例では、StudentクラスのBeanをJSONオブジェクトに変換しています。CustomPropertyFilterクラスでは、Number型およびString型のプロパティは出力対象とし、それ以外の型のプロパティを除外するように実装しています。なお、ここで使用しているJSONObjectやJsonConfigはjson-lib（net.sf.json）ライブラリのクラスです。

import net.sf.json.JSONObject;
import net.sf.json.JsonConfig;
import net.sf.json.util.PropertyFilter;

public class ConvertBeanToJsonExcludeFilterTest {
    public static void main(String[] args) {
        Student student = new Student("Sai", "Chaitanya", 20, "Hyderabad");

        JsonConfig jsonConfig = new JsonConfig();
        jsonConfig.setJsonPropertyFilter(new CustomPropertyFilter());

        JSONObject jsonObj = JSONObject.fromObject(student, jsonConfig);
        System.out.println(jsonObj.toString(3)); // 整形してJSONを出力
    }

    public static class Student {
        private String firstName, lastName, address;
        public int age;

        public Student(String firstName, String lastName, int age, String address) {
            super();
            this.firstName = firstName;
            this.lastName = lastName;
            this.age = age;
            this.address = address;
        }

        public String getFirstName() {
            return firstName;
        }

        public String getLastName() {
            return lastName;
        }

        public int getAge() {
            return age;
        }

        public String getAddress() {
            return address;
        }
    }
}

// カスタムプロパティフィルタークラス
class CustomPropertyFilter implements PropertyFilter {
    @Override
    public boolean apply(Object source, String name, Object value) {
        if(Number.class.isAssignableFrom(value.getClass()) || String.class.isAssignableFrom(value.getClass())) {
            return false; // Number型・String型は出力対象
        }
        return true; // それ以外は除外
    }
}

出力結果

フィルターによって不要なプロパティが除外され、以下のようなJSONが出力されます。

{
   "firstName": "Sai",
   "lastName": "Chaitanya",
   "address": "Hyderabad",
   "age": 20
}

ポイントまとめ

・JsonConfigでシリアライズ設定を行い、setJsonPropertyFilter()でフィルターを登録する
・PropertyFilter#apply()がtrueを返すとそのプロパティは除外される
・型やプロパティ名（引数name）を条件にすることで、柔軟な除外制御が可能