初識fastjson

什麼是fastjson

阿里官方給的定義是, fastjson 是阿里巴巴的開源JSON解析庫,它可以解析 JSON 格式的字符串,支持將 Java Bean 序列化爲 JSON 字符串,也可以從 JSON 字符串反序列化到 JavaBean。

優點

  • 速度快
    fastjson相對其他JSON庫的特點是快,從2011年fastjson發佈1.1.x版本之後,其性能從未被其他Java實現的JSON庫超越。
  • 使用廣泛
    fastjson在阿里巴巴大規模使用,在數萬臺服務器上部署,fastjson在業界被廣泛接受。在2012年被開源中國評選爲最受歡迎的國產開源軟件之一。
  • 測試完備
    fastjson有非常多的testcase,在1.2.11版本中,testcase超過3321個。每次發佈都會進行迴歸測試,保證質量穩定。
  • 使用簡單
    fastjson的 API 十分簡潔。
  • 功能完備
    支持泛型,支持流處理超大文本,支持枚舉,支持序列化和反序列化擴展。

引入相應的Maven包

<!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.62</version>
</dependency>

主要的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);
  • 泛型反序列化:
    對進行泛型的反序列化,使用TypeReference可以明確的指定反序列化的類型
    是把字符串planjson轉化爲相應的JSONObject對象,“鍵值對”形式,然後通過new TypeReference(){ }匿名內部類來把planjson的JSONObject轉化爲Plan對象不屬於plan對象本身的屬性,通過TypeReference只把屬於plan對象屬性的參數和值組裝成plan對象
import com.alibaba.fastjson.TypeReference;
List<Plan> list = JSON.parseObject(planjson, new TypeReference<List<Plan>>() {});

將對象的空值輸出

在fastjson中,缺省是不輸出空值的。無論Map中的null和對象屬性中的null,序列化的時候都會被忽略不輸出,這樣會減少產生文本的大小。但如果需要輸出空值怎麼做呢?
如果你需要輸出空值,需要使用SerializerFeature.WriteMapNullValue

Model obj = ...;
JSON.toJSONString(obj, SerializerFeature.WriteMapNullValue);

幾種空值特別處理方式,可以同時選擇多個:

說明
WriteNullListAsEmpty 將Collection類型字段的字段空值輸出爲[]
WriteNullStringAsEmpty 將字符串類型字段的空值輸出爲空字符串 “”
WriteNullNumberAsZero 將數值類型字段的空值輸出爲0
WriteNullBooleanAsFalse 將Boolean類型字段的空值輸出爲false
class Model {
      public List<Objec> items;
}

Model obj = ....;

String text = JSON.toJSONString(obj, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullListAsEmpty);

fastjson處理日期

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支持多種方式定製序列化。

  • 通過@JSONField定製序列化
  • 通過@JSONType定製序列化
  • 通過SerializeFilter定製序列化
  • 通過ParseProcess定製反序列化

通過@JSONField定製序列化

1.註解屬性及作用

  • 配置序列化和反序列化的順序,1.1.42版本之後才支持
    int ordinal() default 0;
  • 指定字段的名稱
    String name() default "";
  • 指定字段的格式,對日期格式有用
    String format() default "";
  • 是否序列化
    boolean serialize() default true;
  • 是否反序列化
    boolean deserialize() default true;

2.使用

可以把@JSONField配置在字段或者getter/setter方法上,都是可以的。

若屬性是私有的,必須有set*方法。否則無法反序列化。

2.1使用name指定字段名稱

說明:指定字段名稱,修改在序列化和反序列化時對應的字段名稱。
舉個例子來說明把@JSONField(name = "XXX")標在getter/setter上的區別->目的:區分放在get和set上的區別
實體類

package ink.poesy.pojo;

import com.alibaba.fastjson.annotation.JSONField;
import lombok.AccessLevel;
import lombok.Data;
import lombok.Getter;
import lombok.Setter;

@Data
public class SYS_PhysicalHost {
    private String name;

    @Setter(AccessLevel.NONE)
    private String department;

    @Getter(AccessLevel.NONE)
    private String age;

    @Getter(AccessLevel.NONE)
    @Setter(AccessLevel.NONE)
    private String poesy;

	/**
	 * 創建set不get用例
	 */
    @JSONField(name = "bumen")
    public void setDepartment(String department) {
        this.department = department;
    }

	/**
	 * 創建get不set用例
	 */
    @JSONField(name = "nianling")
    public String getAge() {
        return age;
    }

	/**
	 * 創建get和set用例
	 */
    @JSONField(name = "geyan")
    public String getPoesy() {
        return poesy;
    }
    @JSONField(name = "geyan")
    public void setPoesy(String poesy) {
        this.poesy = poesy;
    }
}

測試類

package ink.poesy.service;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;
import ink.poesy.pojo.SYS_PhysicalHost;

/**
 * @description: 測試@JSONField作用範圍
 * @author: WenLeiWang
 * @date: Created in 2019/11/6 10:08
 * @version: 1.0
 * @modified By:
 */
public class Test {
    private static String human1 = "{\"name\":\"wwl\",\"department\":\"ruanjian1\",\"age\":23,\"poesy\":\"hsb1\"}";
    private static String human2 = "{\"name\":\"gt\",\"bumen\":\"ruanjian2\",\"nianling\":23,\"geyan\":\"hsb2\"}";

    public static void main(String[] args) {
        SYS_PhysicalHost sys_physicalHost1 = JSON.parseObject(human1, new TypeReference<SYS_PhysicalHost>() {});
        System.out.println(sys_physicalHost1.toString());
        SYS_PhysicalHost sys_physicalHost2 = JSON.parseObject(human2, new TypeReference<SYS_PhysicalHost>() {});
        System.out.println(sys_physicalHost2.toString());

    }
}

測試結果
測試結果
結果說明

  • get 上寫JSONFeild => 以name提供的字段 序列化 也就是你要把bean轉成json
  • set 上寫JSONFeild => 以name提供的字段反序列化 也就是把json轉成bean

2.2使用format配置日期格式化

可以定製化配置各個日期字段的格式化

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

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

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

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

2.4使用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;
}

2.5使用serializeUsing制定屬性的序列化類

通過@JSONType定製序列化

1.簡介

和JSONField類似,但JSONType配置在類上,而不是field或者getter/setter方法上。
SerializeFilter是通過編程擴展的方式定製序列化。fastjson支持6種SerializeFilter,用於不同場景的定製序列化。

  • PropertyPreFilter 根據PropertyName判斷是否序列化
  • PropertyFilter 根據PropertyName和PropertyValue來判斷是否序列化
  • NameFilter 修改Key,如果需要修改Key,process返回值則可
  • ValueFilter 修改Value
  • BeforeFilter 序列化時在最前添加內容
  • AfterFilter 序列化時在最後添加內容

2.使用

2.1PropertyFilter 根據PropertyName和PropertyValue來判斷是否序列化

public interface PropertyFilter extends SerializeFilter {
    boolean apply(Object object, String propertyName, Object propertyValue);
 }

可以通過擴展實現根據object或者屬性名稱或者屬性值進行判斷是否需要序列化。例如:

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); // 序列化的時候傳入filter

2.2PropertyPreFilter 根據PropertyName判斷是否序列化

和PropertyFilter不同只根據object和name進行判斷,在調用getter之前,這樣避免了getter調用可能存在的異常。

public interface PropertyPreFilter extends SerializeFilter {
      boolean apply(JSONSerializer serializer, Object object, String name);
  }

2.3NameFilter 序列化時修改Key

如果需要修改Key,process返回值則可

public interface NameFilter extends SerializeFilter {
    String process(Object object, String propertyName, Object propertyValue);
}

fastjson內置一個PascalNameFilter,用於輸出將首字符大寫的Pascal風格。 例如:

import com.alibaba.fastjson.serializer.PascalNameFilter;

Object obj = ...;
String jsonStr = JSON.toJSONString(obj, new PascalNameFilter());

2.4ValueFilter 序列化時修改Value

public interface ValueFilter extends SerializeFilter {
  Object process(Object object, String propertyName, Object propertyValue);
}

2.5BeforeFilter 序列化時在最前添加內容

在序列化對象的所有屬性之前執行某些操作,例如調用 writeKeyValue 添加內容

public abstract class BeforeFilter implements SerializeFilter {
   protected final void writeKeyValue(String key, Object value) { ... }
    // 需要實現的抽象方法,在實現中調用writeKeyValue添加內容
    public abstract void writeBefore(Object object);
}

2.6AfterFilter 序列化時在最後添加內容

在序列化對象的所有屬性之後執行某些操作,例如調用 writeKeyValue 添加內容

 public abstract class AfterFilter implements SerializeFilter {
  protected final void writeKeyValue(String key, Object value) { ... }
    // 需要實現的抽象方法,在實現中調用writeKeyValue添加內容
    public abstract void writeAfter(Object object);
}

通過ParseProcess定製反序列化

1.簡介

ParseProcess是編程擴展定製反序列化的接口。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"));

使用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本應該是字符串類型的,通過getExtraType的處理變成Integer類型了。

本文爲學習筆記來源整理自網絡,如有侵犯留言聯繫。
以上內容如有爭議、指正,留言給我~

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章