【Java】JsonConfigのsetExcludes()で特定のプロパティを除外し、BeanをJSONオブジェクトに変換する方法

JsonConfigクラスとは

JsonConfigクラスは、json-libライブラリに含まれるユーティリティクラスで、シリアライズ（JavaオブジェクトからJSONへの変換）処理を柔軟にカスタマイズするために使用されます。BeanをJSONオブジェクトに変換する際、setExcludes()メソッドを使うことで、出力したくないプロパティを簡単に除外できます。具体的には、除外対象のプロパティ名を設定したJsonConfigインスタンスを、JSONObjectクラスのstaticメソッドfromObject()の引数として渡すだけです。

setExcludes()メソッドの構文

public void setExcludes(String[] excludes)

引数には、除外したいプロパティ名をString型の配列で指定します。

依存関係の追加（Maven）

json-libを使用するには、あらかじめpom.xmlに以下の依存関係を追加しておきましょう。

<dependency>
    <groupId>net.sf.json-lib</groupId>
    <artifactId>json-lib</artifactId>
    <version>2.4</version>
    <classifier>jdk15</classifier>
</dependency>

実装例：BeanをJSONオブジェクトに変換する

以下の例では、StudentクラスのBeanをJSONオブジェクトに変換する際に、ageとaddressの2つのプロパティを除外しています。

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

public class BeanToJsonExcludeTest {
    public static void main(String[] args) {
        Student student = new Student("Raja", "Ramesh", 35, "Madhapur");
        JsonConfig jsonConfig = new JsonConfig();
        // 除外したいプロパティを指定
        jsonConfig.setExcludes(new String[]{"age", "address"});
        JSONObject obj = JSONObject.fromObject(student, jsonConfig);
        System.out.println(obj.toString(3)); // インデント付きで整形出力
    }

    public static class Student {
        private String firstName, lastName, address;
        private 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;
        }
    }
}

実行結果

実行すると、ageとaddressプロパティが除外され、それ以外のプロパティのみが出力されることが確認できます。

{
    "firstName": "Raja",
    "lastName": "Ramesh"
}

まとめ

JsonConfigクラスのsetExcludes()メソッドを活用すれば、BeanからJSONオブジェクトへの変換時に不要なフィールド（パスワードや個人情報など）を簡単に除外できます。セキュリティ対策やレスポンスサイズの削減の観点からも、APIレスポンスを生成する場面で特に役立つテクニックです。