ジャクソンObjectMapperの紹介

投稿日: 2019-10-19 2022-10-17
タグ: Data, Jackson, Jackson Basics, JSON

1. 概要

このチュートリアルでは、Jackson ObjectMapper クラスの理解と、JavaオブジェクトをJSONにシリアル化し、JSON文字列をJavaオブジェクトに逆シリアル化する方法に焦点を当てています。

ジャクソンライブラリ全般について詳しく理解するには、ジャクソンチュートリアルから始めるのがよいでしょう。

2. 依存関係

まず、次の依存関係をpom.xmlに追加しましょう。

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.3</version>
</dependency>

この依存関係により、次のライブラリも一時的にクラスパスに追加されます。

ジャクソン-注釈
ジャクソンコア

jackson-databindには常にMaven中央リポジトリの最新バージョンを使用してください。

**3. ObjectMapperを使用した読み取りと書き込み**

基本的な読み取りおよび書き込み操作から始めましょう。

ObjectMapperのシンプルなreadValueAPIは、優れたエントリポイントです。これを使用して、JSONコンテンツを解析または逆シリアル化してJavaオブジェクトにすることができます。

また、書き込み側では、 writeValue APIを使用して、任意のJavaオブジェクトをJSON出力としてシリアル化できます。

この記事全体でシリアル化または逆シリアル化するオブジェクトとして、2つのフィールドを持つ次のCarクラスを使用します。

public class Car {

    private String color;
    private String type;

    // standard getters setters
}

3.1. JavaオブジェクトからJSONへ

ObjectMapperクラスのwriteValueメソッドを使用して、JavaオブジェクトをJSONにシリアル化する最初の例を見てみましょう。

ObjectMapper objectMapper = new ObjectMapper();
Car car = new Car("yellow", "renault");
objectMapper.writeValue(new File("target/car.json"), car);

上記のファイルの出力は次のようになります。

{"color":"yellow","type":"renault"}

ObjectMapperクラスのメソッドwriteValueAsStringおよびwriteValueAsBytesは、JavaオブジェクトからJSONを生成し、生成されたJSONを文字列またはバイト配列として返します。

String carAsString = objectMapper.writeValueAsString(car);

3.2. JSONからJavaオブジェクトへ

以下は、ObjectMapperクラスを使用してJSON文字列をJavaオブジェクトに変換する簡単な例です。

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Car car = objectMapper.readValue(json, Car.class);

readValue（）関数は、JSON文字列を含むファイルなどの他の形式の入力も受け入れます。

Car car = objectMapper.readValue(new File("src/test/resources/json_car.json"), Car.class);

またはURL：

Car car = 
  objectMapper.readValue(new URL("file:src/test/resources/json_car.json"), Car.class);

3.3. JSONからJacksonJsonNode

または、JSONを JsonNode オブジェクトに解析して、特定のノードからデータを取得するために使用することもできます。

String json = "{ \"color\" : \"Black\", \"type\" : \"FIAT\" }";
JsonNode jsonNode = objectMapper.readTree(json);
String color = jsonNode.get("color").asText();
// Output: color -> Black

3.4. JSON配列文字列からのJavaリストの作成

TypeReference を使用して、配列形式のJSONをJavaオブジェクトリストに解析できます。

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
List<Car> listCar = objectMapper.readValue(jsonCarArray, new TypeReference<List<Car>>(){});

3.5. JSON文字列からのJavaマップの作成

同様に、JSONをJava Mapに解析できます。

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Map<String, Object> map 
  = objectMapper.readValue(json, new TypeReference<Map<String,Object>>(){});

4. 高度な機能

Jacksonライブラリの最大の強みの1つは、高度にカスタマイズ可能なシリアル化および逆シリアル化プロセスです。

このセクションでは、入力または出力のJSON応答が、応答を生成または消費するオブジェクトとは異なる可能性があるいくつかの高度な機能について説明します。

4.1. シリアル化または逆シリアル化機能の構成

JSONオブジェクトをJavaクラスに変換しているときに、JSON文字列にいくつかの新しいフィールドがある場合、デフォルトのプロセスでは例外が発生します。

String jsonString 
  = "{ \"color\" : \"Black\", \"type\" : \"Fiat\", \"year\" : \"1970\" }";

Class Car のJavaオブジェクトに対するデフォルトの解析プロセスでの上記の例のJSON文字列は、UnrecognizedPropertyException例外を引き起こします。

configureメソッドを使用して、デフォルトのプロセスを拡張し、新しいフィールドを無視することができます：

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
Car car = objectMapper.readValue(jsonString, Car.class);

JsonNode jsonNodeRoot = objectMapper.readTree(jsonString);
JsonNode jsonNodeYear = jsonNodeRoot.get("year");
String year = jsonNodeYear.asText();

さらに別のオプションは、 FAIL_ON_NULL_FOR_PRIMITIVES に基づいています。これは、プリミティブ値のnull値が許可されるかどうかを定義します。

objectMapper.configure(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES, false);

同様に、 FAIL_ON_NUMBERS_FOR_ENUM は、列挙値を数値としてシリアル化/逆シリアル化できるかどうかを制御します。

objectMapper.configure(DeserializationFeature.FAIL_ON_NUMBERS_FOR_ENUMS, false);

シリアル化および逆シリアル化機能の包括的なリストは、公式サイトにあります。

4.2. カスタムシリアライザーまたはデシリアライザーの作成

ObjectMapper クラスのもう1つの重要な機能は、カスタムシリアライザーおよびデシリアライザーを登録する機能です。

カスタムシリアライザーとデシリアライザーは、入力または出力のJSON応答の構造が、シリアル化または逆シリアル化する必要のあるJavaクラスとは異なる状況で非常に役立ちます。

以下はカスタムJSONシリアライザーの例です：

public class CustomCarSerializer extends StdSerializer<Car> {
    
    public CustomCarSerializer() {
        this(null);
    }

    public CustomCarSerializer(Class<Car> t) {
        super(t);
    }

    @Override
    public void serialize(
      Car car, JsonGenerator jsonGenerator, SerializerProvider serializer) {
        jsonGenerator.writeStartObject();
        jsonGenerator.writeStringField("car_brand", car.getType());
        jsonGenerator.writeEndObject();
    }
}

このカスタムシリアライザーは、次のように呼び出すことができます。

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = 
  new SimpleModule("CustomCarSerializer", new Version(1, 0, 0, null, null, null));
module.addSerializer(Car.class, new CustomCarSerializer());
mapper.registerModule(module);
Car car = new Car("yellow", "renault");
String carJson = mapper.writeValueAsString(car);

クライアント側でのCarの外観（JSON出力として）は次のとおりです。

var carJson = {"car_brand":"renault"}

カスタムJSONデシリアライザーの例を次に示します。

public class CustomCarDeserializer extends StdDeserializer<Car> {
    
    public CustomCarDeserializer() {
        this(null);
    }

    public CustomCarDeserializer(Class<?> vc) {
        super(vc);
    }

    @Override
    public Car deserialize(JsonParser parser, DeserializationContext deserializer) {
        Car car = new Car();
        ObjectCodec codec = parser.getCodec();
        JsonNode node = codec.readTree(parser);
        
        // try catch block
        JsonNode colorNode = node.get("color");
        String color = colorNode.asText();
        car.setColor(color);
        return car;
    }
}

このカスタムデシリアライザーは、次の方法で呼び出すことができます。

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
ObjectMapper mapper = new ObjectMapper();
SimpleModule module =
  new SimpleModule("CustomCarDeserializer", new Version(1, 0, 0, null, null, null));
module.addDeserializer(Car.class, new CustomCarDeserializer());
mapper.registerModule(module);
Car car = mapper.readValue(json, Car.class);

4.3. 日付形式の処理

java.util.Date のデフォルトのシリアル化では、数値、つまりエポックタイムスタンプ（1970年1月1日からのミリ秒数、UTC）が生成されます。ただし、これは人間が読める形式ではなく、人間が読める形式で表示するにはさらに変換する必要があります。

これまでに使用したCarインスタンスをRequestクラス内でdatePurchasedプロパティでラップしてみましょう。

public class Request 
{
    private Car car;
    private Date datePurchased;

    // standard getters setters
}

日付の文字列形式を制御し、たとえば yyyy-MM-dd HH：mm az に設定するには、次のスニペットを検討してください。

ObjectMapper objectMapper = new ObjectMapper();
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm a z");
objectMapper.setDateFormat(df);
String carAsString = objectMapper.writeValueAsString(request);
// output: {"car":{"color":"yellow","type":"renault"},"datePurchased":"2016-07-03 11:43 AM CEST"}

Jacksonを使用した日付のシリアル化の詳細については、より詳細な記事を参照してください。

4.4. コレクションの処理

DeserializationFeature クラスで利用できるもう1つの小さいながらも便利な機能は、JSON配列の応答から必要なタイプのコレクションを生成する機能です。

たとえば、結果を配列として生成できます。

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.USE_JAVA_ARRAY_FOR_JSON_ARRAY, true);
Car[] cars = objectMapper.readValue(jsonCarArray, Car[].class);
// print cars

またはリストとして：

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
List<Car> listCar = objectMapper.readValue(jsonCarArray, new TypeReference<List<Car>>(){});
// print cars

Jacksonでのコレクションの処理の詳細については、こちらをご覧ください。

5. 結論

Jacksonは、Java用の堅実で成熟したJSONシリアル化/逆シリアル化ライブラリです。 ObjectMapper APIは、JSON応答オブジェクトを非常に柔軟に解析および生成するための簡単な方法を提供します。この記事では、ライブラリを非常に人気のあるものにする主な機能について説明しました。

記事に付属するソースコードは、GitHubのにあります。

getdocs

13036