記一次activiti監聽器無法實例化的錯誤解決過程(SpringBoot Listener)

慢來比較快，虛心學技術

思路永遠比答案更有價值

問題場景

SpringBoot項目中，activiti某個流程節點需要配置監聽器，當前節點任務提交完成之後觸發方法更改遠程表單的狀態，具體流程監聽設計如下：

feignClient代碼：MyService.java

@FeignClient(value = "xxxxx")
public interface MyService {

   /**
    * 修改狀態
    * @param inId
    * @return
    */
   @PutMapping("/myTest/updateState")
   Boolean updateState(@RequestParam("id") Integer id);

}

監聽器代碼：MyTaskListener.java,此處使用Lombok @AllArgConstructor註解通過全參構造器注入MyService

@AllArgsConstructor
public class MyTaskListener implements TaskListener {

    private MyService myService;

   /**
    * 任務監聽修改表單狀態
    * @param delegateTask 當前執行提交的任務
    */
   @Override
   public void notify(DelegateTask delegateTask) {
       。。。。。//獲取到表單id
       myService.updateState(id);
   }
}

任務提交完成觸發監聽器的報錯信息：couldn't instantiate class com.xxx.activiti.listener.MyTaskListener

2019-04-16 19:01:45.592 ERROR [xxx-activiti,b4057cc762e15e24,b4057cc762e15e24,true] 224 --- [  XNIO-1 task-1] o.a.e.impl.interceptor.CommandContext    : Error while closing command context

org.activiti.engine.ActivitiException: Exception while invoking TaskListener: couldn't instantiate class com.xxx.activiti.listener.MyTaskListener
    at org.activiti.engine.impl.persistence.entity.TaskEntity.fireEvent(TaskEntity.java:742)
    at org.activiti.engine.impl.persistence.entity.TaskEntity.complete(TaskEntity.java:184)
    at org.activiti.engine.impl.cmd.CompleteTaskCmd.execute(CompleteTaskCmd.java:52)
    at org.activiti.engine.impl.cmd.CompleteTaskCmd.execute(CompleteTaskCmd.java:24)
    at org.activiti.engine.impl.cmd.NeedsActiveTaskCmd.execute(NeedsActiveTaskCmd.java:59)
    at org.activiti.engine.impl.interceptor.CommandInvoker.execute(CommandInvoker.java:24)
    at org.activiti.engine.impl.interceptor.CommandContextInterceptor.execute(CommandContextInterceptor.java:57)
    at org.activiti.spring.SpringTransactionInterceptor$1.doInTransaction(SpringTransactionInterceptor.java:47)
    at org.springframework.transaction.support.TransactionTemplate.execute(TransactionTemplate.java:140)
    at org.activiti.spring.SpringTransactionInterceptor.execute(SpringTransactionInterceptor.java:45)
    at org.activiti.engine.impl.interceptor.LogInterceptor.execute(LogInterceptor.java:31)
    at org.activiti.engine.impl.cfg.CommandExecutorImpl.execute(CommandExecutorImpl.java:40)
    at org.activiti.engine.impl.cfg.CommandExecutorImpl.execute(CommandExecutorImpl.java:35)
    at org.activiti.engine.impl.TaskServiceImpl.complete(TaskServiceImpl.java:182)
    at xxx.activiti.controller.TaskController.submit(TaskController.java:181)
    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.springframewor

原因猜想

對比項目自帶的請假流程監聽類

@Slf4j
public class LeaveProcessTaskListener implements TaskListener {

   /**
    * 查詢提交人的上級
    *
    * @param delegateTask
    */
   @Override
   public void notify(DelegateTask delegateTask) {
     。。。。。
   }
}

發現，兩者區別在於 MyTaskListener引入了一個Spring的Bean，猜想應該是Bean注入失敗導致的

猜想認證

將MyTaskListener中的Bean注入暫時去除：

public class MyTaskListener implements TaskListener {

   /**
    * 任務監聽修改表單狀態
    * @param delegateTask 當前執行提交的任務
    */
   @Override
   public void notify(DelegateTask delegateTask) {
       。。。。。//獲取到表單id
       System.out.println("執行任務完成=========");
   }
}

再次執行任務提交觸發監聽器輸出：

執行任務完成=========

猜想正確

資料查詢

①Listener中無法通過構造函數進行Bean注入，必須通過setter方法注入

更改MyTaskListener中的Bean注入方式

public class MyTaskListener implements TaskListener {
    @Autowired
    private MyService myService;

   /**
    * 任務監聽修改表單狀態
    * @param delegateTask 當前執行提交的任務
    */
   @Override
   public void notify(DelegateTask delegateTask) {
       。。。。。//獲取到表單id
       myService.updateState(id);
   }
}

執行任務提交報錯：Exception while invoking TaskListener: null，錯誤NullPointException源於MyService空

2019-04-16 19:14:59.049 ERROR [xxx-activiti,b88f0f9fd6ab86e1,b88f0f9fd6ab86e1,true] 14508 --- [  XNIO-1 task-2] t.t.c.s.c.GlobalExceptionHandlerResolver : 全局異常信息 ex=Exception while invoking TaskListener: Exception while invoking TaskListener: null

org.activiti.engine.ActivitiException: Exception while invoking TaskListener: Exception while invoking TaskListener: null
    at org.activiti.engine.impl.persistence.entity.TaskEntity.fireEvent(TaskEntity.java:742)
    at org.activiti.engine.impl.persistence.entity.TaskEntity.complete(TaskEntity.java:184)
    at org.activiti.engine.impl.cmd.CompleteTaskCmd.execute(CompleteTaskCmd.java:52)
    at org.activiti.engine.impl.cmd.CompleteTaskCmd.execute(CompleteTaskCmd.java:24)
    at org.activiti.engine.impl.cmd.NeedsActiveTaskCmd.execute(NeedsActiveTaskCmd.java:59)
    at org.activiti.engine.impl.interceptor.CommandInvoker.execute(CommandInvoker.java:24)
    at org.activiti.engine.impl.interceptor.CommandContextInterceptor.execute(CommandContextInterceptor.java:57)
    at org.activiti.spring.SpringTransactionInterceptor$1.doInTransaction(SpringTransactionInterceptor.java:47)
    at org.springframework.transaction.support.TransactionTemplate.execute(TransactionTemplate.java:140)
    at org.activiti.spring.SpringTransactionInterceptor.execute(SpringTransactionInterceptor.java:45)
    at org.activiti.engine.impl.interceptor.LogInterceptor.execute(LogInterceptor.java:31)
    at org.activiti.engine.impl.cfg.CommandExecutorImpl.execute(CommandExecutorImpl.java:40)
    at org.activiti.engine.impl.cfg.CommandExecutorImpl.execute(CommandExecutorImpl.java:35)
    at org.activiti.engine.impl.TaskServiceImpl.complete(TaskServiceImpl.java:182)
    at com.xxx.activiti.controller.TaskController.submit(TaskController.java:181)
    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 or

②以上述結果爲基礎進行查詢，一說Listener未被Spring容器進行管理，所以注入爲空，我們可以在MyTaskListener上添加@Component註解，將MyTaskListener裝配到Spring容器中

@Component
public class MyTaskListener implements TaskListener {
    @Autowired
    private MyService myService;

   /**
    * 任務監聽修改表單狀態
    * @param delegateTask 當前執行提交的任務
    */
   @Override
   public void notify(DelegateTask delegateTask) {
       。。。。。//獲取到表單id
       myService.updateState(id);
   }
}

執行任務提交報錯：Exception while invoking TaskListener: null

一樣的結果

③此時懷疑是否MyTaskListener沒有成功裝配到Spring容器中，所以編寫一個工具類輸出當前ApplicationContext所有被裝配的類

@Component
public class SpringUtil implements ApplicationContextAware {

   /**
    * 當前IOC
    */
   private static ApplicationContext applicationContext;

   @Override
   public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
      this.applicationContext = applicationContext;
   }

   /**
    * 輸出當前容器中所有被裝配的類的id/bean名稱
    */
   public static void showClass(){
      String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
      for(String beanDefinitionName : beanDefinitionNames){
         System.out.println(beanDefinitionName);
      }
   }
}

任務提交後調用SpringUtil.showClass()，輸出結果：

。
。
。
myTaskListener
。
。
。
com.xxx.activiti.feign.MyService
。

證明MyTaskListener及MyService都被裝配成功

④繼續查找，得到下述解釋：

(1)Listener的生命週期是由servlet容器（例如tomcat）管理的，項目啓動時上例中的ConfigListener是由servlet容器實例化並調用其contextInitialized方法，而servlet容器並不認得@Autowired註解，因此導致ConfigService實例注入失敗。

(2)而spring容器中的bean的生命週期是由spring容器管理的。

註解的方式執行的位置，spring的注入是在filter和listener之後的，（順序:listener >> filter >> servlet >> spring ）。

如果在監聽器中有需要對容器中bean進行引用，就不能採用註解的方式了。只能手動的進行配置文件的讀取

個人理解，上述過程中MyTaskListenre雖然存在於Spring容器中，但未被Spring容器所管理，所以@Autowired失效

嘗試解決，既然註解方式不可以，那麼可以考慮使用xml配置的傳統方式，但是SpringBoot早已拋棄了xml配置方式，所以可以使用JAVA配置的老方法，手動從容器中取出Bean：

改寫SpringUtil，提供手動獲取Bean的方法

 @Component
public class SpringUtil implements ApplicationContextAware {

   /**
    * 當前IOC
    *
    */
   private static ApplicationContext applicationContext;
    /**
     * 設置applicationContext
     */
   @Override
   public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
      this.applicationContext = applicationContext;
   }

   /**
    * 從當前IOC獲取bean
    */
   public static <T> T getObject(Class<T> clazz){
       return applicationContext.getBean(clazz);
   }

   public static void showClass(){
      String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
      for(String beanDefinitionName : beanDefinitionNames){
         System.out.println(beanDefinitionName);
      }
   }
}

改寫監聽器,更改MyService的獲取方式：

@Component
public class MyTaskListener implements TaskListener {

   /**
    * 任務監聽修改表單狀態
    * @param delegateTask 當前執行提交的任務
    */
   @Override
   public void notify(DelegateTask delegateTask) {
       MyService myService= SpringUtil.getObject(MyService.class);
       。。。。。//獲取到表單id
       myService.updateState(id);
   }
}

測試運行，問題解決

解決方案

手動獲取Bean（如上）：

 @Component
public class SpringUtil implements ApplicationContextAware {

   /**
    * 當前IOC
    *
    */
   private static ApplicationContext applicationContext;

    /**
     * 設置applicationContext
     */
   @Override
   public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
      this.applicationContext = applicationContext;
   }

   public static <T> T getObject(Class<T> clazz){
       return applicationContext.getBean(clazz);
   }
 }

思路推演

|------activiti執行任務觸發監聽器報錯：couldn't instantiate class com.xxx.activiti.listener.MyTaskListener
|
|------比對正常監聽類，發現區別在於注入的Bean
|
|------確認問題所在，第一次嘗試使用@Autowired方式注入失敗，新報錯：Exception while invoking TaskListener: null,錯誤NullPointException源於MyService空
|
|-----問題定位轉移：SpringBoot中監聽器注入Spring Bean空？
|
|-----獲得解決方案且知悉原理，手動獲取Bean

備註

當初考慮過是否因爲MyService在Spring容器中註冊的ID爲：com.xxx.activiti.feign.MyService 而不是myService從而導致無法注入。而後一想，controller中可以正常注入且變量命名隨意，證明@Autowired並不是根據Bean的id進行，而是默認根據類型去獲取bean（Spring基礎知識）