解決Spring AOP 同類調用失效問題

Posted on by

背景

當初剛到公司實習不久，就遇到一個問題：在同一個類中，調用有@redis,@Transactional的方法，發現註解失效瞭。因為這個問題，我當時糾結瞭很久。最後，還是老大一語驚醒夢中人，歸根結底，還是Spring Aop原理沒有理解徹底。今天就來聊一下關於”Spring AOP 同類調用失效問題”。

一 目標

深入探究”Spring AOP 同類調用失效問題”，並且深刻理解Spring Aop的底層原理。

二 概述

在使用自定義註解形式的@redis做緩存時，@redis失效，分析原因。在此聲明一下：@redis這個註解是的底層其實就是反射，這個以後我會分享一下自定義註解@redis的設計。如果你使用過SpringBoot的話，其實SpringBoot裡面也是可以引入像@redis這樣的註解的。這個註解的作用就是將方法的返回值緩存到redis中。

三 工作中遇到的實例

應用商店中根據imeiSnCode來查詢安裝列表,並且打算緩存到redis中。但是發現用以下的方法發現數據沒有緩存到redis中。

1.源代碼

@Service("installedRecordService")
public class InstalledRecordServiceImpl implements InstalledRecordService{
 
@Resource
private InstalledRecordMapper installedRecordMapper;
 
@Override
public void getInstalledApks() {
List<String> imeiSnCodes = installedRecordMapper.queryImeiCode();
if (imeiSnCodes != null && imeiSnCodes.size()> 0) {
for(int i=0;i<imeiSnCodes.size();i++){
getInstalledApk(imeiSnCodes.get(i));
 
}
}
} 
 
@Redis(value=RedisKeys.INSTALLED_APK,keyArgs={0},sync=true,cacheNull=false,ttl=Constants.INSTALLED_APK_TIME,action=RedisAction.STAB_REDIS)
public List<InstalledRecord> getInstalledApk(final String code){
return installedRecordMapper.listByImeiSnCode(code);
}
}

2.原因分析

首先我們看一下Spring Aop的原理圖(此圖摘抄於網絡)：  

我長話短說，也就是說我們首先調用的是AOP代理對象而不是目標對象。但是我們使用this.getInstalledApk(imeiSnCodes.get(i))時，this表示的是當前的對象，而不是代理對象，因此註解失效。

四 解決方法

1.方法一

最簡單的方法就是將getInstalledApks()方法放在另外的一個類中進行調用，就不會出現這種問題瞭。代碼省略。

2.方法二

暴露AOP代理對象：

<aop:aspectj-autoproxy expose-proxy="true"/>

仍然在同一個類中調用代碼，但是改為如下的形式：

@Service("installedRecordService")
public class InstalledRecordServiceImpl implements InstalledRecordService{
 
@Resource
private InstalledRecordMapper installedRecordMapper;
 
@Override
public void getInstalledApks() {
List<String> imeiSnCodes = installedRecordMapper.queryImeiCode();
if (imeiSnCodes != null && imeiSnCodes.size()> 0) {
for(int i=0;i<imeiSnCodes.size();i++){
//獲取當前代理對象，進行調用
((InstalledRecordService) AopContext.currentProxy()).getInstalledApk(imeiSnCodes.get(i));
}
}
}
}

原理：

AopContext的實現如下：

(1).在進入代理對象之後通過AopContext.serCurrentProxy(proxy)暴露當前代理對象到ThreadLocal，並保存上次ThreadLocal綁定的代理對象為oldProxy。

(2).接下來我們可以通過 AopContext.currentProxy() 獲取當前代理對象。

(3).在退出代理對象之前要重新將ThreadLocal綁定的代理對象設置為上一次的代理對象，即 AopContext.serCurrentProxy(oldProxy)。AopContext實現的源代碼如下：

public abstract class AopContext { 
private static final ThreadLocal<Object> currentProxy = new NamedThreadLocal<Object>("Current AOP proxy");
public static Object currentProxy() throws IllegalStateException {
Object proxy = currentProxy.get();
if (proxy == null) {
throw new IllegalStateException(
"Cannot find current proxy: Set 'exposeProxy' property on Advised to 'true' to make it available.");
}
return proxy;
}
 
static Object setCurrentProxy(Object proxy) {
Object old = currentProxy.get();
if (proxy != null) {
currentProxy.set(proxy);
}
else {
currentProxy.remove();
}
return old;
}
}

3.方法三

往實現類中註入自身。 仍然在同一個類中調用代碼，但是改為如下的形式：

@Service("installedRecordService")
public class InstalledRecordServiceImpl implements InstalledRecordService{
//註入自身
@Resource
private InstalledRecordService installedRecordService;
@Resource
private InstalledRecordMapper installedRecordMapper;
 
@Override
public void getInstalledApks() {
List<String> imeiSnCodes = installedRecordMapper.queryImeiCode();
if (imeiSnCodes != null && imeiSnCodes.size()> 0) {
for(int i=0;i<imeiSnCodes.size();i++){
installedRecordService.getInstalledApk(imeiSnCodes.get(i));
 
}
}
}

4.總結

(1).在一個類內部調用時，被調用方法的 AOP 聲明將不起作用。Spring 事務管理註解 @Transactional 也一樣。

(2).對於基於接口動態代理的 AOP 事務增強來說，由於接口的方法都必然是 public 的，這就要求實現類的實現方法也必須是 public 的（不能是 protected、private 等），同時不能使用 static 的修飾符。所以，可以實施接口動態代理的方法隻能是使用 public 或 public final 修飾符的方法，其他方法不可能被動態代理，相應的也就不能實施 AOP 增強，換句話說，即不能進行 Spring 事務增強瞭。

(3).基於 CGLib 字節碼動態代理的方案是通過擴展被增強類，動態創建其子類的方式進行 AOP 增強植入的。由於使用 final、static、private 修飾符的方法都不能被子類覆蓋，相應的，這些方法將無法實施 AOP 增強。所以方法簽名必須特別註意這些修飾符的使用，以免使方法不小心成為事務管理的漏網之魚。

(4).該例中的方法符合上述條件，但註解仍然失效，主要原因是在於同一類中的方法互相調用，調用者指向當前對象，所以無論是接口代理還是 cglib 代理都無法織入增強實現。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：