FastJSON字段智能匹配踩坑的解決

更新時間：2021年06月18日 11:55:27 作者：祈雨v

這篇文章主要介紹了FastJSON字段智能匹配踩坑的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

背景

2021年第一天早上，客戶突然投訴說系統(tǒng)的一個功能出了問題，緊急排查后發(fā)現(xiàn)后端系統(tǒng)確實出了bug，原因為前端傳輸?shù)腏SON報文，后端反序列化成JavaBean后部分字段的值丟失了。

查看git提交歷史記錄，前端和后端近期并未對該功能的接口字段做任何修改，聯(lián)想到上個版本升級了后端的FastJSON的版本，懷疑是后端系統(tǒng)對FastJSON升級導(dǎo)致的問題。

復(fù)現(xiàn)

@Data
static class Label {
 @JSONField(name = "label_id")
 private Integer labelId;
 private String labelName;
}
public static void main(String[] args) {
 String value = "{'labelId': 1,'label_name':'name'}";
 Label label = JSON.parseObject(value, Label.class);
 System.out.println(label);
}

低版本

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

使用低版本FastJSON，如上使用1.2.60版本，示例輸出的結(jié)果如下，即兩個字段JSON解析映射成功。雖然JavaBean中的字段和JSON中的key并不完全匹配（大小寫不匹配以及下劃線匹配），但得益于FastJSON的智能匹配，忽略了大小寫和下劃線，依然將JSON映射成功。

Label(labelId=1, labelName=name)

高版本

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

使用高版本FastJSON，如上使用1.2.71，示例輸出結(jié)果如下，字段labelId映射失敗，即高版本FastJSON對智能匹配規(guī)則做了修改，并且未向前兼容而導(dǎo)致了部分字段映射失敗導(dǎo)致了這次的bug。

Label(labelId=null, labelName=name)

原理

解析高版本FastJSON字段智能匹配失敗的原因，首先要先了解智能匹配的規(guī)則。

低版本

低版本的智能匹配規(guī)則的關(guān)鍵代碼如下，翻譯成人話就是：

1、如果JavaBean字段有@JSONField注解且name不空時，則對name的值忽略字母大小寫和-,_兩個字符

2、否則取JavaBean的字段名，忽略字母大小寫和-,_兩個字符

3、JSON中的key忽略is開頭并忽略剩余字母大小寫和-,_兩個字符

// 對JSON中沒有成功映射JavaBean的key做智能匹配
// 1. 忽略key的字母大小寫和'-','_'兩個字符
long smartKeyHash = TypeUtils.fnv1a_64_lower(key);
if (this.smartMatchHashArray == null) {
    long[] hashArray = new long[sortedFieldDeserializers.length];
    for (int i = 0; i < sortedFieldDeserializers.length; i++) {
        // fieldInfo.name優(yōu)先取@JSONField的name字段,其次取JavaBean字段名
        // fieldInfo.name忽略字母大小寫和'-','_'兩個字符嘗試與JSON中的key做智能匹配
        hashArray[i] = TypeUtils.fnv1a_64_lower(sortedFieldDeserializers[i].fieldInfo.name);
    }
    Arrays.sort(hashArray);
    this.smartMatchHashArray = hashArray;
}
int pos = Arrays.binarySearch(smartMatchHashArray, smartKeyHash);
// 2. 如果key以'is'開頭,則忽略'is'開頭并忽略剩余字母大小寫和'-','_'兩個字符
boolean is = false;
if (pos < 0 && (is = key.startsWith("is"))) {
    smartKeyHash = TypeUtils.fnv1a_64_lower(key.substring(2));
    pos = Arrays.binarySearch(smartMatchHashArray, smartKeyHash);
}

在這里插入圖片描述

高版本

高版本的智能匹配規(guī)則的關(guān)鍵代碼如下，翻譯成人話就是：

1、如果JavaBean字段有@JSONField注解且name不空時，則取name的值

2、否則取JavaBean的字段名，忽略字母大小寫和-,_兩個字符

3、JSON中的key忽略is開頭并忽略剩余字母大小寫和-,_兩個字符

if (this.smartMatchHashArray == null) {
    long[] hashArray = new long[sortedFieldDeserializers.length];
    for (int i = 0; i < sortedFieldDeserializers.length; i++) {
        // 1. @JSONField的name不空時取該值直接與JSON中的key做匹配
        // 2. 取JavaBean字段名忽略字母大小寫和'-','_'兩個字符嘗試與JSON中的key做智能匹配
        hashArray[i] = sortedFieldDeserializers[i].fieldInfo.nameHashCode;
    }
    Arrays.sort(hashArray);
    this.smartMatchHashArray = hashArray;
}
// 對JSON中沒有成功映射JavaBean的key做智能匹配
// 1. 直接匹配
long smartKeyHash = TypeUtils.fnv1a_64_extract(key);
int pos = Arrays.binarySearch(smartMatchHashArray, smartKeyHash);
// 2. 忽略key的字母大小寫和'-','_'兩個字符
if (pos < 0) {
    long smartKeyHash1 = TypeUtils.fnv1a_64_lower(key);
    pos = Arrays.binarySearch(smartMatchHashArray, smartKeyHash1);
}
// 3. 如果key以'is'開頭,則忽略'is'開頭并忽略剩余字母大小寫和'-','_'兩個字符
boolean is = false;
if (pos < 0 && (is = key.startsWith("is"))) {
    smartKeyHash = TypeUtils.fnv1a_64_lower(key.substring(2));
    pos = Arrays.binarySearch(smartMatchHashArray, smartKeyHash);
}

// 優(yōu)先取@JSONField的name字段直接與JSON中的key做匹配
// 其次取JavaBean字段名忽略字母大小寫和'-','_'兩個字符嘗試與JSON中的key做智能匹配
private long nameHashCode64(String name, JSONField annotation)
{
    if (annotation != null && annotation.name().length() != 0) {
        return TypeUtils.fnv1a_64_extract(name);
    }
    return TypeUtils.fnv1a_64_lower(name);
}

在這里插入圖片描述