一行log日誌，引發了P1的線上事故-java教程-PHP中文網

首頁

Java

java教程

一行log日誌，引發了P1的線上事故

Java学习指南

Jul 25, 2023 pm 05:52 PM

日誌（log）

線上事故回顧

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

情境還原

#❝

#定義了一個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);
    }
}

運行時報空指標#錯誤：

一行log日誌，引發了P1的線上事故

##################################################################################################################################### #空指標###

透過報錯資訊可以看出來是序列化的過程中執行了isChinaName()方法，這時候this.country變數為空，那麼問題來了：

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

源碼分析

透過debug 觀察呼叫連結的堆疊資訊

一行log日誌，引發了P1的線上事故

圖片

一行log日誌，引發了P1的線上事故

圖片

呼叫鏈中的ASMSerializer_1_CountryDTO.write是FastJson使用asm技術動態產生了一個類別ASMSerializer_1_CountryDTO。

❝

asm技术其中一项使用场景就是通过到动态生成类用来代替java反射，从而避免重复执行时的反射开销

❞

JavaBeanSerizlier序列化原理

通过下图看出序列化的过程中，主要是调用JavaBeanSerializer类的write()方法。

一行log日誌，引發了P1的線上事故 ObjectSerializer实现类JavaBeanSerializer

而JavaBeanSerializer主要是通过getObjectWriter()方法获取，通过对getObjectWriter()执行过程的调试，找到比较关键的com.alibaba.fastjson.serializer.SerializeConfig#createJavaBeanSerializer方法，进而找到 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开头的方法

序列化流程图

一行log日誌，引發了P1的線上事故序列化流程图

示例代码

/**
 * 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()执行!!");
    }

    public Boolean isChinaName() {
        System.out.println("isChinaName()执行!!");
        return true;
    }

    public String getEnglishName() {
        System.out.println("getEnglishName()执行!!");
        return "lucy";
    }

    public String getOtherName() {
        System.out.println("getOtherName()执行!!");
        return "lucy";
    }

    /**
     * case1: @JSONField(serialize = false)
     */
    @JSONField(serialize = false)
    public String getEnglishName2() {
        System.out.println("getEnglishName2()执行!!");
        return "lucy";
    }

    /**
     * case2: getXxx()返回值为void
     */
    public void getEnglishName3() {
        System.out.println("getEnglishName3()执行!!");
    }

    /**
     * case3: isXxx()返回值不等于布尔类型
     */
    public String isChinaName2() {
        System.out.println("isChinaName2()执行!!");
        return "isChinaName2";
    }
}

运行结果为：

isChinaName()执行!!
getEnglishName()执行!!
{"chinaName":true,"englishName":"lucy"}

代码规范

可以看出来序列化的规则还是很多的，比如有时需要关注返回值，有时需要关注参数个数，有时需要关注@JSONType注解，有时需要关注@JSONField注解；当一个事物的判别方式有多种的时候，由于团队人员掌握知识点的程度不一样，这个方差很容易导致代码问题，所以尽量有一种推荐方案。

这里推荐使用@JSONField(serialize = false)来显式的标注方法不参与序列化，下面是使用@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()执行!!");
    }

    public Boolean isChinaName() {
        System.out.println("isChinaName()执行!!");
        return true;
    }

    public String getEnglishName() {
        System.out.println("getEnglishName()执行!!");
        return "lucy";
    }

    @JSONField(serialize = false)
    public String getOtherName() {
        System.out.println("getOtherName()执行!!");
        return "lucy";
    }

    @JSONField(serialize = false)
    public String getEnglishName2() {
        System.out.println("getEnglishName2()执行!!");
        return "lucy";
    }

    @JSONField(serialize = false)
    public void getEnglishName3() {
        System.out.println("getEnglishName3()执行!!");
    }

    @JSONField(serialize = false)
    public String isChinaName2() {
        System.out.println("isChinaName2()执行!!");
        return "isChinaName2";
    }
}