Jacksonの@JsonRootNameアノテーションとは？Javaでのラップ出力の方法を解説

@JsonRootNameアノテーションは、シリアライズ対象のオブジェクトをトップレベル要素（ルート要素）でラップするために使用されます。このアノテーションには、ルート名として使用したい文字列をパラメータとして渡すことができます。

実際にルート値のラップを有効にするには、SerializationFeature列挙型が持つ「WRAP_ROOT_VALUE」フィーチャーを有効化します。これにより、JSON全体が単一のプロパティを持つオブジェクト形式になり、そのキーには@JsonRootNameで指定したルート名が使用されます。

APIレスポンスの形式を統一したい場合や、外部システムとの連携で特定のXML・JSON構造が求められる場合などに、このアノテーションは非常に役立ちます。

コード例

import com.fasterxml.jackson.annotation.JsonRootName;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.SerializationFeature;

public class JsonRootNameAnnotationTest {
    public static void main(String args[]) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        String jsonString = mapper.enable(SerializationFeature.WRAP_ROOT_VALUE).writeValueAsString(new Employee());
        System.out.println(jsonString);
    }
}

@JsonRootName(value = "user")
class Employee {
    public int empId = 125;
    public String empName = "Raja Ramesh";
}

実行結果

{"user":{"empId":125,"empName":"Raja Ramesh"}}

上記の出力を見ると、Employeeオブジェクトの各フィールドが、「user」というキーの配下にネストされて出力されていることがわかります。@JsonRootNameを指定せずにWRAP_ROOT_VALUEを有効にした場合は、クラス名がそのままルート名として使用される点にも注意してください。