1. 概述
FastJson 是一套輕量級的 Java 庫，用於有效地將 JSON 字符串轉換為 Java 對象，以及將 Java 對象轉換為 JSON 字符串。
在本文中，我們將深入探討 FastJson 庫的各種實際應用。
2. Maven 配置
為了開始使用 FastJson，我們首先需要在我們的 pom.xml 中添加它：
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.13</version>
</dependency>
此外，請注意：這裏是 Maven Central 上的最新版本。
3. 將 Java 對象轉換為 JSON 格式
讓我們定義以下 Person Java Bean:
public class Person {
@JSONField(name = "AGE")
private int age;
@JSONField(name = "FULL NAME")
private String fullName;
@JSONField(name = "DATE OF BIRTH")
private Date dateOfBirth;
public Person(int age, String fullName, Date dateOfBirth) {
super();
this.age = age;
this.fullName= fullName;
this.dateOfBirth = dateOfBirth;
}
// standard getters & setters
}我們可以使用 JSON.toJSONString() 將一個 Java 對象轉換為 JSON 字符串：
private List<Person> listOfPersons = new ArrayList<Person>();
@Before
public void setUp() {
listOfPersons.add(new Person(15, "John Doe", new Date()));
listOfPersons.add(new Person(20, "Janette Doe", new Date()));
}
@Test
public void whenJavaList_thanConvertToJsonCorrect() {
String jsonOutput= JSON.toJSONString(listOfPersons);
}以下是結果:
[
{
"AGE":15,
"DATE OF BIRTH":1468962431394,
"FULL NAME":"John Doe"
},
{
"AGE":20,
"DATE OF BIRTH":1468962431394,
"FULL NAME":"Janette Doe"
}
]我們還可以進一步定製輸出，並控制諸如排序、日期格式或序列化標誌等內容。
例如 – 讓我們更新 Bean 並添加幾個更多字段：
@JSONField(name="AGE", serialize=false)
private int age;
@JSONField(name="LAST NAME", ordinal = 2)
private String lastName;
@JSONField(name="FIRST NAME", ordinal = 1)
private String firstName;
@JSONField(name="DATE OF BIRTH", format="dd/MM/yyyy", ordinal = 3)
private Date dateOfBirth;以下是我們可以與 @JSONField 註解一起使用的最基本參數列表，以便自定義轉換過程：
- 參數 format 用於正確格式化 date 屬性
- 默認情況下，FastJson 庫會完全序列化 Java Bean，但可以使用參數 serialize 來忽略特定字段的序列化
- 參數 ordinal 用於指定字段順序
以下是新的輸出：
[
{
"FIRST NAME":"Doe",
"LAST NAME":"Jhon",
"DATE OF BIRTH":"19/07/2016"
},
{
"FIRST NAME":"Doe",
"LAST NAME":"Janette",
"DATE OF BIRTH":"19/07/2016"
}
]FastJson 還支持一個非常有趣的 BeanToArray 序列化功能：
String jsonOutput= JSON.toJSONString(listOfPersons, SerializerFeature.BeanToArray);下面是這種情況下的輸出效果:
[
[
15,
1469003271063,
"John Doe"
],
[
20,
1469003271063,
"Janette Doe"
]
]4. 創建 JSON 對象
與其它 JSON 庫類似，從頭創建一個 JSON 對象非常簡單，只需將 <em>JSONObject</em> 和 <em><strong>JSONArray</strong> </em> 對象組合起來即可：
@Test
public void whenGenerateJson_thanGenerationCorrect() throws ParseException {
JSONArray jsonArray = new JSONArray();
for (int i = 0; i < 2; i++) {
JSONObject jsonObject = new JSONObject();
jsonObject.put("AGE", 10);
jsonObject.put("FULL NAME", "Doe " + i);
jsonObject.put("DATE OF BIRTH", "2016/12/12 12:12:12");
jsonArray.add(jsonObject);
}
String jsonOutput = jsonArray.toJSONString();
}以下是輸出結果的樣子：
[
{
"AGE":"10",
"DATE OF BIRTH":"2016/12/12 12:12:12",
"FULL NAME":"Doe 0"
},
{
"AGE":"10",
"DATE OF BIRTH":"2016/12/12 12:12:12",
"FULL NAME":"Doe 1"
}
]解析 JSON 字符串為 Java 對象
現在我們知道如何從頭創建一個 JSON 對象，以及如何將 Java 對象轉換為它們的 JSON 表示形式，現在讓我們將重點放在如何解析 JSON 表示形式上：
@Test
public void whenJson_thanConvertToObjectCorrect() {
Person person = new Person(20, "John", "Doe", new Date());
String jsonObject = JSON.toJSONString(person);
Person newPerson = JSON.parseObject(jsonObject, Person.class);
assertEquals(newPerson.getAge(), 0); // if we set serialize to false
assertEquals(newPerson.getFullName(), listOfPersons.get(0).getFullName());
}我們可以使用 JSON.parseObject() 從 JSON 字符串中獲取 Java 對象。
請注意，如果已經聲明瞭帶有參數的構造函數，則必須定義 無參數或默認構造函數，否則將會拋出 com.alibaba.fastjson.JSONException。
以下是此簡單測試的輸出：
Person [age=20, fullName=John Doe, dateOfBirth=Wed Jul 20 08:51:12 WEST 2016]通過在 @JSONField 註解中啓用 deserialize 選項，我們可以忽略特定字段的序列化，在這種情況下，默認值將自動應用於忽略的字段：
@JSONField(name = "DATE OF BIRTH", deserialize=false)
private Date dateOfBirth;以下是新創建的對象：
Person [age=20, fullName=John Doe, dateOfBirth=null]6. 使用 ContextValueFilter 對象配置 JSON 轉換
在某些場景下，我們需要對 Java 對象轉換為 JSON 格式的過程擁有 更多控制。
在這種情況下，我們可以利用 ContextValueFilter 對象來為轉換流程應用額外的過濾和自定義處理：
@Test
public void givenContextFilter_whenJavaObject_thanJsonCorrect() {
ContextValueFilter valueFilter = new ContextValueFilter () {
public Object process(
BeanContext context, Object object, String name, Object value) {
if (name.equals("DATE OF BIRTH")) {
return "NOT TO DISCLOSE";
}
if (value.equals("John")) {
return ((String) value).toUpperCase();
} else {
return null;
}
}
};
String jsonOutput = JSON.toJSONString(listOfPersons, valueFilter);
}在此示例中，我們隱藏了 出生日期 字段，通過強制指定一個常量值，同時忽略所有非 John 或 Doe 的字段：
[
{
"FULL NAME":"JOHN DOE",
"DATE OF BIRTH":"NOT TO DISCLOSE"
}
]正如您所見，這是一個相當基礎的示例，但您當然可以使用相同的概念來處理更復雜的場景——將 FastJson 提供的這些強大且輕量級的工具組合用於實際項目。
7. 使用 NameFilter 和 SerializeConfig
FastJson 提供了一套工具，用於自定義您處理任意對象（我們不擁有這些對象的源代碼）時的 JSON 操作。
假設我們有一個編譯後的 Person Java Bean，該 Bean 在本文中首次聲明，並且我們需要對字段命名和基本格式進行增強：
@Test
public void givenSerializeConfig_whenJavaObject_thanJsonCorrect() {
NameFilter formatName = new NameFilter() {
public String process(Object object, String name, Object value) {
return name.toLowerCase().replace(" ", "_");
}
};
SerializeConfig.getGlobalInstance().addFilter(Person.class, formatName);
String jsonOutput =
JSON.toJSONStringWithDateFormat(listOfPersons, "yyyy-MM-dd");
}我們使用 formatName 過濾器，並利用 NameFilter 匿名類來處理字段名稱。新創建的過濾器與 Person 類關聯，然後添加到全局實例——這本質上是 SerializeConfig 類中的靜態屬性。
現在，我們可以像之前文章中所示一樣，輕鬆地將我們的對象轉換為 JSON 格式。
請注意，我們使用了 toJSONStringWithDateFormat() 而不是 toJSONString()，以便快速地將日期字段應用相同的格式規則。
以下是輸出：
[
{
"full_name":"John Doe",
"date_of_birth":"2016-07-21"
},
{
"full_name":"Janette Doe",
"date_of_birth":"2016-07-21"
}
]如您所見 – 字段名稱已更改，並且日期值已正確格式化。
將 SerializeFilter 與 ContextValueFilter 結合使用，可以對任意和複雜的 Java 對象進行轉換過程獲得完全控制。
8. 結論在本文中，我們展示瞭如何使用 FastJson 將 Java Bean 轉換為 JSON 字符串，以及反之。我們還展示瞭如何使用 FastJson 的一些 核心功能，以自定義 JSON 輸出。
如你所見，該庫提供了一個相對簡單但仍然非常強大的 API。 JSON.toJSONString 和 JSON.parseObject 幾乎可以滿足你大部分需求——如果不是全部。
