Jackson 詳解

前言

????????Jackson 是 Java 生態中最流行的 JSON 處理庫之一，廣泛應用于 RESTful API、數據存儲和傳輸等場景。它提供了高效、靈活的 JSON 序列化和反序列化功能，支持注解、模塊化設計和多種數據格式（如 XML、YAML）。本文將詳細介紹 Jackson 的核心模塊、使用方法、注意事項以及代碼示例。

1. Jackson 的核心模塊

2. 使用 Jackson

2.1 添加依賴

2.2 核心類：ObjectMapper

2.3 基本使用

序列化

反序列化:

3. 使用注解

3.1 常用注解

3.2 示例代碼

4. 高級用法

4.1 處理復雜對象

4.2 自定義序列化和反序列化

4.3 處理多態類型

5. 注意事項

6. 總結

前言

????????Jackson 是 Java 生態中最流行的 JSON 處理庫之一，廣泛應用于 RESTful API、數據存儲和傳輸等場景。它提供了高效、靈活的 JSON 序列化和反序列化功能，支持注解、模塊化設計和多種數據格式（如 XML、YAML）。本文將詳細介紹 Jackson 的核心模塊、使用方法、注意事項以及代碼示例。

1. Jackson 的核心模塊

Jackson 采用模塊化設計，核心模塊包括：

jackson-core：
- 提供底層 JSON 解析和生成功能。
- 包含?JsonParser（解析 JSON）和?JsonGenerator（生成 JSON）。
jackson-annotations：
- 提供豐富的注解，用于控制 JSON 的序列化和反序列化行為。
jackson-databind：
- 提供高級數據綁定功能，將 JSON 數據與 Java 對象相互轉換。
jackson-dataformat-xml：
- 支持 XML 格式的序列化和反序列化。
jackson-dataformat-yaml：
- 支持 YAML 格式的序列化和反序列化。

2. 使用 Jackson

2.1 添加依賴

在 Maven 項目中，添加以下依賴：

<dependencies><!-- Jackson 核心模塊 --><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-core</artifactId><version>2.13.3</version></dependency><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-annotations</artifactId><version>2.13.3</version></dependency><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.13.3</version></dependency><!-- 可選：支持 XML --><dependency><groupId>com.fasterxml.jackson.dataformat</groupId><artifactId>jackson-dataformat-xml</artifactId><version>2.13.3</version></dependency><!-- 可選：支持 YAML --><dependency><groupId>com.fasterxml.jackson.dataformat</groupId><artifactId>jackson-dataformat-yaml</artifactId><version>2.13.3</version></dependency>
</dependencies>

2.2 核心類：`ObjectMapper`

ObjectMapper 是 Jackson 的核心類，用于實現 JSON 與 Java 對象的相互轉換。以下是其常用方法：

方法	描述
`writeValueAsString(Object)`	將 Java 對象序列化為 JSON 字符串。
`readValue(String, Class)`	將 JSON 字符串反序列化為 Java 對象。
`writeValue(File, Object)`	將 Java 對象序列化到文件中。
`readValue(File, Class)`	從文件中反序列化 JSON 數據。

2.3 基本使用

序列化

import com.fasterxml.jackson.databind.ObjectMapper;
public class Main {public static void main(String[] args) throws Exception {User user = new User("John", 30);ObjectMapper mapper = new ObjectMapper();String json = mapper.writeValueAsString(user);System.out.println(json); // 輸出: {"name":"John","age":30}}
}
class User {private String name;private int age;// 構造函數、Getter 和 Setterpublic User(String name, int age) {this.name = name;this.age = age;}public String getName() { return name; }public void setName(String name) { this.name = name; }public int getAge() { return age; }public void setAge(int age) { this.age = age; }
}

反序列化:

import com.fasterxml.jackson.databind.ObjectMapper;
public class Main {public static void main(String[] args) throws Exception {String json = "{\"name\":\"John\",\"age\":30}";ObjectMapper mapper = new ObjectMapper();User user = mapper.readValue(json, User.class);System.out.println(user.getName()); // 輸出: JohnSystem.out.println(user.getAge());  // 輸出: 30}
}

3. 使用注解

Jackson 提供了豐富的注解，用于控制 JSON 的序列化和反序列化行為。

3.1 常用注解

注解	描述
`@JsonProperty`	指定 JSON 字段的名稱。
`@JsonIgnore`	忽略字段，不參與序列化和反序列化。
`@JsonFormat`	指定日期、時間等字段的格式化方式。
`@JsonInclude`	控制字段在序列化時的包含規則（如非空字段才序列化）。
`@JsonCreator`	指定反序列化時的構造函數或工廠方法。
`@JsonAlias`	為字段指定多個 JSON 別名，反序列化時可以匹配多個名稱。

3.2 示例代碼

import com.fasterxml.jackson.annotation.*;
public class User {@JsonProperty("user_name")private String name;@JsonIgnoreprivate String password;@JsonFormat(pattern = "yyyy-MM-dd")private Date birthDate;@JsonInclude(JsonInclude.Include.NON_NULL)private String email;// 構造函數、Getter 和 Setter
}

4. 高級用法

4.1 處理復雜對象

Jackson 支持嵌套對象、集合和映射的序列化和反序列化。

class Address {private String city;private String street;// 構造函數、Getter 和 Setter
}
class User {private String name;private List<Address> addresses;// 構造函數、Getter 和 Setter
}

4.2 自定義序列化和反序列化

通過實現 JsonSerializer 和 JsonDeserializer，可以自定義序列化和反序列化邏輯。

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.io.IOException;
@JsonSerialize(using = CustomSerializer.class)
class User {private String name;// 構造函數、Getter 和 Setter
}
class CustomSerializer extends JsonSerializer<User> {@Overridepublic void serialize(User user, JsonGenerator gen, SerializerProvider serializers) throws IOException {gen.writeStartObject();gen.writeStringField("user_name", user.getName());gen.writeEndObject();}
}

4.3 處理多態類型

使用 @JsonTypeInfo 和 @JsonSubTypes 處理多態類型。

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({@JsonSubTypes.Type(value = Dog.class, name = "dog"),@JsonSubTypes.Type(value = Cat.class, name = "cat")
})
abstract class Animal {private String name;// 構造函數、Getter 和 Setter
}
class Dog extends Animal {private String breed;// 構造函數、Getter 和 Setter
}
class Cat extends Animal {private boolean likesCream;// 構造函數、Getter 和 Setter
}

5. 注意事項

性能優化：
- 重用?ObjectMapper?實例，避免重復創建。
安全性：
- 反序列化時，避免直接反序列化不可信的 JSON 數據，防止反序列化攻擊。
版本兼容性：
- 確保?jackson-core、jackson-annotations?和?jackson-databind?的版本一致。
空值處理：
- 使用?@JsonInclude(JsonInclude.Include.NON_NULL)?忽略空值字段。

補充：

1. JSON處理庫的作用

1.1 Fastjson

Fastjson是阿里巴巴開源的高性能JSON庫，主要用于Java對象與JSON字符串之間的序列化和反序列化。它支持復雜對象的處理，包括嵌套對象、泛型、集合等，廣泛應用于高性能場景。

1.2 org.json

org.json是一個輕量級的JSON處理庫，提供了JSON的解析、生成和操作功能。它的API設計簡單，適合初學者和快速開發場景。

1.3 json-simple

json-simple是一個簡單的JSON處理庫，專注于基本的JSON解析和生成。它的API設計非常簡潔，適合快速處理簡單的JSON數據。

2. 技術原理

2.1 Fastjson

Fastjson的核心技術包括：

高性能解析：通過優化算法和數據結構，Fastjson在解析JSON時速度非常快。
動態類型處理：支持復雜對象的序列化和反序列化，包括泛型、嵌套對象等。
自定義序列化：允許開發者通過注解或自定義序列化器控制JSON的生成和解析。

2.2 org.json

org.json的核心技術包括：

輕量級設計：庫的體積較小，適合資源有限的環境。
簡單API：提供了JSONObject和JSONArray等核心類，易于上手。
功能齊全：支持JSON的解析、生成和操作。

2.3 json-simple

json-simple的核心技術包括：

簡潔API：提供了JSONObject和JSONArray等核心類，API設計非常簡潔。
輕量級設計：庫的體積較小，適合快速開發場景。
基礎功能：支持基本的JSON解析和生成。

3. 示例代碼與輸出結果

3.1 Fastjson示例

代碼：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;public class FastjsonExample {public static void main(String[] args) {// 將Java對象轉換為JSON字符串User user = new User("John", 30);String jsonString = JSON.toJSONString(user);System.out.println("Fastjson - JSON String: " + jsonString);// 將JSON字符串轉換為Java對象User parsedUser = JSON.parseObject(jsonString, User.class);System.out.println("Fastjson - Parsed User: " + parsedUser);// 操作JSON對象JSONObject jsonObject = JSON.parseObject(jsonString);jsonObject.put("age", 31);System.out.println("Fastjson - Updated JSON: " + jsonObject.toJSONString());}
}class User {private String name;private int age;public User(String name, int age) {this.name = name;this.age = age;}// Getters and Setters@Overridepublic String toString() {return "User{name='" + name + "', age=" + age + "}";}
}

?輸出結果：

Fastjson - JSON String: {"age":30,"name":"John"}
Fastjson - Parsed User: User{name='John', age=30}
Fastjson - Updated JSON: {"age":31,"name":"John"}

3.2 org.json示例

代碼：

import org.json.JSONObject;public class OrgJsonExample {public static void main(String[] args) {// 創建JSON對象JSONObject jsonObject = new JSONObject();jsonObject.put("name", "John");jsonObject.put("age", 30);System.out.println("org.json - JSON Object: " + jsonObject);// 從JSON字符串解析JSON對象String jsonString = "{\"name\":\"John\",\"age\":30}";JSONObject parsedJsonObject = new JSONObject(jsonString);System.out.println("org.json - Parsed JSON Object: " + parsedJsonObject);// 操作JSON對象parsedJsonObject.put("age", 31);System.out.println("org.json - Updated JSON Object: " + parsedJsonObject);}
}

?輸出結果：

org.json - JSON Object: {"name":"John","age":30}
org.json - Parsed JSON Object: {"name":"John","age":30}
org.json - Updated JSON Object: {"name":"John","age":31}

3.3 json-simple示例

代碼：

import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;public class JsonSimpleExample {public static void main(String[] args) throws Exception {// 創建JSON對象JSONObject jsonObject = new JSONObject();jsonObject.put("name", "John");jsonObject.put("age", 30);System.out.println("json-simple - JSON Object: " + jsonObject.toJSONString());// 從JSON字符串解析JSON對象String jsonString = "{\"name\":\"John\",\"age\":30}";JSONParser parser = new JSONParser();JSONObject parsedJsonObject = (JSONObject) parser.parse(jsonString);System.out.println("json-simple - Parsed JSON Object: " + parsedJsonObject);// 操作JSON對象parsedJsonObject.put("age", 31);System.out.println("json-simple - Updated JSON Object: " + parsedJsonObject.toJSONString());}
}

輸出結果：

json-simple - JSON Object: {"name":"John","age":30}
json-simple - Parsed JSON Object: {"name":"John","age":30}
json-simple - Updated JSON Object: {"name":"John","age":31}

4. 對比與總結

特性	Fastjson	org.json	json-simple
性能	高性能，適合大數據量處理	性能一般	性能一般
功能性	功能強大，支持復雜對象	功能齊全	功能基礎
易用性	API設計簡單，易于上手	API設計簡單，適合初學者	API設計簡潔，快速上手
體積	較大	較小	較小