背景

當(dāng)初剛到公司實(shí)習(xí)不久，就遇到一個(gè)問(wèn)題：在同一個(gè)類(lèi)中，調(diào)用有@redis,@Transactional的方法，發(fā)現(xiàn)注解失效了。因?yàn)檫@個(gè)問(wèn)題，我當(dāng)時(shí)糾結(jié)了很久。最后，還是老大一語(yǔ)驚醒夢(mèng)中人，歸根結(jié)底，還是Spring Aop原理沒(méi)有理解徹底。今天就來(lái)聊一下關(guān)于"Spring AOP 同類(lèi)調(diào)用失效問(wèn)題"。

一 目標(biāo)

深入探究"Spring AOP 同類(lèi)調(diào)用失效問(wèn)題"，并且深刻理解Spring Aop的底層原理。

二 概述

在使用自定義注解形式的@redis做緩存時(shí)，@redis失效，分析原因。在此聲明一下：@redis這個(gè)注解是的底層其實(shí)就是反射，這個(gè)以后我會(huì)分享一下自定義注解@redis的設(shè)計(jì)。如果你使用過(guò)SpringBoot的話(huà)，其實(shí)SpringBoot里面也是可以引入像@redis這樣的注解的。這個(gè)注解的作用就是將方法的返回值緩存到redis中。

三 工作中遇到的實(shí)例

應(yīng)用商店中根據(jù)imeiSnCode來(lái)查詢(xún)安裝列表,并且打算緩存到redis中。但是發(fā)現(xiàn)用以下的方法發(fā)現(xiàn)數(shù)據(jù)沒(méi)有緩存到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的原理圖(此圖摘抄于網(wǎng)絡(luò))：  

我長(zhǎng)話(huà)短說(shuō)，也就是說(shuō)我們首先調(diào)用的是AOP代理對(duì)象而不是目標(biāo)對(duì)象。但是我們使用this.getInstalledApk(imeiSnCodes.get(i))時(shí)，this表示的是當(dāng)前的對(duì)象，而不是代理對(duì)象，因此注解失效。

四 解決方法

1.方法一

最簡(jiǎn)單的方法就是將getInstalledApks()方法放在另外的一個(gè)類(lèi)中進(jìn)行調(diào)用，就不會(huì)出現(xiàn)這種問(wèn)題了。代碼省略。

2.方法二

暴露AOP代理對(duì)象：

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

仍然在同一個(gè)類(lèi)中調(diào)用代碼，但是改為如下的形式：

@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++){
//獲取當(dāng)前代理對(duì)象，進(jìn)行調(diào)用
((InstalledRecordService) AopContext.currentProxy()).getInstalledApk(imeiSnCodes.get(i));
}
}
}
}

原理：

AopContext的實(shí)現(xiàn)如下：

(1).在進(jìn)入代理對(duì)象之后通過(guò)AopContext.serCurrentProxy(proxy)暴露當(dāng)前代理對(duì)象到ThreadLocal，并保存上次ThreadLocal綁定的代理對(duì)象為oldProxy。

(2).接下來(lái)我們可以通過(guò) AopContext.currentProxy() 獲取當(dāng)前代理對(duì)象。

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

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.方法三

往實(shí)現(xiàn)類(lèi)中注入自身。 仍然在同一個(gè)類(lèi)中調(diào)用代碼，但是改為如下的形式：

@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.總結(jié)

(1).在一個(gè)類(lèi)內(nèi)部調(diào)用時(shí)，被調(diào)用方法的 AOP 聲明將不起作用。Spring 事務(wù)管理注解 @Transactional 也一樣。

(2).對(duì)于基于接口動(dòng)態(tài)代理的 AOP 事務(wù)增強(qiáng)來(lái)說(shuō)，由于接口的方法都必然是 public 的，這就要求實(shí)現(xiàn)類(lèi)的實(shí)現(xiàn)方法也必須是 public 的（不能是 protected、private 等），同時(shí)不能使用 static 的修飾符。所以，可以實(shí)施接口動(dòng)態(tài)代理的方法只能是使用 public 或 public final 修飾符的方法，其他方法不可能被動(dòng)態(tài)代理，相應(yīng)的也就不能實(shí)施 AOP 增強(qiáng)，換句話(huà)說(shuō)，即不能進(jìn)行 Spring 事務(wù)增強(qiáng)了。

(3).基于 CGLib 字節(jié)碼動(dòng)態(tài)代理的方案是通過(guò)擴(kuò)展被增強(qiáng)類(lèi)，動(dòng)態(tài)創(chuàng)建其子類(lèi)的方式進(jìn)行 AOP 增強(qiáng)植入的。由于使用 final、static、private 修飾符的方法都不能被子類(lèi)覆蓋，相應(yīng)的，這些方法將無(wú)法實(shí)施 AOP 增強(qiáng)。所以方法簽名必須特別注意這些修飾符的使用，以免使方法不小心成為事務(wù)管理的漏網(wǎng)之魚(yú)。

(4).該例中的方法符合上述條件，但注解仍然失效，主要原因是在于同一類(lèi)中的方法互相調(diào)用，調(diào)用者指向當(dāng)前對(duì)象，所以無(wú)論是接口代理還是 cglib 代理都無(wú)法織入增強(qiáng)實(shí)現(xiàn)。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論