Jacksonの@ConstructorPropertiesアノテーションとは？使い方と活用すべき場面を解説

@ConstructorPropertiesアノテーションとは

@ConstructorPropertiesは、java.beansパッケージに含まれる標準アノテーションで、JSONをJavaオブジェクトへデシリアライズする際にアノテーション付きコンストラクタを利用できるようにするものです。Jackson 2.7以降からサポートされています。

このアノテーションの動作は非常にシンプルです。コンストラクタの各パラメータに個別にアノテーションを付与する代わりに、プロパティ名の配列を一度に指定するだけで済みます。そのため、finalフィールドを持つイミュータブル（不変）クラスを扱う場合や、セッターメソッドを持たないクラスをJSONから復元したい場合に特に有効です。

構文

@Documented
@Target(value=CONSTRUCTOR)
@Retention(value=RUNTIME)
public @interface ConstructorProperties

このアノテーションはコンストラクタに対してのみ適用可能で、文字列配列として各パラメータに対応するプロパティ名を渡します。

使用例

以下は、@ConstructorPropertiesを使ってEmployeeクラスを定義し、Jacksonでシリアライズする例です。

import com.fasterxml.jackson.databind.ObjectMapper;
import java.beans.ConstructorProperties;

public class ConstructorPropertiesAnnotationTest {
    public static void main(String args[]) throws Exception {
        ObjectMapper mapper = new ObjectMapper();
        Employee emp = new Employee(115, "Raja");
        String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(emp);
        System.out.println(jsonString);
    }
}

// Employeeクラス
class Employee {
    private final int id;
    private final String name;

    @ConstructorProperties({"id", "name"})
    public Employee(int id, String name) {
        this.id = id;
        this.name = name;
    }

    public int getEmpId() {
        return id;
    }

    public String getEmpName() {
        return name;
    }
}

出力結果

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

まとめ

@ConstructorPropertiesは、イミュータブルなクラスやfinalフィールドを持つクラスをJSONと相互変換する際に役立つアノテーションです。コンストラクタのパラメータ順に対応するプロパティ名を配列で指定するだけで、Jacksonが正しくデシリアライズを行えるようになります。Jackson 2.7以降を使用している場合は、積極的に活用するとコードの可読性と安全性が向上します。