【spring原始碼學習】spring的aop目標物件中進行自我呼叫，且需要實施相應的事務定義的解決方案

Love Lenka發表於2017-10-26
Spring原始碼物件

轉載：http://www.iteye.com/topic/1122740

1、預備知識

aop概念請參考【http://www.iteye.com/topic/1122401】和【http://jinnianshilongnian.iteye.com/blog/1418596】

spring的事務管理，請參考【http://jinnianshilongnian.iteye.com/blog/1441271】

使用AOP 代理後的方法呼叫執行流程，如圖所示

也就是說我們首先呼叫的是AOP代理物件而不是目標物件，首先執行事務切面，事務切面內部透過TransactionInterceptor環繞增強進行事務的增強，即進入目標方法之前開啟事務，退出目標方法時提交/回滾事務。

2、測試程式碼準備

 

    public interface AService {  
        public void a();  
        public void b();  
    }  
       
    @Service()  
    public class AServiceImpl1 implements AService{  
        @Transactional(propagation = Propagation.REQUIRED)  
        public void a() {  
            this.b();  
        }  
        @Transactional(propagation = Propagation.REQUIRES_NEW)  
        public void b() {  
        }  
    }
View Code

 

3、問題

目標物件內部的自我呼叫將無法實施切面中的增強，如圖所示

此處的this指向目標物件，因此呼叫this.b()將不會執行b事務切面，即不會執行事務增強，因此b方法的事務定義“@Transactional(propagation = Propagation.REQUIRES_NEW)”將不會實施，即結果是b和a方法的事務定義是一樣的，可以從以下日誌看出：

 org.springframework.transaction.annotation.AnnotationTransactionAttributeSource Adding transactional method 'a' with attribute: PROPAGATION_REQUIRED,ISOLATION_DEFAULT; ''

org.springframework.beans.factory.support.DefaultListableBeanFactory Returning cached instance of singleton bean 'txManager'

org.springframework.orm.hibernate4.HibernateTransactionManager Creating new transaction with name [com.sishuok.service.impl.AServiceImpl1.a]: PROPAGATION_REQUIRED,ISOLATION_DEFAULT; ''  -----建立a方法事務

org.springframework.orm.hibernate4.HibernateTransactionManager Opened new Session …… for Hibernate transaction  ---開啟Session

……

org.springframework.transaction.support.TransactionSynchronizationManager Initializing transaction synchronization

org.springframework.transaction.interceptor.TransactionInterceptor Getting transaction for [com.sishuok.service.impl.AServiceImpl1.a]

org.springframework.transaction.interceptor.TransactionInterceptor Completing transaction for [com.sishuok.service.impl.AServiceImpl1.a] ----完成a方法事務

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering beforeCommit synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering beforeCompletion synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Initiating transaction commit

 

org.springframework.orm.hibernate4.HibernateTransactionManager Committing Hibernate transaction on Session ……---提交a方法事務

或

org.springframework.orm.hibernate4.HibernateTransactionManager Rolling back Hibernate transaction on Session ……---如果有異常將回滾a方法事務

 

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering afterCommit synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering afterCompletion synchronization

org.springframework.transaction.support.TransactionSynchronizationManager Clearing transaction synchronization

……

org.springframework.orm.hibernate4.HibernateTransactionManager Closing Hibernate Session …… after transaction     --關閉Session
View Code

我們可以看到事務切面只對a方法進行了事務增強，沒有對b方法進行增強。

3、解決方案

此處a方法中呼叫b方法時，只要透過AOP代理呼叫b方法即可走事務切面，即可以進行事務增強，如下所示：

    public void a() {  
    aopProxy.b();//即呼叫AOP代理物件的b方法即可執行事務切面進行事務增強  
    }
View Code

判斷一個Bean是否是AOP代理物件可以使用如下三種方法：

AopUtils.isAopProxy(bean)        ： 是否是代理物件；

AopUtils.isCglibProxy(bean)       ： 是否是CGLIB方式的代理物件；

AopUtils.isJdkDynamicProxy(bean) ： 是否是JDK動態代理方式的代理物件；

3.1、透過ThreadLocal暴露Aop代理物件

1、開啟暴露Aop代理到ThreadLocal支援（如下配置方式從spring3開始支援）

    <aop:aspectj-autoproxy expose-proxy="true"/><!—註解風格支援-->
View Code

或者

    <aop:config expose-proxy="true"><!—xml風格支援-->
View Code

2、修改我們的業務實現類

this.b();-----------修改為--------->((AService) AopContext.currentProxy()).b();

 

3、執行測試用例，日誌如下

org.springframework.beans.factory.support.DefaultListableBeanFactory Returning cached instance of singleton bean 'txManager'

org.springframework.orm.hibernate4.HibernateTransactionManager Creating new transaction with name [com.sishuok.service.impl.AServiceImpl2.a]: PROPAGATION_REQUIRED,ISOLATION_DEFAULT; ''   -----建立a方法事務

org.springframework.orm.hibernate4.HibernateTransactionManager Opened new Session ……for Hibernate transaction  --開啟a Session

org.springframework.orm.hibernate4.HibernateTransactionManager Preparing JDBC Connection of Hibernate Session ……

org.springframework.orm.hibernate4.HibernateTransactionManager Exposing Hibernate transaction as JDBC transaction ……

……

org.springframework.transaction.support.TransactionSynchronizationManager Initializing transaction synchronization

org.springframework.transaction.interceptor.TransactionInterceptor Getting transaction for [com.sishuok.service.impl.AServiceImpl2.a]

 

org.springframework.transaction.annotation.AnnotationTransactionAttributeSource Adding transactional method 'b' with attribute: PROPAGATION_REQUIRES_NEW,ISOLATION_DEFAULT; ''

……

org.springframework.orm.hibernate4.HibernateTransactionManager Suspending current transaction, creating new transaction with name [com.sishuok.service.impl.AServiceImpl2.b]  -----建立b方法事務（並暫停a方法事務）

……

org.springframework.orm.hibernate4.HibernateTransactionManager Opened new Session  for Hibernate transaction  ---開啟b Session

……

org.springframework.transaction.support.TransactionSynchronizationManager Initializing transaction synchronization

org.springframework.transaction.interceptor.TransactionInterceptor Getting transaction for [com.sishuok.service.impl.AServiceImpl2.b]

org.springframework.transaction.interceptor.TransactionInterceptor Completing transaction for [com.sishuok.service.impl.AServiceImpl2.b] ----完成b方法事務

 

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering beforeCommit synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering beforeCompletion synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Initiating transaction commit

org.springframework.orm.hibernate4.HibernateTransactionManager Committing Hibernate transaction on Session …… ---提交b方法事務

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering afterCommit synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering afterCompletion synchronization

org.springframework.transaction.support.TransactionSynchronizationManager Clearing transaction synchronization

……

org.springframework.orm.hibernate4.HibernateTransactionManager Closing Hibernate Session …… after transaction  --關閉 b Session

 

-----到此b方法事務完畢

 

org.springframework.orm.hibernate4.HibernateTransactionManager Resuming suspended transaction after completion of inner transaction ---恢復a方法事務

……

org.springframework.transaction.support.TransactionSynchronizationManager Initializing transaction synchronization

org.springframework.transaction.interceptor.TransactionInterceptor Completing transaction for [com.sishuok.service.impl.AServiceImpl2.a] ----完成a方法事務

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering beforeCommit synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering beforeCompletion synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Initiating transaction commit

org.springframework.orm.hibernate4.HibernateTransactionManager Committing Hibernate transaction on Session ……---提交a方法事務

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering afterCommit synchronization

org.springframework.orm.hibernate4.HibernateTransactionManager Triggering afterCompletion synchronization

org.springframework.transaction.support.TransactionSynchronizationManager Clearing transaction synchronization

……

org.springframework.orm.hibernate4.HibernateTransactionManager Closing Hibernate Session …… after transaction  --關閉 a Session
View Code

此處我們可以看到b方法的事務起作用了。

 

以上方式是解決目標物件內部方法自我呼叫並實施事務的最簡單的解決方案。

4、實現原理分析

4.1、在進入代理物件之後透過AopContext.serCurrentProxy(proxy)暴露當前代理物件到ThreadLocal，並儲存上次ThreadLocal繫結的代理物件為oldProxy；

4.2、接下來我們可以透過 AopContext.currentProxy() 獲取當前代理物件；

4.3、在退出代理物件之前要重新將ThreadLocal繫結的代理物件設定為上一次的代理物件，即AopContext.serCurrentProxy(oldProxy)。

 

有些人不喜歡這種方式，說透過ThreadLocal暴露有效能問題，其實這個不需要考慮，因為事務相關的（Session和Connection）內部也是透過SessionHolder和ConnectionHolder暴露到ThreadLocal實現的。

 

不過自我呼叫這種場景確實只有很少情況遇到，因此不用這種方式我們也可以透過如下方式實現。

3.2、透過初始化方法在目標物件中注入代理物件

 

    @Service  
    public class AServiceImpl3 implements AService{  
        @Autowired  //①  注入上下文  
        private ApplicationContext context;  
          
        private AService proxySelf; //②  表示代理物件，不是目標物件  
        @PostConstruct  //③ 初始化方法  
        private void setSelf() {  
            //從上下文獲取代理物件（如果透過proxtSelf=this是不對的，this是目標物件）  
            //此種方法不適合於prototype Bean，因為每次getBean返回一個新的Bean  
            proxySelf = context.getBean(AService.class);   
        }  
        @Transactional(propagation = Propagation.REQUIRED)  
        public void a() {  
           proxySelf.b(); //④ 呼叫代理物件的方法 這樣可以執行事務切面  
        }  
        @Transactional(propagation = Propagation.REQUIRES_NEW)  
        public void b() {  
        }  
    }
View Code

 

此處日誌就不分析，和3.1類似。此種方式不是很靈活，所有需要自我呼叫的實現類必須重複實現程式碼。

3.3、透過BeanPostProcessor 在目標物件中注入代理物件

此種解決方案可以參考http://fyting.iteye.com/blog/109236。

 

BeanPostProcessor 的介紹和使用敬請等待我的下一篇分析帖。

 

一、定義BeanPostProcessor 需要使用的標識介面

    public interface BeanSelfAware {  
        void setSelf(Object proxyBean);  
    }
View Code

即我們自定義的BeanPostProcessor （InjectBeanSelfProcessor）如果發現我們的Bean是實現了該標識介面就呼叫setSelf注入代理物件。

二、Bean實現

    @Service  
    public class AServiceImpl4 implements AService, BeanSelfAware {//此處省略介面定義  
        private AService proxySelf;  
        public void setSelf(Object proxyBean) { //透過InjectBeanSelfProcessor注入自己（目標物件）的AOP代理物件  
            this.proxySelf = (AService) proxyBean;  
        }  
        @Transactional(propagation = Propagation.REQUIRED)  
        public void a() {  
            proxySelf.b();//呼叫代理物件的方法 這樣可以執行事務切面  
        }  
        @Transactional(propagation = Propagation.REQUIRES_NEW)  
        public void b() {  
        }  
    }
View Code

實現BeanSelfAware標識介面的setSelf將代理物件注入，並且透過“proxySelf.b()”這樣可以實施b方法的事務定義。

三、InjectBeanSelfProcessor實現

    @Component  
    public class InjectBeanSelfProcessor implements BeanPostProcessor {  
        public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {  
            return bean;  
        }  
        public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {  
            if(bean instanceof BeanSelfAware) {//如果Bean實現了BeanSelfAware標識介面，就將代理物件注入  
                ((BeanSelfAware) bean).setSelf(bean); //即使是prototype Bean也可以使用此種方式  
            }  
            return bean;  
        }  
    }
View Code

postProcessAfterInitialization根據目標物件是否實現BeanSelfAware標識介面，透過setSelf(bean)將代理物件（bean）注入到目標物件中，從而可以完成目標物件內部的自我呼叫。

 

關於BeanPostProcessor的執行流程等請一定參考我的這篇帖子，否則無法繼續往下執行。

四、InjectBeanSelfProcessor的問題

（1、場景：透過InjectBeanSelfProcessor進行注入代理物件且迴圈依賴場景下會產生前者無法透過setSelf設定代理物件的問題。 迴圈依賴是應該避免的，但是實際工作中不可避免會有人使用這種注入，畢竟沒有強制性。

 

（2、用例

（2.1、定義BeanPostProcessor 需要使用的標識介面

和3.1中一樣此處不再重複。

 

（2.2、Bean實現

    @Service  
    public class AServiceImpl implements AService, BeanSelfAware {//此處省略Aservice介面定義  
        @Autowired  
        private BService bService;   //①  透過@Autowired方式注入BService  
        private AService self;       //②  注入自己的AOP代理物件  
        public void setSelf(Object proxyBean) {  
            this.self = (AService) proxyBean;  //③ 透過InjectBeanSelfProcessor注入自己（目標物件）的AOP代理物件  
            System.out.println("AService=="+ AopUtils.isAopProxy(this.self)); //如果輸出true標識AOP代理物件注入成功  
        }  
        @Transactional(propagation = Propagation.REQUIRED)  
        public void a() {  
            self.b();  
        }  
        @Transactional(propagation = Propagation.REQUIRES_NEW)  
        public void b() {  
        }  
    }
View Code
    @Service  
    public class BServiceImpl implements BService, BeanSelfAware {//此處省略Aservice介面定義  
        @Autowired  
        private AService aService;  //①  透過@Autowired方式注入AService  
        private BService self;      //②  注入自己的AOP代理物件  
        public void setSelf(Object proxyBean) {  //③ 透過InjectBeanSelfProcessor注入自己（目標物件）的AOP代理物件  
            this.self = (BService) proxyBean;  
            System.out.println("BService=" + AopUtils.isAopProxy(this.self)); //如果輸出true標識AOP代理物件注入成功  
        }  
        @Transactional(propagation = Propagation.REQUIRED)  
        public void a() {  
            self.b();  
        }  
        @Transactional(propagation = Propagation.REQUIRES_NEW)  
        public void b() {  
        }  
    }
View Code

此處A依賴B，B依賴A，即構成迴圈依賴，此處不探討迴圈依賴的設計問題（實際工作應該避免迴圈依賴），只探討為什麼迴圈依賴會出現注入代理物件失敗的問題。

 

迴圈依賴請參考我的博文【http://jinnianshilongnian.iteye.com/blog/1415278】。

依賴的初始化和銷燬順序請參考我的博文【http://jinnianshilongnian.iteye.com/blog/1415461】。

（2.3、InjectBeanSelfProcessor實現

和之前3.3中一樣 此處不再重複。

 

（2.4、測試用例

 

    @RunWith(value = SpringJUnit4ClassRunner.class)  
    @ContextConfiguration(value = {"classpath:spring-config.xml"})  
    public class SelfInjectTest {  
        @Autowired  
        AService aService;  
        @Autowired  
        BService bService;  
        @Test  
        public void test() {  
        }  
    }
View Code

執行如上測試用例會輸出：

BService=true

AService==false

即BService透過InjectBeanSelfProcessor注入代理物件成功，而AService卻失敗了（實際是注入了目標物件），如下是debug得到的資訊：

（2. 5、這是為什麼呢，怎麼在迴圈依賴會出現這種情況？

 

敬請期待我的下一篇分析帖。

3.4、改進版的InjectBeanSelfProcessor的解決方案

    @Component  
    public class InjectBeanSelfProcessor2 implements BeanPostProcessor, ApplicationContextAware {  
        private ApplicationContext context;  
        //① 注入ApplicationContext  
        public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {  
            this.context = applicationContext;  
        }  
        public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {  
            if(!(bean instanceof BeanSelfAware)) { //② 如果Bean沒有實現BeanSelfAware標識介面 跳過  
                return bean;  
            }  
            if(AopUtils.isAopProxy(bean)) { //③ 如果當前物件是AOP代理物件，直接注入  
                ((BeanSelfAware) bean).setSelf(bean);  
            } else {  
                //④ 如果當前物件不是AOP代理，則透過context.getBean(beanName)獲取代理物件並注入  
                //此種方式不適合解決prototype Bean的代理物件注入  
                ((BeanSelfAware)bean).setSelf(context.getBean(beanName));  
            }  
            return bean;  
        }  
        public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {  
            return bean;  
        }  
    }
View Code

5、總結

縱觀其上：

【3.1 透過ThreadLocal暴露Aop代理物件】適合解決所有場景（不管是singleton Bean還是prototype Bean）的AOP代理獲取問題（即能解決目標物件的自我呼叫問題）；

 

【3.2 透過初始化方法在目標物件中注入代理物件】 和【3.4 改進版的InjectBeanSelfProcessor的解決方案】能解決普通（無迴圈依賴）的AOP代理物件注入問題，而且也能解決【3.3】中提到的迴圈依賴（應該是singleton之間的迴圈依賴）造成的目標物件無法注入AOP代理物件問題，但該解決方案不適合解決迴圈依賴中包含prototype Bean的自我呼叫問題；

 

【3.3 透過BeanPostProcessor 在目標物件中注入代理物件】：只能解決 普通（無迴圈依賴）的 的Bean注入AOP代理，無法解決迴圈依賴的AOP代理物件注入問題，即無法解決目標物件的自我呼叫問題。

 

jingnianshilongnian 寫道

spring允許的迴圈依賴（只考慮單例和原型Bean）：
A----B
B----A
只有在A和B都不為原型是允許的，即如果A和B都是prototype則會報錯（無法進行原型Bean的迴圈依賴）。
A（單例）---B（單例） 或 A（原型）---B（單例） 這是可以的，但 A（原型）---B（原型）或 A（原型）---B（單例Lazy）【且context.getBean("A")】時 這是不允許的。

一、A（原型）---B（原型） A（原型）---B（單例Lazy）【且context.getBean("A")】 會報：
Error creating bean with name 'BServiceImpl': Injection of autowired dependencies failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: private com.sishuok.issue.AService com.sishuok.issue.impl.BServiceImpl.aService; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'AServiceImpl': Injection of autowired dependencies failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: private com.sishuok.issue.BService com.sishuok.issue.impl.AServiceImpl.bService; nested exception is org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name 'BServiceImpl': Requested bean is currently in creation: [color=red]Is there an unresolvable circular reference[/color]?

二、A（原型）---B（單例） 和 A（單例）---B（單例）
這種方式 使用我的 【3.3 透過BeanPostProcessor 在目標物件中注入代理物件】 是沒有問題的。

因此【 3.4 改進版的InjectBeanSelfProcessor的解決方案 】 可以作為最後的解決方案。

 

相關文章