Jacksonの@JsonIgnoreTypeアノテーションでシリアライズ時にクラスを丸ごと無視する方法

@JsonIgnoreTypeアノテーションとは

Jacksonの@JsonIgnoreTypeアノテーションを使用すると、シリアライズ（直列化）の処理において特定のクラス全体を無視することができます。このアノテーションをクラスに付与すると、そのクラスが持つすべてのプロパティやフィールドが、JSONのシリアライズおよびデシリアライズの対象から自動的に除外されます。

フィールドごとに@JsonIgnoreを個別に指定する代わりに、型レベルで一括して除外できるため、ネストされたオブジェクトを出力に含めたくない場合などに非常に便利です。

構文

@Target(value={ANNOTATION_TYPE,TYPE})
@Retention(value=RUNTIME)
public @interface JsonIgnoreType

このアノテーションはクラスやその他のアノテーション型に適用でき、メタ情報は実行時（RUNTIME）まで保持されます。

コード例

以下は、Employeeクラスの内部クラスとして定義されたAddressクラスに@JsonIgnoreTypeを付与したサンプルです。

import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import java.io.*;

public class JsonIgnoreTypeTest {
    public static void main(String args[]) throws IOException {
        Employee emp = new Employee();
        ObjectMapper mapper = new ObjectMapper();
        String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(emp);
        System.out.println(jsonString);
    }
}

// Employeeクラス
class Employee {
    @JsonIgnoreType
    public static class Address {
        public String firstLine = null;
        public String secondLine = null;
        public String thirdLine = null;
        @Override
        public String toString() {
            return "Address{" +
                    "firstLine='" + firstLine + '\'' +
                    ", secondLine='" + secondLine + '\'' +
                    ", thirdLine='" + thirdLine + '\'' +
                    '}';
        }
    } // Addressクラスの終わり

    public long empId = 115;
    public String empName = "Raja Ramesh";
    public Address empAddress = new Address();

    @Override
    public String toString() {
        return "Employee{" +
                "empId=" + empId +
                ", empName='" + empName + '\'' +
                ", empAddress=" + empAddress +
                '}';
    }
}

実行結果

{
    "empId" : 115,
    "empName" : "Raja Ramesh"
}

結果の解説

出力結果にはempIdとempNameのみが含まれ、empAddressフィールドは出力されていません。これは、Addressクラスに@JsonIgnoreTypeが付与されているため、Jacksonがシリアライズ時にAddress型を完全に無視した結果です。このように、型単位で除外を宣言できるため、機密情報や不要な内部データをJSON出力から簡単に隠すことができます。