### 類別轉字串 (Object => String)
```java
import com.fasterxml.jackson.databind.ObjectMapper;
public class Example {
public static void main(String[] args) {
// 創建 ObjectMapper 實例
ObjectMapper objectMapper = new ObjectMapper();
// 創建一個 Java 對象
Person person = new Person("John", "Doe", 30);
try {
// 將 Java 對象轉換為 JSON 字串
String json = objectMapper.writeValueAsString(person);
System.out.println(json);
} catch (Exception e) {
e.printStackTrace();
}
}
}
@Data
@AllArgsConstructor
class Person {
private String firstName;
private String lastName;
private int age;
}
```
### 字串轉類別 (String => Object)
```java
import com.fasterxml.jackson.databind.ObjectMapper;
public class Main {
public static void main(String[] args) throws Exception {
String jsonString = "{\"name\":\"John\", \"age\":30}";
ObjectMapper objectMapper = new ObjectMapper();
MyClass myObject = objectMapper.readValue(jsonString, MyClass.class);
System.out.println(myObject.getName());
System.out.println(myObject.getAge());
}
}
class MyClass {
private String name;
private int age;
// getters and setters
}
```
### Map 轉換成對應的類別 (Map => Object)
```java
ObjectMapper objectMapper = new ObjectMapper();
Map<String, Object> map = new HashMap<>();
map.put("name", "John");
map.put("age", 25);
MyClass myClass = objectMapper.convertValue(map, MyClass.class);
```
### Object 轉成 Map
```java
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class JacksonObjectToMapExample {
public static void main(String[] args) {
// 創建 ObjectMapper 實例
ObjectMapper objectMapper = new ObjectMapper();
// 創建您的自定義對象
YourCustomObject customObject = new YourCustomObject();
customObject.setProperty1("value1");
customObject.setProperty2(2);
// 將對象轉換為 Map
Map<String, Object> map = objectMapper.convertValue(customObject, Map.class);
// 打印轉換後的 Map
System.out.println("Map: " + map);
}
}
```
---
使用 ObjectMapper 將物件轉換成 Json 格式時，欄位的順序會根據 Java 物件內部的屬性順序轉換成相對應的 Json Key，但是這個順序不是固定的，因為 Java 物件屬性在記憶體中的分配順序並不是固定的。
若需要控制 Json 輸出的順序，可以使用 @JsonPropertyOrder 或 @JsonPropertyIndex 來控制屬性的輸出順序，例如：
```java
@JsonPropertyOrder({ "name", "age", "email" })
public class User {
private String name;
private int age;
private String email;
// 省略 getter、setter 方法
}
```
```java
public class User {
@JsonProperty("name")
private String fullName;
@JsonProperty("email")
private String emailAddress;
// 其他屬性和方法...
}
```
### 物件 轉 MD5
```java
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.codec.digest.DigestUtils;
public class MD5Utils {
public static String calculateMD5(Object object) throws JsonProcessingException {
ObjectMapper objectMapper = new ObjectMapper();
String jsonString = objectMapper.writeValueAsString(object);
return DigestUtils.md5Hex(jsonString);
}
}
```
---
`@JsonIgnore` 是 Jackson 库中用來控制 JSON 序列化和反序列化過程中屬性忽略的注解。以下是 `@JsonIgnore` 的一些常見用法：
### 1. 忽略序列化和反序列化：
```java
public class MyClass {
private String name;
private int age;
// Getter and setter methods
@JsonIgnore
public int getAge() {
return age;
}
}
```
在這個例子中，`@JsonIgnore` 注解應用在 `getAge` 方法上，表示在 JSON 序列化和反序列化過程中，`age` 屬性將被忽略。
### 2. 忽略特定方向的序列化：
```java
public class MyClass {
private String name;
private int age;
// Getter methods
@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
private int secretCode;
// Getter and setter methods
}
```
在這個例子中，`@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)` 注解應用在 `secretCode` 屬性上，表示這個屬性只會在 JSON 反序列化時被使用，而在序列化時會被忽略。
### 3. 在字段上應用 `@JsonIgnore`：
```java
public class MyClass {
@JsonIgnore
private String sensitiveData;
// Getter and setter methods
}
```
你也可以將 `@JsonIgnore` 直接應用在屬性字段上，而不是 getter 方法。
### 4. 在嵌套對象上使用：
```java
public class MyParentClass {
private String parentProperty;
private MyChildClass child;
// Getter and setter methods
}
public class MyChildClass {
private String childProperty;
// Getter and setter methods
@JsonIgnore
public String getChildProperty() {
return childProperty;
}
}
```
在這個例子中，`@JsonIgnore` 注解應用在 `getChildProperty` 方法上，表示在 JSON 序列化和反序列化過程中，`childProperty` 將被忽略。
這僅是 `@JsonIgnore` 的一些用法範例，實際上還有其他一些使用方式，具體取決於你的需求。請注意，`@JsonIgnore` 主要用於控制 JSON 序列化和反序列化的行為。
### @JsonIgnoreProperties
在 Spring 中，若 JSON 回覆中包含未知的屬性，可以通過配置來忽略這些屬性。可以使用 @JsonIgnoreProperties 注解在需要忽略未知屬性的類上，如下所示：
```java
@JsonIgnoreProperties(ignoreUnknown = true)
public class MyResponse {
private String property1;
private String property2;
// 省略 getter 和 setter
}
```
這樣配置之後，當 JSON 回覆中含有未知屬性時，這些屬性將被忽略，不會映射到對應的屬性上。這樣可以確保應用程序在處理回覆時可以安全地忽略未知屬性，防止因為未知屬性導致錯誤的出現。
### @JsonInclude
@JsonInclude(JsonInclude.Include.NON_NULL) 的作用是告訴 Jackson 只序列化非空值的屬性，而忽略空值的屬性。
舉例來說，假設有以下的 Java 類別：
```java
public class User {
private String name;
private Integer age;
private String email;
// constructors, getters, setters
}
```
如果我們對 User 物件應用 @JsonInclude(JsonInclude.Include.NON_NULL)：
```java
@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
private String name;
private Integer age;
private String email;
// constructors, getters, setters
}
```
當序列化一個 User 物件時，只有 name、age 和 email 不是空值的屬性會被包含在序列化結果中，而空值的屬性會被忽略。這樣可以讓序列化後的 JSON 較為簡潔且清晰。
### 常見設定
```java
@Bean
public ObjectMapper objectMapper() {
ObjectMapper objectMapper = new ObjectMapper();
// 設定JavaTime模組，支援日期時間的序列化與反序列化
objectMapper.registerModule(new JavaTimeModule());
// 設定在反序列化時遇到未知屬性時不要拋出異常
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 設定序列化時忽略null值的屬性
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
// 回傳設定完成的ObjectMapper物件
return objectMapper;
}
```