【java】alibaba Fastjson --全解史上最快的JSON解析库

前序

JSON，全称：JavaScript Object Notation，作为一个常见的轻量级的数据交换格式，应该在一个程序员的开发生涯中是常接触的。简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

Java是面向对象的语言，所以我们更多的在项目中是以对象的形式处理业务的，但是在传输的时候我们却要将对象转换为 JSON 格式便于传输，而且 JSON 格式一般能解析为大多数的对象格式，而不在乎编程语言。

现在主流的对象与 JSON 互转的工具很多，我们主要介绍今天的主角，阿里巴巴的开源库 - Fastjson。Fastjson是一个Java库，可用于将Java对象转换为其JSON表示。它还可用于将JSON字符串转换为等效的Java对象。Fastjson可以处理任意Java对象，包括您没有源代码的预先存在的对象。

Fastjson 简介

Fastjson 是一个 Java 库，可以将 Java 对象转换为 JSON 格式，当然它也可以将 JSON 字符串转换为 Java 对象。
Fastjson 可以操作任何 Java 对象，即使是一些预先存在的没有源码的对象。

Fastjson 源码地址：https://github.com/alibaba/fastjson
Fastjson 中文 Wiki：https://github.com/alibaba/fastjson/wiki/Quick-Start-CN

Fastjson 的优点

速度快

fastjson相对其他JSON库的特点是快，从2011年fastjson发布1.1.x版本之后，其性能从未被其他Java实现的JSON库超越。

使用广泛

fastjson在阿里巴巴大规模使用，在数万台服务器上部署，fastjson在业界被广泛接受。在2012年被开源中国评选为最受欢迎的国产开源软件之一。

测试完备

fastjson有非常多的testcase，在1.2.11版本中，testcase超过3321个。每次发布都会进行回归测试，保证质量稳定。

使用简单

fastjson的 API 十分简洁。

功能完备

支持泛型，支持流处理超大文本，支持枚举，支持序列化和反序列化扩展。

下载和使用

你可以在 maven 中央仓库中直接下载：

https://repo1.maven.org/maven2/com/alibaba/fastjson/

或者配置 maven 依赖:

<dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>x.x.x</version>
</dependency>

其中 x.x.x 是版本号，根据需要使用特定版本，建议使用最新版本。

将 Java 对象转换为 JSON 格式

定义以下 Person JavaBean:

实例

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;}// 标准 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"}
]

@JSONField

@JSONField 的作用对象:

1. Field Setter 和 Getter 方法

注意：FastJson 在进行操作时，是根据 getter 和 setter 的方法进行的，并不是依据 Field 进行。

注意：若属性是私有的，必须有 set 方法。否则无法反序列化。

package com.alibaba.fastjson.annotation;public @interface JSONField {// 配置序列化和反序列化的顺序，1.1.42版本之后才支持int ordinal() default 0;// 指定字段的名称String name() default "";// 指定字段的格式，对日期格式有用String format() default "";// 是否序列化boolean serialize() default true;// 是否反序列化boolean deserialize() default true;
}

2. JSONField 配置方式
   FieldInfo 可以配置在 getter/setter 方法或者字段上。例如：
   2.1 配置在 getter/setter 上

public class A {private int id;@JSONField(name="ID")public int getId() {return id;}@JSONField(name="ID")public void setId(int value) {this.id = id;}
}

2.2 配置在 field 上

 public class A {@JSONField(name="ID")private int id;public int getId() {return id;}public void setId(int value) {this.id = id;}}

3. 使用format配置日期格式化

public class A {// 配置date序列化和反序列使用yyyyMMdd日期格式@JSONField(format="yyyyMMdd")public Date date;}

4. 使用 serialize/deserialize 指定字段不序列化

public class A {@JSONField(serialize=false)public Date date;}public class A {@JSONField(deserialize=false)public Date date;}

5. 使用 ordinal 指定字段的顺序
   默认 fastjson 序列化一个 java bean，是根据 fieldName 的字母序进行序列化的，你可以通过 ordinal 指定字段的顺序。这个特性需要 1.1.42 以上版本。

public static class VO {@JSONField(ordinal = 3)private int f0;@JSONField(ordinal = 2)private int f1;@JSONField(ordinal = 1)private int f2;
}

FastJson 还支持 BeanToArray 序列化功能：

String jsonOutput= JSON.toJSONString(listOfPersons, SerializerFeature.BeanToArray);

输出结果为：

[[15,1469003271063,"John Doe"],[20,1469003271063,"Janette Doe"]
]

创建 JSON 对象

创建 JSON 对象非常简单，只需使用 JSONObject（fastJson提供的json对象） 和 JSONArray（fastJson提供json数组对象） 对象即可。

我们可以把JSONObject 当成一个 Map<String,Object> 来看，只是 JSONObject 提供了更为丰富便捷的方法，方便我们对于对象属性的操作。我们看一下源码。

同样我们可以把 JSONArray 当做一个 List，可以把 JSONArray 看成 JSONObject 对象的一个集合。

此外，由于 JSONObject 和 JSONArray 继承了 JSON，所以说也可以直接使用两者对 JSON 格式字符串与 JSON 对象及 javaBean 之间做转换，不过为了避免混淆我们还是使用 JSON。

@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); // 如果我们设置系列化为 falseassertEquals(newPerson.getFullName(), listOfPersons.get(0).getFullName());
}

我们可以使用 JSON.parseObject() 将 JSON 字符串转换为 Java 对象。

注意反序列化时为对象时，必须要有默认无参的构造函数，否则会报异常:

com.alibaba.fastjson.JSONException: default constructor not found.

以下是简单的实例测试：

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]

使用 ContextValueFilter 配置 JSON 转换

在某些场景下，对Value做过滤，需要获得所属JavaBean的信息，包括类型、字段、方法等。在fastjson-1.2.9中，提供了ContextValueFilter，类似于之前版本提供的ValueFilter，只是多了BeanContext参数可用。

@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);
}

以上实例中我们隐藏了 DATE OF BIRTH 字段，并过滤名字不包含 John 的字段：

[{"FULL NAME":"JOHN DOE","DATE OF BIRTH":"NOT TO DISCLOSE"}
]

使用 NameFilter 和 SerializeConfig

NameFilter: 序列化时修改 Key。

SerializeConfig：内部是个map容器主要功能是配置并记录每种Java类型对应的序列化类。

@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"}
]

Fastjson 处理日期

Fastjson 处理日期的API很简单，例如：

JSON.toJSONStringWithDateFormat(date, "yyyy-MM-dd HH:mm:ss.SSS")

使用ISO-8601日期格式

JSON.toJSONString(obj, SerializerFeature.UseISO8601DateFormat);

全局修改日期格式

JSON.DEFFAULT_DATE_FORMAT = "yyyy-MM-dd";
JSON.toJSONString(obj, SerializerFeature.WriteDateUseDateFormat);

反序列化能够自动识别如下日期格式：

• ISO-8601日期格式
• yyyy-MM-dd
• yyyy-MM-dd HH:mm:ss
• yyyy-MM-dd HH:mm:ss.SSS
• 毫秒数字
• 毫秒数字字符串
• .NET JSON日期格式
• new Date(198293238)

虽然上面处理了单个的日期类型和全局的日期类型格式的配置，但是有时候我们需要的是对象中个别的日期类型差异化，并不一定是同一种格式的。那如何处理呢？接下来介绍 Fastjson 的定制序列化。

Fastjson 的性能

fastjson是目前java语言中最快的json库，比自称最快的jackson速度还要快，第三方独立测试结果看这里：https://github.com/eishay/jvm-serializers/wiki。

自行做性能测试时，需关闭循环引用检测的功能。

JSON.toJSONString(obj, SerializerFeature.DisableCircularReferenceDetect)
VO vo = JSON.parseObject("...", VO.class, Feature.DisableCircularReferenceDetect)

另外，Fastjson 比 Gson 快大约6倍，测试结果可以看这里：

Checking correctness…
[done]
Pre-warmup… java-built-in hessian kryo protostuff-runtime avro-generic msgpack json/jackson/databind json/jackson/databind-strings json/jackson/db-afterburner json/google-gson/databind json/svenson-databind json/flexjson/databind json/fastjson/databind smile/jackson/databind smile/jackson/db-afterburner smile/protostuff-runtime bson/jackson/databind xml/xstream+c xml/jackson/databind-aalto
[done]
pre. create ser deser shal +deep total size +dfl
java-built-in 63 5523 27765 28084 28162 33686 889 514
hessian 64 3776 6459 6505 6690 10466 501 313
kryo 63 809 962 937 1001 1810 214 133
protostuff-runtime 62 671 903 920 957 1627 241 151
avro-generic 436 1234 1122 1416 1760 2994 221 133
msgpack 61 789 1369 1385 1449 2238 233 146
json/jackson/databind 60 1772 3089 3113 3246 5018 485 261
json/jackson/databind-strings 64 2346 3739 3791 3921 6267 485 261
json/jackson/db-afterburner 64 1482 2220 2233 2323 3805 485 261
json/google-gson/databind 64 7076 4894 4962 5000 12076 486 259
json/svenson-databind 64 5422 12387 12569 12468 17890 495 266
json/flexjson/databind 62 20923 26853 26873 27272 48195 503 273
json/fastjson/databind 63 1250 1208 1206 1247 2497 486 262
smile/jackson/databind 60 1697 2117 2290 2298 3996 338 241
smile/jackson/db-afterburner 60 1300 1614 1648 1703 3003 352 252
smile/protostuff-runtime 61 1275 1612 1638 1685 2961 335 235
bson/jackson/databind 63 5151 6729 6977 6918 12069 506 286
xml/xstreamc 62 6358 13208 13319 13516 19874 487 244
xml/jackson/databind-aalto 62 2955 5332 5465 5584 8539 683 286

总结Fastjson 主要的API

Fastjson入口类是 com.alibaba.fastjson.JSON，主要的 API 是 JSON.toJSONString 和 parseObject。

package com.alibaba.fastjson;
public abstract class JSON {// Java对象转换为JSON字符串public static final String toJSONString(Object object);//JSON字符串转换为Java对象public static final <T> T parseObject(String text, Class<T> clazz, Feature... features);
}

序列化：

String jsonString = JSON.toJSONString(obj);

反序列化：

VO vo = JSON.parseObject("...", VO.class);

泛型反序列化：

import com.alibaba.fastjson.TypeReference;List<VO> list = JSON.parseObject("...", new TypeReference<List<VO>>() {});