Практическое применение и реальные примеры использования
Теперь, когда вы понимаете, как настроить ObjectMapper для игнорирования неизвестных свойств, давайте рассмотрим некоторые практические применения и реальные сценарии, в которых эта функция полезна.
1. Использование сторонних API
При интеграции с внешними API у вас часто нет контроля над изменениями в формате их ответов. Настроив ObjectMapper на игнорирование неизвестных свойств, ваше приложение может продолжать работать, даже если API добавляет новые поля.
Давайте создадим простой пример, который имитирует использование API погоды:
- Создайте новый файл по пути
~/project/src/main/java/com/labex/json/WeatherData.java
- Добавьте следующий код в файл:
package com.labex.json;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@JsonIgnoreProperties(ignoreUnknown = true)
public class WeatherData {
private String city;
private double temperature;
private int humidity;
// Default constructor needed for Jackson
public WeatherData() {
}
// Getters and setters
public String getCity() {
return city;
}
public void setCity(String city) {
this.city = city;
}
public double getTemperature() {
return temperature;
}
public void setTemperature(double temperature) {
this.temperature = temperature;
}
public int getHumidity() {
return humidity;
}
public void setHumidity(int humidity) {
this.humidity = humidity;
}
@Override
public String toString() {
return "WeatherData{" +
"city='" + city + '\'' +
", temperature=" + temperature +
", humidity=" + humidity +
'}';
}
}
- Создайте новый файл по пути
~/project/src/main/java/com/labex/json/WeatherApiConsumer.java
- Добавьте следующий код в файл:
package com.labex.json;
import com.fasterxml.jackson.databind.ObjectMapper;
public class WeatherApiConsumer {
public static void main(String[] args) {
try {
// Create an ObjectMapper
ObjectMapper objectMapper = new ObjectMapper();
// Simulate an initial API response with just the basics
String initialApiResponse = "{\"city\":\"New York\",\"temperature\":72.5,\"humidity\":65}";
// Parse the response
WeatherData weatherData = objectMapper.readValue(initialApiResponse, WeatherData.class);
System.out.println("Initial weather data: " + weatherData);
// Now simulate the API adding new fields in a future version
String updatedApiResponse =
"{\"city\":\"New York\",\"temperature\":72.5,\"humidity\":65," +
"\"wind_speed\":10.2,\"pressure\":1013.25,\"forecast\":\"sunny\"}";
// Parse the updated response with the same object model
WeatherData updatedWeatherData = objectMapper.readValue(updatedApiResponse, WeatherData.class);
System.out.println("Updated weather data (with ignored fields): " + updatedWeatherData);
// Notice how our application continues to work without changes to our model
} catch (Exception e) {
System.out.println("Error occurred: " + e.getMessage());
}
}
}
- Скомпилируйте и запустите этот класс:
cd ~/project
mvn compile exec:java -Dexec.mainClass="com.labex.json.WeatherApiConsumer"
Вы должны увидеть вывод, похожий на следующий:
Initial weather data: WeatherData{city='New York', temperature=72.5, humidity=65}
Updated weather data (with ignored fields): WeatherData{city='New York', temperature=72.5, humidity=65}
Обратите внимание, как наше приложение продолжает работать с обновленным ответом API, даже если он содержит дополнительные поля, которые не определены в нашем классе WeatherData.
2. Обработка разных версий API
Другой распространенный сценарий — когда вам нужно поддерживать несколько версий API с одним и тем же клиентским кодом:
- Создайте новый файл по пути
~/project/src/main/java/com/labex/json/ApiVersionDemo.java
- Добавьте следующий код в файл:
package com.labex.json;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
public class ApiVersionDemo {
public static void main(String[] args) {
try {
// Create an ObjectMapper that ignores unknown properties
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// API v1 response
String apiV1Response = "{\"name\":\"John Doe\",\"age\":30}";
// API v2 response with additional fields
String apiV2Response =
"{\"name\":\"John Doe\",\"age\":30,\"email\":\"john.doe@example.com\"," +
"\"address\":\"123 Main St\",\"phone\":\"555-1234\"}";
// We can use the same Person class for both versions
System.out.println("Parsing API v1 response:");
Person personV1 = objectMapper.readValue(apiV1Response, Person.class);
System.out.println(personV1);
System.out.println("\nParsing API v2 response with the same class:");
Person personV2 = objectMapper.readValue(apiV2Response, Person.class);
System.out.println(personV2);
// Both work fine with our simple Person class
} catch (Exception e) {
System.out.println("Error occurred: " + e.getMessage());
}
}
}
- Скомпилируйте и запустите этот класс:
cd ~/project
mvn compile exec:java -Dexec.mainClass="com.labex.json.ApiVersionDemo"
Вы должны увидеть вывод, похожий на следующий:
Parsing API v1 response:
Person{name='John Doe', age=30}
Parsing API v2 response with the same class:
Person{name='John Doe', age=30}
Этот пример демонстрирует, как настройка ObjectMapper для игнорирования неизвестных свойств позволяет вам обрабатывать разные версии API с использованием одних и тех же Java-классов, делая ваш код более удобным в обслуживании и адаптируемым к изменениям.
