線上事故回顧

前段時間同事新增了一個特別簡單的功能，晚上上線前review代碼時想到公司拼搏進取的價值觀臨時他加一行 log 日志，覺得就一行簡單的日志基本上沒啥問題，結果剛上完線后一堆報警，趕緊回滾了代碼，找到問題刪除了添加日志的代碼，重新上線完畢。

基于 Spring Boot + MyBatis Plus + Vue & Element 實現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動態(tài)權限、多租戶、數(shù)據(jù)權限、工作流、三方登錄、支付、短信、商城等功能

• 項目地址：https://gitee.com/zhijiantianya/ruoyi-vue-pro
• 視頻教程：https://doc.iocoder.cn/video/

情景還原

?

定義了一個 CountryDTO

?

publicclassCountryDTO{
privateStringcountry;

publicvoidsetCountry(Stringcountry){
this.country=country;
}

publicStringgetCountry(){
returnthis.country;
}

publicBooleanisChinaName(){
returnthis.country.equals("中國");
}
}

?

定義測試類 FastJonTest

?

publicclassFastJonTest{
@Test
publicvoidtestSerialize(){
CountryDTOcountryDTO=newCountryDTO();
Stringstr=JSON.toJSONString(countryDTO);
System.out.println(str);
}
}

運行時報空指針錯誤：

通過報錯信息可以看出來是序列化的過程中執(zhí)行了isChinaName()方法，這時候this.country變量為空，那么問題來了：

• 序列化為什么會執(zhí)行isChinaName()呢？
• 引申一下，序列化過程中會執(zhí)行那些方法呢?

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動態(tài)權限、多租戶、數(shù)據(jù)權限、工作流、三方登錄、支付、短信、商城等功能

• 項目地址：https://gitee.com/zhijiantianya/yudao-cloud
• 視頻教程：https://doc.iocoder.cn/video/

源碼分析

通過 debug 觀察調用鏈路的堆棧信息

調用鏈中的ASMSerializer_1_CountryDTO.write是FastJson使用asm技術動態(tài)生成了一個類ASMSerializer_1_CountryDTO。

?

asm技術其中一項使用場景就是通過到動態(tài)生成類用來代替java反射，從而避免重復執(zhí)行時的反射開銷

?

JavaBeanSerizlier序列化原理

通過下圖看出序列化的過程中，主要是調用JavaBeanSerializer類的write()方法。

而JavaBeanSerializer主要是通過getObjectWriter()方法獲取，通過對getObjectWriter()執(zhí)行過程的調試，找到比較關鍵的com.alibaba.fastjson.serializer.SerializeConfig#createJavaBeanSerializer方法，進而找到 com.alibaba.fastjson.util.TypeUtils#computeGetters

publicstaticListcomputeGetters(Classclazz,//
JSONTypejsonType,//
MapaliasMap,//
MapfieldCacheMap,//
booleansorted,//
PropertyNamingStrategypropertyNamingStrategy//
){
//省略部分代碼....
Method[]methods=clazz.getMethods();
for(Methodmethod:methods){
//省略部分代碼...
if(method.getReturnType().equals(Void.TYPE)){
continue;
}
if(method.getParameterTypes().length!=0){
continue;
}
//省略部分代碼...
JSONFieldannotation=TypeUtils.getAnnotation(method,JSONField.class);
//省略部分代碼...
if(annotation!=null){
if(!annotation.serialize()){
continue;
}
if(annotation.name().length()!=0){
//省略部分代碼...
}
}
if(methodName.startsWith("get")){
//省略部分代碼...
}
if(methodName.startsWith("is")){
//省略部分代碼...
}
}
}

從代碼中大致分為三種情況：

• @JSONField(.serialize = false, name = "xxx")注解
• getXxx() : get開頭的方法
• isXxx()：is開頭的方法

序列化流程圖

示例代碼

/**
*case1:@JSONField(serialize=false)
*case2:getXxx()返回值為void
*case3:isXxx()返回值不等于布爾類型
*case4:@JSONType(ignores="xxx")
*/
@JSONType(ignores="otherName")
publicclassCountryDTO{
privateStringcountry;

publicvoidsetCountry(Stringcountry){
this.country=country;
}

publicStringgetCountry(){
returnthis.country;
}

publicstaticvoidqueryCountryList(){
System.out.println("queryCountryList()執(zhí)行!!");
}

publicBooleanisChinaName(){
System.out.println("isChinaName()執(zhí)行!!");
returntrue;
}

publicStringgetEnglishName(){
System.out.println("getEnglishName()執(zhí)行!!");
return"lucy";
}

publicStringgetOtherName(){
System.out.println("getOtherName()執(zhí)行!!");
return"lucy";
}

/**
*case1:@JSONField(serialize=false)
*/
@JSONField(serialize=false)
publicStringgetEnglishName2(){
System.out.println("getEnglishName2()執(zhí)行!!");
return"lucy";
}

/**
*case2:getXxx()返回值為void
*/
publicvoidgetEnglishName3(){
System.out.println("getEnglishName3()執(zhí)行!!");
}

/**
*case3:isXxx()返回值不等于布爾類型
*/
publicStringisChinaName2(){
System.out.println("isChinaName2()執(zhí)行!!");
return"isChinaName2";
}
}

運行結果為：

isChinaName()執(zhí)行!!
getEnglishName()執(zhí)行!!
{"chinaName":true,"englishName":"lucy"}

代碼規(guī)范

可以看出來序列化的規(guī)則還是很多的，比如有時需要關注返回值，有時需要關注參數(shù)個數(shù)，有時需要關注@JSONType注解，有時需要關注@JSONField注解；當一個事物的判別方式有多種的時候，由于團隊人員掌握知識點的程度不一樣，這個方差很容易導致代碼問題，所以盡量有一種推薦方案。

這里推薦使用@JSONField(serialize = false)來顯式的標注方法不參與序列化，下面是使用@JSONField注解后的代碼，是不是一眼就能看出來哪些方法不需要參與序列化了。

publicclassCountryDTO{
privateStringcountry;

publicvoidsetCountry(Stringcountry){
this.country=country;
}

publicStringgetCountry(){
returnthis.country;
}

@JSONField(serialize=false)
publicstaticvoidqueryCountryList(){
System.out.println("queryCountryList()執(zhí)行!!");
}

publicBooleanisChinaName(){
System.out.println("isChinaName()執(zhí)行!!");
returntrue;
}

publicStringgetEnglishName(){
System.out.println("getEnglishName()執(zhí)行!!");
return"lucy";
}

@JSONField(serialize=false)
publicStringgetOtherName(){
System.out.println("getOtherName()執(zhí)行!!");
return"lucy";
}

@JSONField(serialize=false)
publicStringgetEnglishName2(){
System.out.println("getEnglishName2()執(zhí)行!!");
return"lucy";
}

@JSONField(serialize=false)
publicvoidgetEnglishName3(){
System.out.println("getEnglishName3()執(zhí)行!!");
}

@JSONField(serialize=false)
publicStringisChinaName2(){
System.out.println("isChinaName2()執(zhí)行!!");
return"isChinaName2";
}
}

三個頻率高的序列化的情況

以上流程基本遵循，發(fā)現(xiàn)問題 --> 原理分析 --> 解決問題 --> 升華(編程規(guī)范)。

• 圍繞業(yè)務上：解決問題 -> 如何選擇一種好的額解決方案 -> 好的解決方式如何擴展 n 個系統(tǒng)應用；
• 圍繞技術上：解決單個問題，順著單個問題掌握這條線上的原理。

但其實這段代碼我并不滿意，原因是和 FastJson 依賴太高了。我想要的效果是，不依賴任何特定的 JSON 序列化框架。當我需要替換掉它的時候，隨時可以替換掉。

并且在寫代碼時，不要過于依賴日志。打日志只需要打緊要且關鍵的信息即可，不要什么日志都打，我曾見過一個系統(tǒng)，一個小時，把 128G 磁盤跑滿的管理系統(tǒng)。幾乎沒啥并發(fā)，但幾乎每個請求都輸出幾 M 的日志，這件事我后面會單獨拿出來講講。

關于@JSONField和@JSONType等特性注解，后面我會在團隊內(nèi)規(guī)范并給出新的解耦方案，把它們移除掉。