Lombok注解引發(fā)的空指針問題分析

一、問題描述

在一次上線后，日志中出現(xiàn)空指針的報(bào)錯(cuò)，但是報(bào)錯(cuò)代碼位置以及相應(yīng)工具類未進(jìn)行過修改，接下來進(jìn)一步分析。

以下為報(bào)錯(cuò)堆棧信息：

java.lang.NullPointerException: null
	at net.sf.cglib.core.ReflectUtils.getMethodInfo(ReflectUtils.java:424) ~[cglib-3.1.jar:?]
	at net.sf.cglib.beans.BeanCopier$Generator.generateClass(BeanCopier.java:133) ~[cglib-3.1.jar:?]
	at net.sf.cglib.core.DefaultGeneratorStrategy.generate(DefaultGeneratorStrategy.java:25) ~[cglib-3.1.jar:?]
	at net.sf.cglib.core.AbstractClassGenerator.create(AbstractClassGenerator.java:216) ~[cglib-3.1.jar:?]
	at net.sf.cglib.beans.BeanCopier$Generator.create(BeanCopier.java:90) ~[cglib-3.1.jar:?]
	at net.sf.cglib.beans.BeanCopier.create(BeanCopier.java:50) ~[cglib-3.1.jar:?]
	at ***.CglibBeanCopier.copyProperties(CglibBeanCopier.java:90) ~[***.jar:1.2.0]
	at ***.CglibBeanCopier.copyProperties(CglibBeanCopier.java:113) ~[***.jar:1.2.0]
	at ***.CglibBeanCopier.copyPropertiesOfList(CglibBeanCopier.java:123) ~[***.jar:1.2.0]
	
	..省略

?

二、問題分析

1.分析鏈路長，直接拋結(jié)論

通過Lombok提供的功能使得我們不必在對象中顯式定義get和set方法。并且Lombok提供鏈?zhǔn)?a target="_blank">編程，通過在對象頭部加上@Accessors(chain = true)注解，給屬性賦值時(shí)，可以寫成obj.setA(a).setB(b).setC(c)，省去先new再對屬性逐個(gè)set賦值。使用了該注解，這個(gè)類的set方法返回我就不是void而是this對象本身。

@Accessors(chain = true)
public class YourClass {
    private int a;

    @Setter
    public YourClass setA(int a) {
        this.a = a;
        return this;
    }
}

而JDK Introspector（它為目標(biāo)JavaBean提供了一種了解原類方法、屬性和事件的標(biāo)準(zhǔn)方法）中對寫入方法是有特殊判斷的，截取Introspector.getBeanInfo(beanClass)中一段源碼，只有返回值是void，且方法名以set作為前綴的，才會被當(dāng)做writeMethod，即寫入方法。所以返回值為void且是“set”開頭的才是Introspector認(rèn)為的寫入方法，一種狹義的定義。

else if (argCount == 1) {
   if (int.class.equals(argTypes[0]) && name.startsWith(GET_PREFIX)) {
      pd = new IndexedPropertyDescriptor(this.beanClass, name.substring(3), null, null, method, null);
   } else if (void.class.equals(resultType) && name.startsWith(SET_PREFIX)) {
      // Simple setter
      pd = new PropertyDescriptor(this.beanClass, name.substring(3), null, method);
      if (throwsException(method, PropertyVetoException.class)) {
         pd.setConstrained(true);
      }
   }
}

像BeanCopier依賴Introspector的writeMethod對目標(biāo)類賦值的工具，在轉(zhuǎn)換使用了@Accessors(chain = true)注解的類時(shí)，在獲取屬性描述PropertyDescriptor就不會返回這個(gè)屬性的writeMethod屬性，就相當(dāng)于該類的屬性沒有“寫入方法”，這就造成了拷貝對象過程中出現(xiàn)空指針問題。

2.分析路徑

List mtProcessDtoList = **WaybillProvider.getMtWayBillProcess(**);
List mtProcessList = CglibBeanCopier.copyPropertiesOfList(mtProcessDtoList, WaybillProcess.class);
if(CollectionUtils.isNotEmpty(mtProcessList)) {
   waybillProcessList.addAll(mtProcessList);
}

（1）通過報(bào)錯(cuò)信息定位到代碼端，通常情況看到mtProcessDtoList是從服務(wù)中獲取，第一印象認(rèn)為對象是可能為null，其實(shí)不然，仔細(xì)看堆棧，問題還是出在工具類里，

“***.CglibBeanCopier.copyProperties”，繼續(xù)看這段代碼是存在判空操作的，造成空指針的還是copyProperties這個(gè)方法。

public static  List copyPropertiesOfList(List sourceList, Class targetClass) {
    if (sourceList == null || sourceList.isEmpty()) {
        return Collections.emptyList();
    }
    List resultList = new ArrayList(sourceList.size());
    for (Object o : sourceList) {
        resultList.add(copyProperties(o, targetClass));
    }
    return resultList;
}

（2）具體看copyProperties這個(gè)代碼的實(shí)現(xiàn)，工具類的封裝的底層能力是BeanCopier提供的，從傳參來看并沒有我們常見的傳null后對null進(jìn)行操作引起的空指針，還需要對BeanCopier的源碼進(jìn)行分析。

public static void copyProperties(Object source, Object target) {
    if(source == null || target == null) {
        log.error("對象屬性COPY時(shí)入?yún)榭?source:{},target:{}",JSON.toJSONString(source), JSON.toJSONString(target));
            return;
    }
    if(source instanceof List && target instanceof List) {
            throw new ParamErrorException("請使用[copyProperties(a,b,c)]方法進(jìn)行集合類的值拷貝");
    }
    String beanKey = generateKey(source.getClass(), target.getClass());
    BeanCopier copier;
    if (! beanCopierMap.containsKey(beanKey)) {
        copier = BeanCopier.create(source.getClass(), target.getClass(), false);
        beanCopierMap.put(beanKey, copier);
     } else {
        copier = beanCopierMap.get(beanKey);
     }
     copier.copy(source, target, null);
}

（3）由于jar是進(jìn)行反編譯的，堆棧里提供的代碼行數(shù)已經(jīng)失真了，直接貼上報(bào)空指針的源碼截圖。

getMethodInfo入?yún)ember是null，從而導(dǎo)致空指針。需要通過斷點(diǎn)跟蹤運(yùn)行時(shí)的變量值，找到setters數(shù)組中的元素是如何生成的。

（4）target是作為對象拷貝的目標(biāo)對象的類，setters這個(gè)數(shù)組就是通過反射獲取該目標(biāo)類的所有具備讀方法的描述對象（PropertyDescriptor對象，可以理解為屬性/方法描述）。這里面方法名有些歧義，不是說只返回getter相關(guān)的屬性對象，返回的是該類所有具備讀或?qū)懛椒ǖ膶傩悦枋?，兩個(gè)布爾值的類型分別控制校驗(yàn)讀或?qū)憽?/p>

綜上，由于無法獲取目標(biāo)類的writeMethod，從而沒有辦法找到這個(gè)屬性的寫入方法，就沒有辦法對目標(biāo)對象繼續(xù)賦值。

此時(shí)方向就轉(zhuǎn)到了目標(biāo)類的實(shí)現(xiàn)上，分析到這里就跟Lombok產(chǎn)生了聯(lián)系。此處確實(shí)被修改過，WaybillProcess類增加了@Accessors這個(gè)注解。

@Setter
@Getter
@Accessors(chain = true)
public class WaybillProcess {}

（5）WaybillProcess使用了@Accessors(chain = true)這個(gè)注解，這就回到了開頭提到的，在使用了這個(gè)注解后該類生成的set方法返回值就不是void而是this，在通過Introspector獲取屬性描述時(shí)就不會被認(rèn)定是寫入方法，在去掉這個(gè)注解后，writeMethodName就有值了。

三、解決辦法

解決辦法1：刪除該注解，將工程里鏈?zhǔn)絪et改成了常規(guī)的set賦值方式。

解決辦法2：保留該注解，替換對象拷貝的工具類，建議使用MapStruct配合Lombok，直接在編譯時(shí)生成get/set方法，更加安全，功能也更加強(qiáng)大。

四、總結(jié)

凡是依賴JDK Introspector獲取類set方法描述的工具類、組件都會受到其寫入方法定義導(dǎo)致的一些列問題，目前在工程實(shí)踐中遇到了BeanCopier進(jìn)行對象拷貝、BeanUtils對屬性進(jìn)行賦值都會遇到問題。所以大家在日常開發(fā)過程中，如果該類已經(jīng)被大面積的使用，在使用組件特性時(shí)需要多留意。

對于對象拷貝已經(jīng)有很多最佳實(shí)踐了，有相關(guān)的文章大家可以推薦一下。

感謝閱讀！

審核編輯 黃宇