如何在Java中解析JSON時忽略未知屬性？-java教程-PHP中文網

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

在 Java 中處理 JSON 資料時，開發人員可能會遇到未在對應 Java 類別中定義的未知屬性或欄位。這些未識別的元素可能會在解析過程中產生問題，導致異常或資料遺失。為了解決這個問題，程式設計師可以採用一種機制來在解析 JSON 時忽略這類未知屬性。

正確配置 JSON 解析器可以防止意外屬性破壞應用程式的功能。透過跳過無法識別的屬性並僅解析與定義的結構匹配的屬性，可以以更健壯和靈活的方式解析 JSON 資料。這確保了重要資訊不會被忽視，同時不需要的或無效的資料也會被忽略。

JSON

Java 將 JSON（JavaScript 物件表示法）作為一種輕量級且廣泛使用的資料交換格式，用於傳輸和儲存結構化資料。其簡單且易於人類讀取的格式允許表示物件、陣列、字串、數字、布林值和空值。 JSON 的組成包括使用字串形式的鍵的鍵值對，以減輕其處理負載。

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

方法

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

有 ObjectMapper 的 Jackson 函式庫
有 GsonBuilder 的 Gson 函式庫
JSON-B（用於 JSON 綁定的 Java API）
手動解析

帶有 ObjectMapper 的 Jackson 庫

此方法涉及透過將 DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES 功能設為 false 來配置 ObjectMapper（Jackson 庫提供的一個類別）。這允許 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 實例。這可以透過呼叫參數為 true 的 setIgnoreUnknownProperties() 方法來實現。這樣做會指示 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（用於 JSON 綁定的 Java API）

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

演算法

在要忽略的欄位或屬性上使用 @JsonbTransient 註解表示 JSON 結構的 Java 類別。
使用 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、使用 Gson 和 GsonBuilder、利用 JSON-B 註解或手動解析 JSON 資料等方法，開發人員可以有效地忽略未知屬性並減輕在 Java 中解析 JSON 時潛在的問題。

以上是如何在Java中解析JSON時忽略未知屬性？的詳細內容。更多資訊請關注PHP中文網其他相關文章！