【Java】Jacksonの@JsonIgnoreアノテーションでJSONのフィールドを無視する方法

Jacksonの@JsonIgnoreアノテーションを使用すると、Javaオブジェクトの特定のプロパティ（フィールド）を無視できます。この設定は、JSONをJavaオブジェクトへ読み込む（デシリアライズする）ときと、JavaオブジェクトをJSONへ書き出す（シリアライズする）ときの両方で有効です。

JSONの読み込みにはObjectMapperクラスのreadValue()メソッドを、JSONへの書き出しにはwriteValueAsString()メソッドを使用します。

@JsonIgnoreアノテーションの構文

@Target(value={ANNOTATION_TYPE,METHOD,CONSTRUCTOR,FIELD})
@Retention(value=RUNTIME)
public @interface JsonIgnore

ターゲット定義を見ると、このアノテーションはフィールドだけでなく、メソッドやコンストラクタにも適用できることが分かります。

コード例

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

public class JsonIgnoreTest {
    public static void main(String[] args) throws IOException {
        Customer customer = new Customer("110", "Surya Kiran", "Chennai");
        System.out.println(customer);
        ObjectMapper mapper = new ObjectMapper();
        String jsonString = mapper.writeValueAsString(customer);
        System.out.println("JSON: " + jsonString);
        System.out.println("---------");
        jsonString = "{\"id\":\"120\",\"name\":\"Devaraj\", \"address\":\"Banglore\"}";
        System.out.println("JSON: " + jsonString);
        customer = mapper.readValue(jsonString, Customer.class);
        System.out.println(customer);
    }
}

// Customerクラス
class Customer {
    private String id;
    private String name;

    @JsonIgnore
    private String address;

    public Customer() {
    }

    public Customer(String id, String name, String address) {
        this.id = id;
        this.name = name;
        this.address = address;
    }

    public String getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public String getAddress() {
        return address;
    }

    @Override
    public String toString() {
        return "Customer [id=" + id + ", name=" + name + ", address=" + address + "]";
    }
}

実行結果

Customer [id=110, name=Surya Kiran, address=Chennai]
JSON: {"id":"110","name":"Surya Kiran"}
---------
JSON: {"id":"120","name":"Devaraj", "address":"Banglore"}
Customer [id=120, name=Devaraj, address=null]

結果の解説

実行結果から、@JsonIgnoreを付けたaddressフィールドが次のように処理されていることが分かります。

• 書き出し時（シリアライズ）：addressフィールドはJSONに含まれず、出力されるのはidとnameだけです。
• 読み込み時（デシリアライズ）：入力JSONにaddressキーが存在しても無視され、フィールドはnullのままになります。

なお、クラス単位で複数のプロパティを一括して無視したい場合は@JsonIgnorePropertiesアノテーションが便利です。@JsonIgnoreProperties(ignoreUnknown = true)のように指定すれば、JSON側に想定外のプロパティが含まれていてもエラーを防ぐことができます。