fastjson很好,但不適合我

是奉壹呀發表於2023-03-30

記者:大爺您有什麼特長呀?
fastjson:我很快。
記者:23423乘以4534等於多少?
fastjson:等於2343.
記者:??
fastjson:你就說快不快吧!




這個略顯馬麗蘇的標題,各位看官將就著看吧。主要是怕被噴。fastjson真的很好,我用不用的我喜不喜歡的,太不重要了,我只是覺得不適合我而已。


話說以前GSON用得好好的,同事極力推薦我使用Fastjson,說很快云云。儘管我們的系統根本感知不出來這點速度差異。
之前也聽說Fastjson爆出來什麼重大漏洞,但對我們基本沒什麼影響,所以這一點倒是沒什麼偏見。

然後在一個新專案上,腦抽抽,把gson換成了fastjson,還把spring boot預設支援的jackson換成了fastjson。
然後就開始遇到了一些問題。先宣告,這真不是尬黑,為了文章效果,故意網上扒些黑料拼湊起來,本文所提到的問題,都來源於本人最近專案的真實經歷。

dateformat優先順序

本來是一個風和日麗的下午,一個非常簡單的改動需求。介面返回的時間只需要年月日日期型別不需要時分秒。
因為我配置全域性時間格式化為yyyy-MM-dd HH:mmss,於是我愉快的在javabean的屬性上加了個註解。

@JSONField(format="yyyy-MM-dd")

本地測試一下,沒問題,提交到測試環境,搞定,完美。

然後就接到產品的疑問,改動呢?

我登上去看了一下,唉,沒改到啊,日期還是帶了時分秒。
我大意了啊,這麼小的改動,又是在測試環境,就沒加驗證。

那麼現在的直接問題是:fastjson關於時間配置在區域性的配置沒有生效,使用的還是全域性配置。

現象是,開發環境windows上沒有問題,測試環境linux上出現了問題。兩者有什麼區別呢?系統問題?

既然懷疑是兩個系統導致的問題,那麼就在idea裡模擬一下linux系統。在
VM options 新增 -Dos.name=linux

這不能完全模擬linux系統,只針對透過System.getproperty("os.name")來判斷當前系統做某些操作的時候有用。

透過這種方式沒復現。

我又想到了遠端除錯。
一陣操作猛如虎,遠端除錯倒是能進斷點,只是斷點進不了第三方jar包的原始碼。等於白搞。

得,還是回到原始碼吧。拉下原始碼,斷點,觀察JSONSerializer類,主要是writeWithFormat方法。沒有發現問題。
因為懷疑是系統導致的,在原始碼中搜尋'linux''unix'關鍵字,沒有發現。斷點整個流程重點觀察了一下這部份也沒有發現問題。

突然在 JSONSerializer.dateFormatPattern上發現了這段註釋。

這部份涉及到了調整dateformat的問題,重點在這個#1868,這通常是github的問題編號。

對於開源專案來說,解決BUG,通常會把問題編號放到註釋裡面去。前提是註釋有必要。透過問題編號可以看到問題的前因後果。
通常來說,對於github開源專案都有issue區,拿著這個到編號直接到issue一搜就能搜到。
但也有一些項級專案,如spark,flink是沒有issue區的,它們的型別問題發現描述追蹤都使用jira平臺。如:https://issues.apache.org/jira/browse/SPARK-38349, 在提交PR的時候標題也嚴格按照[jira 編號][spark 子模組(如core/sql) title]的規則來。

所以拿著這個編號到issue區,不管有沒有issue區,也都可以直接到pullrequest區直接搜尋,就算PR標題裡沒有問題編號,PR描述肯定也是有的,只要是有嚴格PR流程的開源專案。

所以這個問題在這裡

https://github.com/alibaba/fastjson/issues/1868

相應的PR在這裡

https://github.com/alibaba/fastjson/pull/2706

透過ISSUES描述的已知資訊,可以看出他遇到的問題跟我是一樣的,而這個問題早在2018年就提出了。但問題描述不太專業,沒有涉及到環境以及最重要的fastjson的版本問題。
而透過PR可知,這個問題最終在2020才解決,期間僅在ISSUES區提出的相同問題就有 #1868 #1968 #2029 #24524個。
解決問題的版本為:1.2.72.

這個資訊很關鍵。我對照了我開發環境的版本,是高於1.2.72的,所以沒有出現測試環境的問題。
所以,柯南告訴我們,排除了所有可能性,剩下的哪怕再可笑,也是最終問題所在。
那就是,測試環境所用的fastjson版本是低於1.2.72的。
這種可能性是存在的,因為我們用的是maven打程式碼包,依賴包單獨存在。
我最終在測試環境的依賴包目錄下發現了兩個Fastjson包,果然不出所料,有一個1.2.53的低版本,它就是罪魁禍首。


所以,最終這個問題有相當大的程度是由於我們團隊自身問題引發的。但透過解決這個問題的過程也發現了一些有意思的情況。

首先,Fastjson在某一個版本為什麼會引發這個問題。它肯定是某個PR改出問題的,rv,testcase覆蓋沒有到位。

其次,從試圖解決這個問題的3個PR的時間線,分別在2018年,2019年,2020年。說明,fastjson這個專案的contributor看起來有百來人,但其中過於依賴其中某1個或者某些主力人員。精力有限,某些優先順序不那麼高的BUG只能放任。

同時這個專案的榮譽感並沒有那麼高(或者叫並沒有那麼吸引高手),它並不是apache頂級專案,要是其它諸如spark/flink,spring,哪怕是dubbo呢,很想象這些專案會有一個並不算複雜的BUG懸而未決長達3年時間。在這些頂級開源專案,大家都是拼了老命的想找些BUG來提交PR。

當然,以上只是我個人的一點猜測。


覆盤,遇到Fastjson的問題,一開始就應該奔著github的issues區,它大機率已經被前人踩坑了。


$ref迴圈引用問題

public ResultBody test () {
        List<Person> list = new ArrayList<>();
        Person obj1 = new Person("張三", 48);
        list.add(obj1);

        Person obj2 = new Person("李四", 23);
        list.add(obj2);

        Person obj3 = new Person("王麻子", 17);
        list.add(obj3);

        List<Person> young = list.stream().filter(e -> e.getAge() <= 45).collect(Collectors.toList());
        List<Person> children =  list.stream().filter(e -> e.getAge()< 18).collect(Collectors.toList());

        HashMap map = new HashMap();
        map.put("young", young);
        map.put("children", children);

        return ResultBody.success(map);
    }

以上測試介面返回前端什麼?
{
	"code":"200",
	"message":"成功!",
	"result":{
		"young":[
			{
				"age":23,
				"name":"李四"
			},
			{
				"age":17,
				"name":"王麻子"
			}
		],
		"children":[
			{"$ref":"$.result.young[1]"}
		]
	}
}

我現在並不知道什麼迴圈引用檢測,這時候它是我的知識盲區。
此時,我觀察到的現象是,youngchildren兩個list物件中均引用指向了王麻子這個物件。然後,在第2次children引用的時候它在序列化的時候直接指向了第1個young裡相應物件引用。
當然遇到這個問題的時候,我在仔細觀察排除了非fastjson的問題以後,這次我學聰明瞭,我直接來到了github的issues區,搜尋$ref


果然有很多同道中人,近150個問題,從時間上來看還挺新鮮。我點選了closed,既然關閉了,那肯定解決了吧。

我點進了closed區第一個問題,然後作者讓升級到fastjson2。
???

如果我沒有理解錯,fastjson和fastjson2可不是兩個版本的區別,是兩個專案也!據說API也有相容性問題。直接這樣升級過去,談何容易!

我覺得這也是個槽點,Fastjson好像並沒有一個穩定維護的版本,遇到問題總是在升級,升級的過程中也沒做好質量控制,又引入了新的問題。


還是在當前專案尋求解決方法吧,哪怕升版本也好啊。
終於在另一個問題下面找到了問題所在以及解決方案。

https://github.com/alibaba/fastjson/issues/3643

我現在知道這是由於迴圈引用檢測引起的。透過設定SerializerFeature.DisableCircularReferenceDetect可以避免這個問題。

但是,我的程式碼其實並沒有迴圈引用啊,只是兩個子物件引用了同一個物件而已。這算什麼?誤傷嗎?
更重要的,一些控制權應該在使用者手裡?

比如,當前這個迴圈引用在序列化會出的問題,應該是使用者手動去開啟,而不是預設給使用者開啟。
在優先順序上,全域性應該關閉,在有迴圈引用的地方,讓使用者選擇區域性開啟。

現在我的前端並沒有使用Fastjson,面對"$ref":"$.result.young[1]"這種文字,它能解析嗎?它不能呀。
我測試了一下,好像使用fastjson也並不能解析回來:

更可怕的問題是,剛好在測試環節有兩個子物件引用了同一個物件,被我提前發現了。如果測試環境沒有這樣的情況,在生產環境剛好遇到了呢?那就是生產事故了呀。

本來是一個挺好的設計點,能起到錦上添花的作用,但它卻可能暴雷,這是好心辦壞事。


同樣的,還有SerializerFeature.WriteMapNullValue
如果一個欄位值為null,fastjson預設就不返回該欄位了。本來前後端約定好,如果為null就怎樣處理的邏輯,可能在生產環境中突然暴雷啊。

就像WriteNullListAsEmpty就很好,不錯的設計點,如果返回的list為null的時候,使用者可以選擇讓它序列化為[],但它也不是預設開啟的呀,給了使用者額外的選擇權,對吧。

總結

寫到這裡的時候,我是真心覺得fastjson有比競品有些特色的地方。這真不是為了所謂的客觀公正,非要負面寫多點,再搞點正面的。

為了寫文章,那肯定要去試驗,得把競品也拿出來測試一下,一測試發現並不是fastjson獨有的,尷尬!

但我還是那句話,不管你信不信,對於開源專案,特別是這樣一個廣泛使用的開源專案,肯定有非常值得學習的地方。一個開源專案,如果整天拿著顯微鏡去觀察,那肯定能找出不少毛病。

這裡稍微總結一下本文的資訊點。 並不一定是某個具體BUG,而是透過這個BUG,解決這個BUG背後所展現出來的fastjson的資訊或趨勢。

1.review,testcase覆蓋不是很到位
2.contributor看起來很多,但嚴重依賴主力人員。而主力精力有限,某些優先順序不那麼高的BUG只能放任。
3.這個專案的榮譽感並沒有那麼高,或者叫並沒有那麼吸引高手)。
4.有些功能點應該把控制主動權交給使用者,如DisableCircularReferenceDetect,WriteMapNullValue等。預設開啟非常容易導致線上暴雷。
5.作者已經全面轉向fastjosn2,而且哪怕在這之前,對於fastjson沒有一個穩定維護的版本,不斷升級,不斷引入新問題。

祝願fastjson2越來越好,不要步struts2的後塵。

相關文章