如何在 Java 中忽略解析 JSON 時未知的屬性?


在 Java 中處理 JSON 資料時,開發者可能會遇到在相應的 Java 類中未定義的未知屬性或欄位。這些未識別的元素可能會在解析過程中造成問題,導致異常或資料丟失。為了解決這個問題,程式設計師可以加入一種機制來忽略解析 JSON 時此類未知屬性。

正確配置 JSON 解析器可以防止意外屬性破壞應用程式的功能。透過跳過未識別的屬性,只解析與定義結構匹配的屬性,可以更健壯和靈活地解析 JSON 資料。這確保不會忽略關鍵資訊,同時忽略不需要的或無效的資料。

JSON

Java 使用 JSON (JavaScript 物件表示法) 作為輕量級且廣泛使用的資料交換格式來傳輸和儲存結構化資料。其簡單易讀的格式允許表示物件、陣列、字串、數字、布林值和空值。JSON 的構成包括使用字串形式的鍵的鍵值對,簡化了其處理負載。

改述Java 中的 JSON 格式通常表示為字串,並使用解析和序列化庫在 Java 物件之間進行轉換。這些 API 透過允許將 JSON 字串解析為 Java 物件,反之亦然,從而實現基於 JSON 的系統和 Java 應用程式之間的整合。這種無縫通訊促進了不同系統之間的資料輕鬆交換。

方法

在 Java 中忽略解析 JSON 時未知屬性的方法有很多。以下是一些常用方法

  • 使用 ObjectMapper 的 Jackson 庫

  • 使用 GsonBuilder 的 Gson 庫

  • JSON-B (Java API for JSON Binding)

  • 手動解析

使用 ObjectMapper 的 Jackson 庫

此方法涉及配置 Jackson 庫提供的類 ObjectMapper,即將 DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES 特性設定為 false。這允許 ObjectMapper 在解析 JSON 時忽略未知屬性,防止丟擲異常。

演算法

  • 建立 ObjectMapper 例項。

  • 配置 ObjectMapper 將 DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES 特性設定為 false。

  • 使用 ObjectMapper 將 JSON 資料解析為所需的 Java 物件。

示例

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JacksonExample {
   public static void main(String[] args) throws Exception {
      String jsonString = "{"name": "John", "age": 25, "unknownProperty": "Value"}";

      ObjectMapper objectMapper = new ObjectMapper();
 
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

      Person person = objectMapper.readValue(jsonString, Person.class);
      System.out.println(person);
   }
}

class Person {
   private String name;
   private int age;

   // Getters and setters

   @Override
   public String toString() {
      return "Person{" +
            "name='" + name + ''' +
            ", age=" + age +
            '}';
   }
}

輸出

Person{name='John', age=25}

使用 GsonBuilder 的 Gson 庫

在此方法中使用 Gson 庫,需要使用 GsonBuilder 類建立一個 Gson 例項。這可以透過呼叫 setIgnoreUnknownProperties() 方法並使用 true 作為引數來實現。這樣做指示 Gson 在 JSON 解析期間忽略未知屬性,確保它們不被視為錯誤。

演算法

  • 建立一個 GsonBuilder 例項。

  • 在 GsonBuilder 例項上呼叫 setIgnoreUnknownProperties(true) 方法。

  • 使用 GsonBuilder 構建一個 Gson 物件。

  • 使用 Gson 物件將 JSON 資料解析為所需的 Java 物件。

示例

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonExample {
   public static void main(String[] args) {
      String jsonString = "{"name": "John", "age": 25, "unknownProperty": "Value"}";

      Gson gson = new GsonBuilder()
            .setIgnoreUnknownProperties(true)
            .create();

      Person person = gson.fromJson(jsonString, Person.class);
      System.out.println(person);
   }
}

class Person {
   private String name;
   private int age;

   // Getters and setters

   @Override
   public String toString() {
      return "Person{" +
            "name='" + name + ''' +
            ", age=" + age +
            '}';
   }
}

輸出

Person{name='John', age=25}

JSON-B (Java API for JSON Binding)

要使用 JSON-B 忽略未知屬性,表示 JSON 結構的 Java 類需要在應該忽略的欄位或屬性上使用 @JsonbTransient 註解。此註解通知 JSON-B 庫在 JSON 解析過程中跳過這些屬性。

演算法

  • 在表示 JSON 結構的 Java 類上使用 @JsonbTransient 註解要忽略的欄位或屬性。

  • 使用 JSON-B 實現將 JSON 資料解析為所需的 Java 物件。

示例

import javax.json.bind.Jsonb;
import javax.json.bind.JsonbBuilder;

public class JsonBExample {
   public static void main(String[] args) {
      String jsonString = "{"name": "John", "age": 25, "unknownProperty": "Value"}";

      Jsonb jsonb = JsonbBuilder.create();

      Person person = jsonb.fromJson(jsonString, Person.class);
      System.out.println(person);
   }
}

class Person {
   private String name;
   private int age;

   // Getters and setters

   @Override
   public String toString() {
      return "Person{" +
            "name='" + name + ''' +
            ", age=" + age +
            '}';
   }
}

輸出

Person{name='John', age=25}

手動解析

要使用像 org.json 或 json-simple 這樣的庫解析 JSON 資料,開發者需要手動迭代 JSON 物件的鍵和值。透過選擇性地處理已識別的屬性並忽略未知屬性,開發者可以自定義他們需要的解析行為。

演算法

  • 使用像 org.json 或 json-simple 這樣的 JSON 庫將 JSON 資料解析為 JSON 物件。

  • 迭代 JSON 物件的鍵和值。

  • 在迭代期間處理已識別的屬性並忽略任何未識別或未知的屬性。

示例

import org.json.JSONObject;

public class ManualParsingExample {
   public static void main(String[] args) {
      String jsonString = "{"name": "John", "age": 25, "unknownProperty": "Value"}";

      JSONObject jsonObject = new JSONObject(jsonString);

      String name = jsonObject.optString("name");
      int age = jsonObject.optInt("age");

      Person person = new Person();
      person.setName(name);
      person.setAge(age);

      System.out.println(person);
   }
}

class Person {
   private String name;
   private int age;

   // Getters and setters

   @Override
   public String toString() {
      return "Person{" +
            "name='" + name + ''' +
            ", age=" + age +
            '}';
   }
}

輸出

Person{name='John', age=25}

結論

在本教程中,在 Java 中解析 JSON 時,正確處理未知屬性非常重要,以確保資料處理的健壯性和靈活性。透過使用諸如使用 Jackson 配置 ObjectMapper、使用 GsonBuilder 使用 Gson、利用 JSON-B 註解或手動解析 JSON 資料等方法,開發者可以有效地忽略未知屬性,並在 Java 中解析 JSON 時減少潛在問題。

更新於:2023年7月25日

3K+ 次瀏覽

啟動您的職業生涯

完成課程獲得認證

開始學習
廣告