將多個JSON欄位對映到單個Java欄位

油膩的Java發表於2019-03-20
JSONJava

簡介

本文中，教大家如何使用Jackson和Gson將不同的JSON欄位對映到單個Java欄位中。

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.9.8</version>
    <scope>test</scope>
</dependency>

複製程式碼

示例JSON

假如，我們希望將不同位置的天氣細節輸入到我們的Java類中。我們發現了一些將天氣資料釋出為JSON文件的網站。但是，它們的格式並未是一致的

{
    "location": "廣州",
    "temp": 15,
    "weather": "多雲"
}
複製程式碼
{
    "place": "深圳",
    "temperature": 35,
    "outlook": "晴天"
}
複製程式碼

我們希望將這兩種格式反序列化為同一個Java類，名為 Weather：

使用Jackson

為實現這一目標，我們將使用Jackson的@JsonProperty和@JsonAlias註釋。這兩個註解將幫助我們把JSON屬性對映到同一Java欄位。

首先，我們將使用@JsonProperty註釋，以便讓Jackson知道要對映的JSON欄位的名稱。在值@JsonProperty註解同時用於反序列化和序列化。

然後我們可以使用@JsonAlias註釋。因此，Jackson將知道JSON文件中對映到Java欄位的其他欄位的名稱。在用了@JsonAlias註釋的屬性用於反序列化。

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

Getter、Setter忽略
複製程式碼

現在我們已經新增了註釋，讓我們使用Jackson的ObjectMapper方法建立Weather物件。

@Test
public void test() throws Exception {
 
    ObjectMapper mapper = new ObjectMapper();
 
    Weather weather = mapper.readValue("{\n" 
      + "  \"location\": \"廣州\",\n"
      + "  \"temp\": 15,\n"
      + "  \"weather\": \"多雲\"\n"
      + "}", Weather.class);
 
    TestCase.assertEquals("廣州", weather.getLocation());
        TestCase.assertEquals("多雲", weather.getOutlook());
        TestCase.assertEquals(15, weather.getTemp());
 
    weather = mapper.readValue("{\n"
      + "  \"place\": \"深圳\",\n"
      + "  \"temperature\": 35,\n"
      + "  \"outlook\": \"晴天\"\n"
      + "}", Weather.class);
 
   TestCase.assertEquals("深圳", weather.getLocation());
        TestCase.assertEquals("晴天", weather.getOutlook());
        TestCase.assertEquals(35, weather.getTemp());
}

複製程式碼

使用Gson

現在，我們來看看Gson如何實現。我們需要在@SerializedName註釋中使用值和 備用引數。

第一個將用作預設值，而第二個將用於指示我們要對映的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 test() throws Exception {
         
    Gson gson = new GsonBuilder().create();
    Weather weather = gson.fromJson("{\n"
      + "  \"location\": \"廣州\",\n"
      + "  \"temp\": 15,\n"
      + "  \"weather\": \"多雲\"\n"
      + "}", Weather.class);
         
    TestCase.assertEquals("廣州", weather.getLocation());
        TestCase.assertEquals("多雲", weather.getOutlook());
        TestCase.assertEquals(15, weather.getTemp());
         
    weather = gson.fromJson("{\n"
      + "  \"place\": \"深圳\",\n"
      + "  \"temperature\": 35,\n"
      + "  \"outlook\": \"晴天\"\n"
      + "}", Weather.class);
        
      TestCase.assertEquals("深圳", weather.getLocation());
        TestCase.assertEquals("晴天", weather.getOutlook());
        TestCase.assertEquals(35, weather.getTemp());
         
}

複製程式碼

結論

我們通過使用Jackson的@JsonAlias或Gson的替代引數看到了這一點，我們可以輕鬆地將不同的JSON格式轉換為相同的Java物件。

相關文章