一行 log 日志，結(jié)果引發(fā)了 P1 的線上事故
來源：juejin.cn/post/7156439842958606349
-
線上事故回顧 -
情景還原 -
源碼分析 -
JavaBeanSerizlier序列化原理 -
序列化流程圖 -
示例代碼 -
代碼規(guī)范 -
三個(gè)頻率高的序列化的情況
線上事故回顧
前段時(shí)間同事新增了一個(gè)特別簡單的功能，晚上上線前review代碼時(shí)想到公司拼搏進(jìn)取的價(jià)值觀臨時(shí)他加一行 log 日志，覺得就一行簡單的日志基本上沒啥問題，結(jié)果剛上完線后一堆報(bào)警，趕緊回滾了代碼，找到問題刪除了添加日志的代碼，重新上線完畢。
情景還原
?
定義了一個(gè)
CountryDTO?
public class CountryDTO {
private String country;
public void setCountry(String country) {
this.country = country;
}
public String getCountry() {
return this.country;
}
public Boolean isChinaName() {
return this.country.equals("中國");
}
}
?
定義測試類
FastJonTest?
public class FastJonTest {
@Test
public void testSerialize() {
CountryDTO countryDTO = new CountryDTO();
String str = JSON.toJSONString(countryDTO);
System.out.println(str);
}
}
運(yùn)行時(shí)報(bào)空指針錯(cuò)誤：
空指針
通過報(bào)錯(cuò)信息可以看出來是序列化的過程中執(zhí)行了isChinaName()方法，這時(shí)候this.country變量為空，那么問題來了：
-
序列化為什么會(huì)執(zhí)行 isChinaName()呢？ -
引申一下，序列化過程中會(huì)執(zhí)行那些方法呢?
源碼分析
通過 debug 觀察調(diào)用鏈路的堆棧信息
調(diào)用鏈中的ASMSerializer_1_CountryDTO.write是FastJson使用asm技術(shù)動(dòng)態(tài)生成了一個(gè)類ASMSerializer_1_CountryDTO。
?
asm技術(shù)其中一項(xiàng)使用場景就是通過到動(dòng)態(tài)生成類用來代替
java反射，從而避免重復(fù)執(zhí)行時(shí)的反射開銷?
JavaBeanSerizlier序列化原理
通過下圖看出序列化的過程中，主要是調(diào)用JavaBeanSerializer類的write()方法。
ObjectSerializer實(shí)現(xiàn)類JavaBeanSerializer
而JavaBeanSerializer主要是通過getObjectWriter()方法獲取，通過對getObjectWriter()執(zhí)行過程的調(diào)試，找到比較關(guān)鍵的com.alibaba.fastjson.serializer.SerializeConfig#createJavaBeanSerializer方法，進(jìn)而找到 com.alibaba.fastjson.util.TypeUtils#computeGetters
public static List<FieldInfo> computeGetters(Class<?> clazz, //
JSONType jsonType, //
Map<String,String> aliasMap, //
Map<String,Field> fieldCacheMap, //
boolean sorted, //
PropertyNamingStrategy propertyNamingStrategy //
){
//省略部分代碼....
Method[] methods = clazz.getMethods();
for(Method method : methods){
//省略部分代碼...
if(method.getReturnType().equals(Void.TYPE)){
continue;
}
if(method.getParameterTypes().length != 0){
continue;
}
//省略部分代碼...
JSONField annotation = 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")
public class CountryDTO {
private String country;
public void setCountry(String country) {
this.country = country;
}
public String getCountry() {
return this.country;
}
public static void queryCountryList() {
System.out.println("queryCountryList()執(zhí)行!!");
}
public Boolean isChinaName() {
System.out.println("isChinaName()執(zhí)行!!");
return true;
}
public String getEnglishName() {
System.out.println("getEnglishName()執(zhí)行!!");
return "lucy";
}
public String getOtherName() {
System.out.println("getOtherName()執(zhí)行!!");
return "lucy";
}
/**
* case1: @JSONField(serialize = false)
*/
@JSONField(serialize = false)
public String getEnglishName2() {
System.out.println("getEnglishName2()執(zhí)行!!");
return "lucy";
}
/**
* case2: getXxx()返回值為void
*/
public void getEnglishName3() {
System.out.println("getEnglishName3()執(zhí)行!!");
}
/**
* case3: isXxx()返回值不等于布爾類型
*/
public String isChinaName2() {
System.out.println("isChinaName2()執(zhí)行!!");
return "isChinaName2";
}
}
運(yùn)行結(jié)果為：
isChinaName()執(zhí)行!!
getEnglishName()執(zhí)行!!
{"chinaName":true,"englishName":"lucy"}
代碼規(guī)范
可以看出來序列化的規(guī)則還是很多的，比如有時(shí)需要關(guān)注返回值，有時(shí)需要關(guān)注參數(shù)個(gè)數(shù)，有時(shí)需要關(guān)注@JSONType注解，有時(shí)需要關(guān)注@JSONField注解；當(dāng)一個(gè)事物的判別方式有多種的時(shí)候，由于團(tuán)隊(duì)人員掌握知識(shí)點(diǎn)的程度不一樣，這個(gè)方差很容易導(dǎo)致代碼問題，所以盡量有一種推薦方案。
這里推薦使用@JSONField(serialize = false)來顯式的標(biāo)注方法不參與序列化，下面是使用@JSONField注解后的代碼，是不是一眼就能看出來哪些方法不需要參與序列化了。
public class CountryDTO {
private String country;
public void setCountry(String country) {
this.country = country;
}
public String getCountry() {
return this.country;
}
@JSONField(serialize = false)
public static void queryCountryList() {
System.out.println("queryCountryList()執(zhí)行!!");
}
public Boolean isChinaName() {
System.out.println("isChinaName()執(zhí)行!!");
return true;
}
public String getEnglishName() {
System.out.println("getEnglishName()執(zhí)行!!");
return "lucy";
}
@JSONField(serialize = false)
public String getOtherName() {
System.out.println("getOtherName()執(zhí)行!!");
return "lucy";
}
@JSONField(serialize = false)
public String getEnglishName2() {
System.out.println("getEnglishName2()執(zhí)行!!");
return "lucy";
}
@JSONField(serialize = false)
public void getEnglishName3() {
System.out.println("getEnglishName3()執(zhí)行!!");
}
@JSONField(serialize = false)
public String isChinaName2() {
System.out.println("isChinaName2()執(zhí)行!!");
return "isChinaName2";
}
}
三個(gè)頻率高的序列化的情況
三個(gè)頻率高的序列化的情況
以上流程基本遵循，發(fā)現(xiàn)問題 --> 原理分析 --> 解決問題 --> 升華(編程規(guī)范)。
-
圍繞業(yè)務(wù)上：解決問題 -> 如何選擇一種好的額解決方案 -> 好的解決方式如何擴(kuò)展 n 個(gè)系統(tǒng)應(yīng)用； -
圍繞技術(shù)上：解決單個(gè)問題，順著單個(gè)問題掌握這條線上的原理。
但其實(shí)這段代碼我并不滿意，原因是和 FastJson 依賴太高了。我想要的效果是，不依賴任何特定的 JSON 序列化框架。當(dāng)我需要替換掉它的時(shí)候，隨時(shí)可以替換掉。
并且在寫代碼時(shí)，不要過于依賴日志。打日志只需要打緊要且關(guān)鍵的信息即可，不要什么日志都打，我曾見過一個(gè)系統(tǒng)，一個(gè)小時(shí)，把 128G 磁盤跑滿的管理系統(tǒng)。幾乎沒啥并發(fā)，但幾乎每個(gè)請求都輸出幾 M 的日志，這件事我后面會(huì)單獨(dú)拿出來講講。
關(guān)于@JSONField和@JSONType等特性注解，后面我會(huì)在團(tuán)隊(duì)內(nèi)規(guī)范并給出新的解耦方案，把它們移除掉。
如果看到這里，說明你喜歡這篇文章，請 轉(zhuǎn)發(fā)、點(diǎn)贊。同時(shí) 標(biāo)星（置頂）本公眾號可以第一時(shí)間接受到博文推送。
獲取方式：點(diǎn)“ 在看，關(guān)注公眾號 Java金融 并回復(fù) 888 領(lǐng)取，更多內(nèi)容陸續(xù)奉上。
喜歡文章，點(diǎn)個(gè)在看 