深入學習Spring Boot排查 @Transactional 引起的 NullPointerException問題

寫在前面

這個demo來說明怎么排查一個@Transactional引起的NullPointerException。

https://github.com/hengyunabc/spring-boot-inside/tree/master/demo-Transactional-NullPointerException

定位 NullPointerException 的代碼

Demo是一個簡單的spring事務例子，提供了下面一個StudentDao，并用@Transactional來聲明事務：

@Component
@Transactional
public class StudentDao {
 @Autowired
 private SqlSession sqlSession;
 public Student selectStudentById(long id) {
  return sqlSession.selectOne("selectStudentById", id);
 }
 public final Student finalSelectStudentById(long id) {
  return sqlSession.selectOne("selectStudentById", id);
 }
}

應用啟動后，會依次調用selectStudentById和finalSelectStudentById：

@PostConstruct
 public void init() {
  studentDao.selectStudentById(1);
  studentDao.finalSelectStudentById(1);
 }

用mvn spring-boot:run 或者把工程導入IDE里啟動，拋出來的異常信息是：

Caused by: java.lang.NullPointerException
 at sample.mybatis.dao.StudentDao.finalSelectStudentById(StudentDao.java:27)
 at com.example.demo.transactional.nullpointerexception.DemoNullPointerExceptionApplication.init(DemoNullPointerExceptionApplication.java:30)
 at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
 at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
 at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
 at java.lang.reflect.Method.invoke(Method.java:498)
 at org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor$LifecycleElement.invoke(InitDestroyAnnotationBeanPostProcessor.java:366)
 at org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor$LifecycleMetadata.invokeInitMethods(InitDestroyAnnotationBeanPostProcessor.java:311)

為什么應用代碼里執行selectStudentById沒有問題，而執行finalSelectStudentById就拋出NullPointerException?

同一個bean里，明明SqlSession sqlSession已經被注入了，在selectStudentById里它是非null的。為什么finalSelectStudentById函數里是null？

獲取實際運行時的類名

當然，我們對比兩個函數，可以知道是因為finalSelectStudentById的修飾符是final。但是具體原因是什么呢？

我們先在拋出異常的地方打上斷點，調試代碼，獲取到具體運行時的class是什么：

System.err.println(studentDao.getClass());

打印的結果是：

class sample.mybatis.dao.StudentDao$$EnhancerBySpringCGLIB$$210b005d

可以看出是一個被spring aop處理過的類，但是它的具體字節碼內容是什么呢？

dumpclass分析

我們使用dumpclass工具來把jvm里的類dump出來：

https://github.com/hengyunabc/dumpclass

wget http://search.maven.org/remotecontent?filepath=io/github/hengyunabc/dumpclass/0.0.1/dumpclass-0.0.1.jar -O dumpclass.jar

找到java進程pid：

$ jps
5907 DemoNullPointerExceptionApplication

把相關的類都dump下來：

sudo java -jar dumpclass.jar 5907 'sample.mybatis.dao.StudentDao*' /tmp/dumpresult

反匯編分析

用javap或者圖形化工具jd-gui來反編繹sample.mybatis.dao.StudentDao$$EnhancerBySpringCGLIB$$210b005d。

反編繹后的結果是：

class StudentDao$$EnhancerBySpringCGLIB$$210b005d extends StudentDao

StudentDao$$EnhancerBySpringCGLIB$$210b005d里沒有finalSelectStudentById相關的內容

selectStudentById實際調用的是this.CGLIB$CALLBACK_0，即MethodInterceptor tmp4_1，等下我們實際debug，看具體的類型

public final Student selectStudentById(long paramLong)
 {
 try
 {
  MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
  if (tmp4_1 == null)
  {
  tmp4_1;
  CGLIB$BIND_CALLBACKS(this);
  }
  MethodInterceptor tmp17_14 = this.CGLIB$CALLBACK_0;
  if (tmp17_14 != null)
  {
  Object[] tmp29_26 = new Object[1];
  Long tmp35_32 = new java/lang/Long;
  Long tmp36_35 = tmp35_32;
  tmp36_35;
  tmp36_35.<init>(paramLong);
  tmp29_26[0] = tmp35_32;
  return (Student)tmp17_14.intercept(this, CGLIB$selectStudentById$0$Method, tmp29_26, CGLIB$selectStudentById$0$Proxy);
  }
  return super.selectStudentById(paramLong);
 }
 catch (RuntimeException|Error localRuntimeException)
 {
  throw localRuntimeException;
 }
 catch (Throwable localThrowable)
 {
  throw new UndeclaredThrowableException(localThrowable);
 }
 }

再來實際debug，盡管StudentDao$$EnhancerBySpringCGLIB$$210b005d的代碼不能直接看到，但是還是可以單步執行的。

在debug時，可以看到

1. StudentDao$$EnhancerBySpringCGLIB$$210b005d里的所有field都是null

2. this.CGLIB$CALLBACK_0的實際類型是CglibAopProxy$DynamicAdvisedInterceptor，在這個Interceptor里實際保存了原始的target對象

3. CglibAopProxy$DynamicAdvisedInterceptor在經過TransactionInterceptor處理之后，最終會用反射調用自己保存的原始target對象

拋出異常的原因

所以整理下整個分析：

1.在使用了@Transactional之后，spring aop會生成一個cglib代理類，實際用戶代碼里@Autowired注入的StudentDao也是這個代理類的實例

2.cglib生成的代理類StudentDao$$EnhancerBySpringCGLIB$$210b005d繼承自StudentDao

3.StudentDao$$EnhancerBySpringCGLIB$$210b005d里的所有field都是null

4.StudentDao$$EnhancerBySpringCGLIB$$210b005d在調用selectStudentById，實際上通過CglibAopProxy$DynamicAdvisedInterceptor，最終會用反射調用自己保存的原始target對象

5.所以selectStudentById函數的調用沒有問題

那么為什么finalSelectStudentById函數里的SqlSession sqlSession會是null，然后拋出NullPointerException？

1.StudentDao$$EnhancerBySpringCGLIB$$210b005d里的所有field都是null

2.finalSelectStudentById函數的修飾符是final，cglib沒有辦法重寫這個函數

3.當執行到finalSelectStudentById里，實際執行的是原始的StudentDao里的代碼
4.但是對象是StudentDao$$EnhancerBySpringCGLIB$$210b005d的實例，它里面的所有field都是null，所以會拋出NullPointerException

解決問題辦法

1.最簡單的當然是把finalSelectStudentById函數的final修飾符去掉

2.還有一種辦法，在StudentDao里不要直接使用sqlSession，而通過getSqlSession()函數，這樣cglib也會處理getSqlSession()，返回原始的target對象

總結

1.排查問題多debug，看實際運行時的對象信息

2。對于cglib生成類的字節碼，可以用dumpclass工具來dump，再反編繹分析

總結

以上所述是小編給大家介紹的深入學習Spring Boot排查 @Transactional 引起的 NullPointerException問題，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對億速云網站的支持！