关于我加了一行日志搞崩了服务这件小事（上）
前言
周三的时候，组内出现了一个线上问题，影响到了若干个用户的下单、支付等操作。然而实际查询到问题的原因时，发现只是由于一行小小的日志打印导致的错误。
以下的文章内容分为主要分为三部分：
1、对案件的发生进行回顾；
2、分析案件发生的原因；
3、对案件总结与反思
以三章内容来回顾出现的问题，以及提供未来的预防策略。
案件回顾
周三的时候，服务频繁收到报警，系统频繁爆出空指针异常。值班同学根据报错的错误栈，快速定位到了错误的代码行。
at com.alibaba.fastjson.serializer.JSONSerializer.write(JSONSerializer.java:285)
at com.alibaba.fastjson.JSON.toJSONString(JSON.java:696)找到代码行后却让值班同学感到疑惑：“这个明显是fastjson的日志打印呀，这也会有什么错误么？”。旁边的同事看完却惊呼一声：“fastJson打印日志会调用对象内的其余的get方法的呀！”。
（PS：该对象是一个DDD的核心域对象，其中包含一些业务场景方法被命名为getXXX方法的，因此执行Json序列化打印也就可能因为部分数据为空而出现空指针。）
定位到了问题原因，本着优先止损的原则，值班同事快速上线代码删除了这行日志打印。系统暂时的恢复了正常，没有再出现新增的报错信息了。然而后续还有漫长的数据修复、更正的过程。
案件分析：
案件复原：
本质上来说，这起线上事故出现的原因主要是因为fastJson序列化时，会将手工编写的一些方法认为是待输出属性对象，那么如果这些方法包含一些业务逻辑代码的时候，就会存在出现异常的风险。这里我们简单复现一下场景：
@Data
public class CoreData {
//正常的属性
public String normalProperties = "normalProperties";
/**
* 以get开头的方法 不是期望输出的属性
* @return
*/
public String getFuncProperties(){
return "getFuncProperties";
}
/**
* 以is开头的方法 不是期望输出的属性
* @return
*/
public Boolean isType(){
return true;
}
}如上代码是我们编写的一个纯代码类，可以看到，我们实际期望设置的属性应该只有一个normalPropertites。
public static void main(String[] args) {
CoreData data = new CoreData();
String dataString = JSONObject.toJSONString(data);
System.out.println(dataString); // 对应正常的业务逻辑
}进而我还写了一段针对当前对象进行打印的代码，从上可以看到，就是简单的对对象进行JSON序列化后打印输出。按照我们的期望来说，只是期望输出normalProperties这一个固有的字符串属性。随后我运行了代码，得到了如下的结果：
可以看到，一个类型+两个方法，都被JSON序列化后输出了。那么如果此时我们在getFuncProperties()这样的方法中如果出现了异常，就会影响整个业务的运行。例如我们把方法改成如下的例子：
public String getFuncProperties(){
double a = 2/0;
return "getFuncProperties";
}可以看到，我们原本的逻辑可能只是想输出normalProperties属性，但是因为getFuncProperties2/0是无法进行运算的，导致了系统直接报错了。那么此时，main函数中的输出方法（对应于我们正常业务逻辑），也就无法再继续执行了，而这在生产环境上无疑是致命的。
背后原理：
(PS: 以下讨论内容均基于1.2.9版本的fastJson。)
根据报错的问题点，结合debug，很快找到了问题所在：
在com.alibaba.fastjson.serializer.JSONSerializer#write(java.lang.Object)这个方法中，Fastjson所创建的ObjectSerializer对象中，nature下所包含的getters对象有三个。这明显不符合我们的预期。那么我们就需要找到他是如何获取到这三个方法的。紧跟着我们进行追入，在com.alibaba.fastjson.serializer.SerializeConfig#getObjectWriter方法下找到了这行代码：
put(clazz, createJavaBeanSerializer(clazz));很明显，这里的createJavaBeanSerializer(clazz)创建了javaBean的序列化器。对于该方法，其主要的逻辑流程就是判断当前的对象类型是否符合使用ASM的序列化器。这里一通判断下来，是符合采用ASM序列化的要求的，因此，我们又进一步定位到了如下代码：
ObjectSerializer asmSerializer = createASMSerializer(clazz);在createASMSerializer对应的方法中，最关键的代码莫过于下面这行了：
List<FieldInfo> unsortedGetters = TypeUtils.computeGetters(clazz, jsonType, aliasMap, false);这力的代码会生成对应的fieldInfo对象，也正好对应了前面我们涉及到的那三个方法，这里让我们仔细看一下com.alibaba.fastjson.util.TypeUtils#computeGetters所对应的代码：
public static List<FieldInfo> computeGetters(Class clazz, JSONType jsonType, Map<String, String> aliasMap, boolean sorted) {
Map<String, FieldInfo> fieldInfoMap = new LinkedHashMap<String, FieldInfo>();
for (Method method : clazz.getMethods()) {
String methodName = method.getName();
int ordinal = 0, serialzeFeatures = 0;
String label = null;
//判读当前方法是否为静态的
if (Modifier.isStatic(method.getModifiers())) {
continue;
}
//若返回值为void则此时不需要处理
if (method.getReturnType().equals(Void.TYPE)) {
continue;
}
//若此时入参不为空则跳过
if (method.getParameterTypes().length != 0) {
continue;
}
//若返回类型是类加载器也进行跳过。
if (method.getReturnType() == ClassLoader.class) {
continue;
}
//若方法名是getMetaClass也跳过
if (method.getName().equals("getMetaClass")
&& method.getReturnType().getName().equals("groovy.lang.MetaClass")) {
continue;
}
//获取方法的有关JSONField的注释
JSONField annotation = method.getAnnotation(JSONField.class);
if (annotation == null) {
//若当前类为空，则再获取父类的。
annotation = getSupperMethodAnnotation(clazz, method);
}
if (annotation != null) {
//若父类不为空则进行序列化的判断，我们使用的例子无继承，这部分先忽略不看。
......
}
//重点来了，判断当前是否以get开头
if (methodName.startsWith("get")) {
//长度小于4，即不满足getXX的格式的，直接跳过。
if (methodName.length() < 4) {
continue;
}
//getClass的进行跳过
if (methodName.equals("getClass")) {
continue;
}
//获取第四个位置的字符
char c3 = methodName.charAt(3);
String propertyName;
if (Character.isUpperCase(c3) || c3 > 512 ) {
//若方法遵循驼峰的写法：则依次取出对应的名称信息
if (compatibleWithJavaBean) {
propertyName = decapitalize(methodName.substring(3));
} else {
propertyName = Character.toLowerCase(methodName.charAt(3)) + methodName.substring(4);
}
} else if (...) {
//这里针对部分特殊的写法：如get_X、getfX做了特殊的判断处理。
} else {
continue;
}
作者：DrLauPen
来源：juejin.cn/post/7134513215890784293
