alibaba Fastjson的JOSN解析库 -
JSON，全稱：JavaScript Object Notation，作為一個常見的輕量級的數(shù)據(jù)交換格式，應(yīng)該在一個程序員的開發(fā)生涯中是常接觸的。簡潔和清晰的層次結(jié)構(gòu)使得 JSON 成為理想的數(shù)據(jù)交換語言。 易于人閱讀和編寫，同時也易于機(jī)器解析和生成，并有效地提升網(wǎng)絡(luò)傳輸效率。
Java是面向?qū)ο蟮恼Z言，所以我們更多的在項目中是以對象的形式處理業(yè)務(wù)的，但是在傳輸?shù)臅r候我們卻要將對象轉(zhuǎn)換為 JSON 格式便于傳輸，而且 JSON 格式一般能解析為大多數(shù)的對象格式，而不在乎編程語言。
現(xiàn)在主流的對象與 JSON 互轉(zhuǎn)的工具很多，我們主要介紹今天的主角，阿里巴巴的開源庫 - Fastjson。Fastjson是一個Java庫，可用于將Java對象轉(zhuǎn)換為其JSON表示。它還可用于將JSON字符串轉(zhuǎn)換為等效的Java對象。Fastjson可以處理任意Java對象，包括您沒有源代碼的預(yù)先存在的對象。
1|0什么是 Fastjson?
?
阿里官方給的定義是， fastjson 是阿里巴巴的開源JSON解析庫，它可以解析 JSON 格式的字符串，支持將 Java Bean 序列化為 JSON 字符串，也可以從 JSON 字符串反序列化到 JavaBean。
2|0Fastjson 的優(yōu)點
?
- 速度快
fastjson相對其他JSON庫的特點是快，從2011年fastjson發(fā)布1.1.x版本之后，其性能從未被其他Java實現(xiàn)的JSON庫超越。 - 使用廣泛
fastjson在阿里巴巴大規(guī)模使用，在數(shù)萬臺服務(wù)器上部署，fastjson在業(yè)界被廣泛接受。在2012年被開源中國評選為最受歡迎的國產(chǎn)開源軟件之一。 - 測試完備
fastjson有非常多的testcase，在1.2.11版本中，testcase超過3321個。每次發(fā)布都會進(jìn)行回歸測試，保證質(zhì)量穩(wěn)定。 - 使用簡單
fastjson的 API 十分簡潔。 - 功能完備
支持泛型，支持流處理超大文本，支持枚舉，支持序列化和反序列化擴(kuò)展。
3|0怎么獲得 Fastjson
?
你可以通過如下地方下載fastjson:
- maven中央倉庫: http://central.maven.org/maven2/com/alibaba/fastjson/
- Sourceforge.net : https://sourceforge.net/projects/fastjson/files/
- 在maven項目的pom文件中直接配置fastjson依賴
fastjson最新版本都會發(fā)布到maven中央倉庫，你可以直接依賴。
<dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>x.x.x</version> </dependency>其中x.x.x是版本號，根據(jù)需要使用特定版本，建議使用最新版本。
4|0Fastjson 主要的API
?
Fastjson入口類是 com.alibaba.fastjson.JSON，主要的 API 是 JSON.toJSONString 和 parseObject。
package com.alibaba.fastjson; public abstract class JSON {// Java對象轉(zhuǎn)換為JSON字符串public static final String toJSONString(Object object);//JSON字符串轉(zhuǎn)換為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>>() {});5|0Fastjson 的性能
?
fastjson是目前java語言中最快的json庫，比自稱最快的jackson速度還要快，第三方獨立測試結(jié)果看這里：https://github.com/eishay/jvm-serializers/wiki。
自行做性能測試時，需關(guān)閉循環(huán)引用檢測的功能。
JSON.toJSONString(obj, SerializerFeature.DisableCircularReferenceDetect) VO vo = JSON.parseObject("...", VO.class, Feature.DisableCircularReferenceDetect)另外，Fastjson 比 Gson 快大約6倍，測試結(jié)果可以看這里：
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 2866|0Fastjson 使用示例
?
我們創(chuàng)建一個班級的對象，和一個學(xué)生對象如下：
班級對象
public class Grade {private Long id;private String name;private List<Student> users = new ArrayList<Student>();// 省略 setter、getterpublic void addStudent(Student student) {users.add(student);}@Overridepublic String toString() {return "Grade{" +"id=" + id +", name='" + name + '\'' +", users=" + users +'}';} }學(xué)生對象
public class Student {private Long id;private String name;// 省略 setter、getter@Overridepublic String toString() {return "Student{" +"id=" + id +", name='" + name + '\'' +'}';} }運行的 Main 函數(shù)
public class MainTest {public static void main(String[] args) {Grade group = new Grade();group.setId(0L);group.setName("admin");Student student = new Student();student.setId(2L);student.setName("guest");Student rootUser = new Student();rootUser.setId(3L);rootUser.setName("root");group.addStudent(student);group.addStudent(rootUser);// 轉(zhuǎn)換為 JSONString jsonString = JSON.toJSONString(group);System.out.println("JSON字符串：" + jsonString);// 轉(zhuǎn)換為 對象BEANGrade grade = JSON.parseObject(jsonString, Grade.class);System.out.println("JavaBean對象：" + grade);} }最后的運行結(jié)果如下：
JSON字符串： {"id":0,"name":"admin","users":[{"id":2,"name":"guest"},{"id":3,"name":"root"}]}JavaBean對象： Grade{id=0, name='admin', users=[Student{id=2, name='guest'}, Student{id=3, name='root'}]}7|0將對象中的空值輸出
?
在fastjson中，缺省是不輸出空值的。無論Map中的null和對象屬性中的null，序列化的時候都會被忽略不輸出，這樣會減少產(chǎn)生文本的大小。但如果需要輸出空值怎么做呢？
如果你需要輸出空值，需要使用 SerializerFeature.WriteMapNullValue
Model obj = ...; JSON.toJSONString(obj, SerializerFeature.WriteMapNullValue);幾種空值特別處理方式：
| WriteNullListAsEmpty | 將Collection類型字段的字段空值輸出為[] |
| WriteNullStringAsEmpty | 將字符串類型字段的空值輸出為空字符串 "" |
| WriteNullNumberAsZero | 將數(shù)值類型字段的空值輸出為0 |
| WriteNullBooleanAsFalse | 將Boolean類型字段的空值輸出為false |
具體的示例參考如下，可以同時選擇多個：
class Model {public List<Objec> items; }Model obj = ....;String text = JSON.toJSONString(obj, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullListAsEmpty);8|0Fastjson 處理日期
?
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
- 毫秒數(shù)字
- 毫秒數(shù)字字符串
- .NET JSON日期格式
- new Date(198293238)
雖然上面處理了單個的日期類型和全局的日期類型格式的配置，但是有時候我們需要的是對象中個別的日期類型差異化，并不一定是同一種格式的。那如何處理呢？接下來介紹 Fastjson 的定制序列化。
9|0Fastjson 定制序列化
?
9|1簡介
?
fastjson支持多種方式定制序列化。
- 通過@JSONField定制序列化
- 通過@JSONType定制序列化
- 通過SerializeFilter定制序列化
- 通過ParseProcess定制反序列化
9|2使用@JSONField配置
?
1、JSONField 注解介紹
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配置方式
可以把@JSONField配置在字段或者getter/setter方法上，例如：
配置在字段上
public class VO {@JSONField(name="ID")private int id;@JSONField(name="birthday",format="yyyy-MM-dd")public Date date; }配置在 Getter/Setter 上
public class VO {private int id;@JSONField(name="ID")public int getId() { return id;}@JSONField(name="ID")public void setId(int id) {this.id = id;} }注意：若屬性是私有的，必須有set*方法。否則無法反序列化。
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，是根據(jù)fieldName的字母序進(jìn)行序列化的，你可以通過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; }6、使用serializeUsing制定屬性的序列化類
在fastjson 1.2.16版本之后，JSONField支持新的定制化配置serializeUsing，可以單獨對某一個類的某個屬性定制序列化，比如：
public static class Model {@JSONField(serializeUsing = ModelValueSerializer.class)public int value; }public static class ModelValueSerializer implements ObjectSerializer {@Overridepublic void write(JSONSerializer serializer, Object object, Object fieldName, Type fieldType,int features) throws IOException {Integer value = (Integer) object;String text = value + "元";serializer.write(text);} }測試代碼
Model model = new Model(); model.value = 100; String json = JSON.toJSONString(model); Assert.assertEquals("{\"value\":\"100元\"}", json);9|3使用@JSONType配置
?
和JSONField類似，但JSONType配置在類上，而不是field或者getter/setter方法上。
9|4通過SerializeFilter定制序列化
?
1、簡介
SerializeFilter是通過編程擴(kuò)展的方式定制序列化。fastjson支持6種SerializeFilter，用于不同場景的定制序列化。
- PropertyPreFilter 根據(jù)PropertyName判斷是否序列化
- PropertyFilter 根據(jù)PropertyName和PropertyValue來判斷是否序列化
- NameFilter 修改Key，如果需要修改Key,process返回值則可
- ValueFilter 修改Value
- BeforeFilter 序列化時在最前添加內(nèi)容
- AfterFilter 序列化時在最后添加內(nèi)容
2、PropertyFilter 根據(jù)PropertyName和PropertyValue來判斷是否序列化
public interface PropertyFilter extends SerializeFilter {boolean apply(Object object, String propertyName, Object propertyValue);}可以通過擴(kuò)展實現(xiàn)根據(jù)object或者屬性名稱或者屬性值進(jìn)行判斷是否需要序列化。例如：
PropertyFilter filter = new PropertyFilter() {public boolean apply(Object source, String name, Object value) {if ("id".equals(name)) {int id = ((Integer) value).intValue();return id >= 100;}return false;} };JSON.toJSONString(obj, filter); // 序列化的時候傳入filter3、PropertyPreFilter 根據(jù)PropertyName判斷是否序列化
和PropertyFilter不同只根據(jù)object和name進(jìn)行判斷，在調(diào)用getter之前，這樣避免了getter調(diào)用可能存在的異常。
public interface PropertyPreFilter extends SerializeFilter {boolean apply(JSONSerializer serializer, Object object, String name);}4、NameFilter 序列化時修改Key
如果需要修改Key,process返回值則可
public interface NameFilter extends SerializeFilter {String process(Object object, String propertyName, Object propertyValue); }fastjson內(nèi)置一個PascalNameFilter，用于輸出將首字符大寫的Pascal風(fēng)格。 例如：
import com.alibaba.fastjson.serializer.PascalNameFilter;Object obj = ...; String jsonStr = JSON.toJSONString(obj, new PascalNameFilter());5、ValueFilter 序列化時修改Value
public interface ValueFilter extends SerializeFilter {Object process(Object object, String propertyName, Object propertyValue); }6、BeforeFilter 序列化時在最前添加內(nèi)容
在序列化對象的所有屬性之前執(zhí)行某些操作,例如調(diào)用 writeKeyValue 添加內(nèi)容
public abstract class BeforeFilter implements SerializeFilter {protected final void writeKeyValue(String key, Object value) { ... }// 需要實現(xiàn)的抽象方法，在實現(xiàn)中調(diào)用writeKeyValue添加內(nèi)容public abstract void writeBefore(Object object); }7、AfterFilter 序列化時在最后添加內(nèi)容
在序列化對象的所有屬性之后執(zhí)行某些操作,例如調(diào)用 writeKeyValue 添加內(nèi)容
public abstract class AfterFilter implements SerializeFilter {protected final void writeKeyValue(String key, Object value) { ... }// 需要實現(xiàn)的抽象方法，在實現(xiàn)中調(diào)用writeKeyValue添加內(nèi)容public abstract void writeAfter(Object object); }9|5通過ParseProcess定制反序列化
?
1、簡介
ParseProcess是編程擴(kuò)展定制反序列化的接口。fastjson支持如下ParseProcess：
- ExtraProcessor 用于處理多余的字段
- ExtraTypeProvider 用于處理多余字段時提供類型信息
2、使用ExtraProcessor 處理多余字段
public static class VO {private int id;private Map<String, Object> attributes = new HashMap<String, Object>();public int getId() { return id; }public void setId(int id) { this.id = id;}public Map<String, Object> getAttributes() { return attributes;} }ExtraProcessor processor = new ExtraProcessor() {public void processExtra(Object object, String key, Object value) {VO vo = (VO) object;vo.getAttributes().put(key, value);} };VO vo = JSON.parseObject("{\"id\":123,\"name\":\"abc\"}", VO.class, processor); Assert.assertEquals(123, vo.getId()); Assert.assertEquals("abc", vo.getAttributes().get("name"));3、使用ExtraTypeProvider 為多余的字段提供類型
public static class VO {private int id;private Map<String, Object> attributes = new HashMap<String, Object>();public int getId() { return id; }public void setId(int id) { this.id = id;}public Map<String, Object> getAttributes() { return attributes;} }class MyExtraProcessor implements ExtraProcessor, ExtraTypeProvider {public void processExtra(Object object, String key, Object value) {VO vo = (VO) object;vo.getAttributes().put(key, value);}public Type getExtraType(Object object, String key) {if ("value".equals(key)) {return int.class;}return null;} }; ExtraProcessor processor = new MyExtraProcessor();VO vo = JSON.parseObject("{\"id\":123,\"value\":\"123456\"}", VO.class, processor); Assert.assertEquals(123, vo.getId()); Assert.assertEquals(123456, vo.getAttributes().get("value")); // value本應(yīng)該是字符串類型的，通過getExtraType的處理變成Integer類型了。10|0在 Spring MVC 中集成 Fastjson
?
如果你使用 Spring MVC 來構(gòu)建 Web 應(yīng)用并對性能有較高的要求的話，可以使用 Fastjson 提供的FastJsonHttpMessageConverter 來替換 Spring MVC 默認(rèn)的 HttpMessageConverter 以提高 @RestController @ResponseBody @RequestBody 注解的 JSON序列化速度。下面是配置方式，非常簡單。
XML式
如果是使用 XML 的方式配置 Spring MVC 的話，只需在 Spring MVC 的 XML 配置文件中加入下面配置即可
通常默認(rèn)配置已經(jīng)可以滿足大部分使用場景，如果你想對它進(jìn)行自定義配置的話，你可以添加 FastJsonConfig Bean。
<mvc:annotation-driven><mvc:message-converters><bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter"><property name="fastJsonConfig" ref="fastJsonConfig"/></bean></mvc:message-converters> </mvc:annotation-driven><bean id="fastJsonConfig" class="com.alibaba.fastjson.support.config.FastJsonConfig"><!-- 自定義配置... --> </bean>編程式
如果是使用編程的方式（通常是基于 Spring Boot 項目）配置 Spring MVC 的話只需繼承 WebMvcConfigurerAdapter 覆寫configureMessageConverters方法即可，就像下面這樣。
注意：
1、如果你使用的 Fastjson 版本小于1.2.36的話(強(qiáng)烈建議使用最新版本)，在與Spring MVC 4.X 版本集成時需使用 FastJsonHttpMessageConverter4。
2、SpringBoot 2.0.1版本中加載WebMvcConfigurer的順序發(fā)生了變動，故需使用converters.add(0, converter);指定FastJsonHttpMessageConverter在converters內(nèi)的順序，否則在SpringBoot 2.0.1及之后的版本中將優(yōu)先使用Jackson處理。
11|0在 Spring Data Redis 中集成 Fastjson
?
通常我們在 Spring 中使用 Redis 是通過 Spring Data Redis 提供的 RedisTemplate 來進(jìn)行的，如果你準(zhǔn)備使用 JSON 作為對象序列/反序列化的方式并對序列化速度有較高的要求的話，建議使用 Fastjson 提供的 GenericFastJsonRedisSerializer 或 FastJsonRedisSerializer 作為 RedisTemplate 的 RedisSerializer。下面是配置方式，非常簡單。
XML式
如果是使用 XML 的方式配置 Spring Data Redis 的話，只需將 RedisTemplate 中的 Serializer 替換為 GenericFastJsonRedisSerializer 即可。
下面是完整的 Spring 集成 Redis 配置供參考。
<!-- Redis 連接池配置(可選) --> <bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig"><property name="maxTotal" value="${redis.pool.maxActive}"/><property name="maxIdle" value="${redis.pool.maxIdle}"/><property name="maxWaitMillis" value="${redis.pool.maxWait}"/><property name="testOnBorrow" value="${redis.pool.testOnBorrow}"/><!-- 更多連接池配置...--> </bean> <!-- Redis 連接工廠配置 --> <bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory"><!--設(shè)置連接池配置，不設(shè)置的話會使用默認(rèn)的連接池配置，若想禁用連接池可設(shè)置 usePool = false --> <property name="poolConfig" ref="jedisPoolConfig" /> <property name="hostName" value="${host}"/><property name="port" value="${port}"/><property name="password" value="${password}"/><property name="database" value="${database}"/><!-- 更多連接工廠配置...--> </bean> <!-- RedisTemplate 配置 --> <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate"><!-- 設(shè)置 Redis 連接工廠--><property name="connectionFactory" ref="jedisConnectionFactory"/><!-- 設(shè)置默認(rèn) Serializer ，包含 keySerializer & valueSerializer --><property name="defaultSerializer"><bean class="com.alibaba.fastjson.support.spring.GenericFastJsonRedisSerializer"/></property><!-- 單獨設(shè)置 keySerializer --><property name="keySerializer"><bean class="com.alibaba.fastjson.support.spring.GenericFastJsonRedisSerializer"/></property><!-- 單獨設(shè)置 valueSerializer --><property name="valueSerializer"><bean class="com.alibaba.fastjson.support.spring.GenericFastJsonRedisSerializer"/></property> </bean>編程式
如果是使用編程的方式（通常是基于 Spring Boot 項目）配置 RedisTemplate 的話只需在你的配置類(被@Configuration注解修飾的類)中顯式創(chuàng)建 RedisTemplate Bean，設(shè)置 Serializer 即可。
@Bean public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {RedisTemplate redisTemplate = new RedisTemplate();redisTemplate.setConnectionFactory(redisConnectionFactory);GenericFastJsonRedisSerializer fastJsonRedisSerializer = new GenericFastJsonRedisSerializer();redisTemplate.setDefaultSerializer(fastJsonRedisSerializer);//設(shè)置默認(rèn)的Serialize，包含 keySerializer & valueSerializer//redisTemplate.setKeySerializer(fastJsonRedisSerializer);//單獨設(shè)置keySerializer//redisTemplate.setValueSerializer(fastJsonRedisSerializer);//單獨設(shè)置valueSerializerreturn redisTemplate; }通常使用 GenericFastJsonRedisSerializer 即可滿足大部分場景，如果你想定義特定類型專用的 RedisTemplate 可以使用 FastJsonRedisSerializer 來代替 GenericFastJsonRedisSerializer ，配置是類似的。
總結(jié)
以上是生活随笔為你收集整理的alibaba Fastjson的JOSN解析库 -的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 第一章：AJAX与jQuery
- 下一篇： XFTP无法将宿主机文件上传到虚拟机的解