一行 log 日志，引发 P1 级线上事故！

作者：老鹰汤
链接：https://juejin.cn/post/7156439842958606349
线上事故回顾

前段时间新增一个特别简单的功能，晚上上线前review代码时想到公司拼搏进取的价值观临时加一行log日志，觉得就一行简单的日志基本上没啥问题，结果刚上完线后一堆报警，赶紧回滚了代码，找到问题删除了添加日志的代码，重新上线完毕。
情景还原

定义了一个 CountryDTO

1. public class CountryDTO {
2.     private String country;
4.     public void setCountry(String country) {
5.         this.country = country;
6.     }
8.     public String getCountry() {
9.         return this.country;
10.     }
12.     public Boolean isChinaName() {
13.         return this.country.equals("中国");
14.     }
15. }

复制代码

定义测试类 FastJonTest

1. public class FastJonTest {
2.     @Test
3.     public void testSerialize() {
4.         CountryDTO countryDTO = new CountryDTO();
5.         String str = JSON.toJSONString(countryDTO);
6.         System.out.println(str);
7.     }
8. }

复制代码

运行时报空指针错误：

通过报错信息可以看出来是  序列化的过程中执行了 isChinaName()方法，这时候this.country变量为空, 那么问题来了：

• 序列化为什么会执行isChinaName()呢？
  
• 引申一下，序列化过程中会执行那些方法呢?
  

推荐一个开源免费的 Spring Boot 实战项目：

https://github.com/javastacks/spring-boot-best-practice

源码分析

通过debug观察调用链路的堆栈信息


调用链中的ASMSerializer_1_CountryDTO.write是FastJson使用asm技术动态生成了一个类ASMSerializer_1_CountryDTO,

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

JavaBeanSerizlier序列化原理

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

而JavaBeanSerializer 主要是通过 getObjectWriter()方法获取，通过对getObjectWriter()执行过程的调试，找到比较关键的com.alibaba.fastjson.serializer.SerializeConfig#createJavaBeanSerializer方法，进而找到 com.alibaba.fastjson.util.TypeUtils#computeGetters

1. public static List<FieldInfo> computeGetters(Class<?> clazz, //
2.                                                  JSONType jsonType, //
3.                                                  Map<String,String> aliasMap, //
4.                                                  Map<String,Field> fieldCacheMap, //
5.                                                  boolean sorted, //
6.                                                  PropertyNamingStrategy propertyNamingStrategy //
7.     ){
8.         //省略部分代码....
9.         Method[] methods = clazz.getMethods();
10.         for(Method method : methods){
11.             //省略部分代码...
12.             if(method.getReturnType().equals(Void.TYPE)){
13.                 continue;
14.             }
15.             if(method.getParameterTypes().length != 0){
16.                 continue;
17.             }
18.                 //省略部分代码...
19.             JSONField annotation = TypeUtils.getAnnotation(method, JSONField.class);
20.             //省略部分代码...
21.             if(annotation != null){
22.                 if(!annotation.serialize()){
23.                     continue;
24.                 }
25.                 if(annotation.name().length() != 0){
26.                     //省略部分代码...
27.                 }
28.             }
29.             if(methodName.startsWith("get")){
30.              //省略部分代码...
31.             }
32.             if(methodName.startsWith("is")){
33.              //省略部分代码...
34.             }
35.         }
36. }

复制代码

从代码中大致分为三种情况：

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

序列化流程图


示例代码

1. /**
2. * case1: @JSONField(serialize = false)
3. * case2: getXxx()返回值为void
4. * case3: isXxx()返回值不等于布尔类型
5. * case4: @JSONType(ignores = "xxx")
6. */
7. @JSONType(ignores = "otherName")
8. public class CountryDTO {
9.     private String country;
11.     public void setCountry(String country) {
12.         this.country = country;
13.     }
15.     public String getCountry() {
16.         return this.country;
17.     }
19.     public static void queryCountryList() {
20.         System.out.println("queryCountryList()执行!!");
21.     }
23.     public Boolean isChinaName() {
24.         System.out.println("isChinaName()执行!!");
25.         return true;
26.     }
28.     public String getEnglishName() {
29.         System.out.println("getEnglishName()执行!!");
30.         return "lucy";
31.     }
33.     public String getOtherName() {
34.         System.out.println("getOtherName()执行!!");
35.         return "lucy";
36.     }
38.     /**
39.      * case1: @JSONField(serialize = false)
40.      */
41.     @JSONField(serialize = false)
42.     public String getEnglishName2() {
43.         System.out.println("getEnglishName2()执行!!");
44.         return "lucy";
45.     }
47.     /**
48.      * case2: getXxx()返回值为void
49.      */
50.     public void getEnglishName3() {
51.         System.out.println("getEnglishName3()执行!!");
52.     }
54.     /**
55.      * case3: isXxx()返回值不等于布尔类型
56.      */
57.     public String isChinaName2() {
58.         System.out.println("isChinaName2()执行!!");
59.         return "isChinaName2";
60.     }
61. }

复制代码

运行结果为：

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

复制代码

代码规范

可以看出来序列化的规则还是很多的，比如有时需要关注返回值，有时需要关注参数个数，有时需要关注@JSONType注解，有时需要关注@JSONField注解；当一个事物的判别方式有多种的时候，由于团队人员掌握知识点的程度不一样，这个方差很容易导致代码问题，所以尽量有一种推荐方案。 这里推荐使用@JSONField(serialize = false)来显式的标注方法不参与序列化，下面是使用推荐方案后的代码，是不是一眼就能看出来哪些方法不需要参与序列化了。

1. public class CountryDTO {
2.     private String country;
4.     public void setCountry(String country) {
5.         this.country = country;
6.     }
8.     public String getCountry() {
9.         return this.country;
10.     }
12.     @JSONField(serialize = false)
13.     public static void queryCountryList() {
14.         System.out.println("queryCountryList()执行!!");
15.     }
17.     public Boolean isChinaName() {
18.         System.out.println("isChinaName()执行!!");
19.         return true;
20.     }
22.     public String getEnglishName() {
23.         System.out.println("getEnglishName()执行!!");
24.         return "lucy";
25.     }
27.     @JSONField(serialize = false)
28.     public String getOtherName() {
29.         System.out.println("getOtherName()执行!!");
30.         return "lucy";
31.     }
33.     @JSONField(serialize = false)
34.     public String getEnglishName2() {
35.         System.out.println("getEnglishName2()执行!!");
36.         return "lucy";
37.     }
39.     @JSONField(serialize = false)
40.     public void getEnglishName3() {
41.         System.out.println("getEnglishName3()执行!!");
42.     }
44.     @JSONField(serialize = false)
45.     public String isChinaName2() {
46.         System.out.println("isChinaName2()执行!!");
47.         return "isChinaName2";
48.     }
49. }

复制代码

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

以上流程基本遵循 发现问题 --> 原理分析 --> 解决问题 --> 升华(编程规范)。

• 围绕业务上：解决问题 -> 如何选择一种好的额解决方案 -> 好的解决方式如何扩展n个系统应用；
  
• 围绕技术上：解决单个问题，顺着单个问题掌握这条线上的原理。
  

近期热文推荐：
1.1,000+ 道 Java面试题及答案整理(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装饰器模式，这才是优雅的方式！！
5.《Java开发手册（嵩山版）》最新发布，速速下载！
觉得不错，别忘了随手点赞+转发哦！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！