複数のJSONフィールドを単一のJavaフィールドにマッピングする

投稿日: 2019-10-18 2022-10-16
タグ: Gson, JSON

1. 概要

このチュートリアルでは、JacksonとGsonの両方を使用して、さまざまなJSONフィールドを単一のJavaフィールドにマッピングする方法を説明します。

2. Mavenの依存関係

JacksonおよびGsonライブラリを使用するには、POMに次の依存関係を追加する必要があります。

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.5</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.0</version>
    <scope>test</scope>
</dependency>

3. サンプルJSON

Javaアプリケーションにさまざまな場所の天気の詳細を取得したいとします。気象データをJSONドキュメントとして公開しているWebサイトがいくつか見つかりました。ただし、使用する形式はわずかに異なります。

{
    "location": "London",
    "temp": 15,
    "weather": "Cloudy"
}

と：

{
    "place": "Lisbon",
    "temperature": 35,
    "outlook": "Sunny"
}

これらの形式の両方をWeatherという名前の同じJavaクラスに逆シリアル化します。

public class Weather {
    private String location;
    private int temp;
    private String outlook;
}

それでは、JacksonライブラリとGsonライブラリの両方を使用してこれを実現する方法を見てみましょう。

4. ジャクソンを使用する

これを実現するために、Jacksonの@JsonPropertyおよび@JsonAliasアノテーションを利用します。これらにより、複数のJSONプロパティを同じJavaフィールドにマッピングできます。

まず、 @JsonProperty アノテーションを使用して、JacksonがマップするJSONフィールドの名前を認識できるようにします。 @JsonProperty アノテーションの値は、逆シリアル化とシリアル化の両方に使用されます。

次に、@JsonAliasアノテーションを使用できます。その結果、Jacksonは、JavaフィールドにマップされているJSONドキュメント内の他のフィールドの名前を認識します。 @JsonAlias アノテーションの値は、逆シリアル化にのみ使用されます。

@JsonProperty("location")
@JsonAlias("place")
private String location;
@JsonProperty("temp")
@JsonAlias("temperature")
private int temp;

@JsonProperty("outlook")
@JsonAlias("weather")
private String outlook;

注釈を追加したので、Jacksonの ObjectMapper を使用して、Weatherクラスを使用してJavaオブジェクトを作成しましょう。

@Test
public void givenTwoJsonFormats_whenDeserialized_thenWeatherObjectsCreated() throws Exception {

    ObjectMapper mapper = new ObjectMapper();

    Weather weather = mapper.readValue("{\n"  
      + "  \"location\": \"London\",\n" 
      + "  \"temp\": 15,\n" 
      + "  \"weather\": \"Cloudy\"\n" 
      + "}", Weather.class);

    assertEquals("London", weather.getLocation());
    assertEquals("Cloudy", weather.getOutlook());
    assertEquals(15, weather.getTemp());

    weather = mapper.readValue("{\n" 
      + "  \"place\": \"Lisbon\",\n" 
      + "  \"temperature\": 35,\n"
      + "  \"outlook\": \"Sunny\"\n"
      + "}", Weather.class);

    assertEquals("Lisbon", weather.getLocation());
    assertEquals("Sunny", weather.getOutlook());
    assertEquals(35, weather.getTemp());
}

5. Gsonの使用

それでは、Gsonでも同じことを試してみましょう。 @SerializedNameアノテーションでvalueおよびalternateパラメーターを使用する必要があります。

最初のものはデフォルトとして使用され、2番目のものはマップするJSONフィールドの代替名を示すために使用されます。

@SerializedName(value="location", alternate="place")
private String location;
@SerializedName(value="temp", alternate="temperature")
private int temp;

@SerializedName(value="outlook", alternate="weather")
private String outlook;

アノテーションを追加したので、例をテストしてみましょう。

@Test
public void givenTwoJsonFormats_whenDeserialized_thenWeatherObjectsCreated() throws Exception {
        
    Gson gson = new GsonBuilder().create();
    Weather weather = gson.fromJson("{\n" 
      + "  \"location\": \"London\",\n" 
      + "  \"temp\": 15,\n" 
      + "  \"weather\": \"Cloudy\"\n" 
      + "}", Weather.class);
        
    assertEquals("London", weather.getLocation());
    assertEquals("Cloudy", weather.getOutlook());
    assertEquals(15, weather.getTemp());
        
    weather = gson.fromJson("{\n"
      + "  \"place\": \"Lisbon\",\n"
      + "  \"temperature\": 35,\n"
      + "  \"outlook\": \"Sunny\"\n"
      + "}", Weather.class);
       
    assertEquals("Lisbon", weather.getLocation());
    assertEquals("Sunny", weather.getOutlook());
    assertEquals(35, weather.getTemp());
        
}

6. 結論

Jacksonの@JsonAliasまたはGsonのalternateパラメーターを使用することで、さまざまなJSON形式を同じJavaオブジェクトに簡単に変換できることがわかりました。

例は、GitHubの JacksonおよびGsonプロジェクトにあります。

getdocs

13036