线上事端回顾

前段时间新增一个特别简略的功用,晚上上线前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.writeFastJson运用asm技术动态生成了一个类ASMSerializer_1_CountryDTO,

asm技术其间一项运用场景便是通过到动态生成类用来替代java反射,从而防止重复实行时的反射开支

JavaBeanSerizlier序列化原理

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

我代码就加了一行log日志,成果引发了P1的线上事端
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)来显式的标示方法不参与序列化,下面是运用引荐计划后的代码,是不是一眼就能看出来哪些方法不需求参与序列化了。

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";
    }
}

三个频率高的序列化的情况

我代码就加了一行log日志,成果引发了P1的线上事端
以上流程根本遵照 发现问题 –> 原理分析 –> 处理问题 –> 进步(编程规范)。

  • 盘绕事务上:处理问题 -> 怎样挑选一种好的额处理计划 -> 好的处理方法怎样扩展n个体系使用;
  • 盘绕技术上:处理单个问题,顺着单个问题掌握这条线上的原理。