Spring中一個(gè)少見的引介增強(qiáng)IntroductionAdvisor
引言
我們平時(shí)做 AOP 開發(fā)的時(shí)候,基本上都是增強(qiáng)某一個(gè)方法,在某一個(gè)方法執(zhí)行之前或者執(zhí)行之后做一些事情,這種叫做 PointcutAdvisor,實(shí)際上,Spring 中的 Advisor 大致可以分為兩種類型,除了 PointcutAdvisor 之外,還有另外一種 Advisor 叫做 IntroductionAdvisor,因?yàn)樽罱牒托』锇閭兞囊涣?Spring AOP 的源碼,看源碼有一個(gè)前提就是得先掌握 Spring 的各種用法,這樣看源碼的時(shí)候往往就有一種醍醐灌頂?shù)母杏X,否則看源碼的時(shí)候就容易懵!
1. 實(shí)踐
不同于 PointcutAdvisor,IntroductionAdvisor 這種增強(qiáng)主要是針對(duì)一個(gè)類來(lái)增強(qiáng)。
接下來(lái)松哥寫一個(gè)簡(jiǎn)單的案例,小伙伴們來(lái)看下 IntroductionAdvisor 到底做了什么工作。
假設(shè)我有一個(gè) Animal 接口,如下:
public interface Animal { void eat(); }
這個(gè)動(dòng)物具備吃的能力。
現(xiàn)在我還有一個(gè) Dog,如下:
public interface Dog { void run(); } public class DogImpl implements Dog{ @Override public void run() { System.out.println("Dog run"); } }
Dog 具備跑的能力,注意,Dog 和 Animal 之間并無(wú)繼承/實(shí)現(xiàn)的關(guān)系。
現(xiàn)在,我們通過(guò) Spring 中的 IntroductionAdvisor,就能讓 Dog 具備 Animal 的能力,我們來(lái)看下具體怎么做。
首先,我們先來(lái)開發(fā)一個(gè) Advice,這個(gè) Advice 同時(shí)也是 Animal 接口的實(shí)現(xiàn)類,如下:
public class AnimalIntroductionInterceptor implements IntroductionInterceptor, Animal { @Override public Object invoke(MethodInvocation invocation) throws Throwable { if (implementsInterface(invocation.getMethod().getDeclaringClass())) { return invocation.getMethod().invoke(this, invocation.getArguments()); } return invocation.proceed(); } @Override public void eat() { System.out.println("Animal eat"); } @Override public boolean implementsInterface(Class<?> intf) { return intf.isAssignableFrom(this.getClass()); } }
跟普通 AOP 一樣,當(dāng)目標(biāo)方法被攔截下來(lái)的時(shí)候,這里的 invoke 方法會(huì)被觸發(fā),在 invoke 方法中我們需要先調(diào)用 implementsInterface 方法進(jìn)行判斷,如果被攔截下來(lái)的方法所屬的類是 Animal 的話,即 implementsInterface 方法返回 true 的情況(this 其實(shí)就是 Animal),那么就直接獲取到 method 對(duì)象然后通過(guò)反射去調(diào)用就行了,這樣會(huì)就會(huì)導(dǎo)致這里的 eat 方法被觸發(fā);否則,說(shuō)明是被攔截下來(lái)的方法本身,那么就調(diào)用 invocation.proceed();
讓攔截器鏈繼續(xù)往下執(zhí)行即可。
接下來(lái)我們來(lái)定義 Advisor:
@Component public class DogIntroductionAdvisor implements IntroductionAdvisor { @Override public ClassFilter getClassFilter() { return new ClassFilter() { @Override public boolean matches(Class<?> clazz) { return Dog.class.isAssignableFrom(clazz); } }; } @Override public void validateInterfaces() throws IllegalArgumentException { } @Override public Advice getAdvice() { return new AnimalIntroductionInterceptor(); } @Override public boolean isPerInstance() { return true; } @Override public Class<?>[] getInterfaces() { return new Class[]{Animal.class}; } }
這里有幾個(gè)方法需要實(shí)現(xiàn):
- getClassFilter:哪些類需要攔截在這里配置,ClassFilter 松哥在上篇文章中已經(jīng)講過(guò)了,這里只需要返回被攔截的類就行了,不需要具體到哪個(gè)方法被攔截。
- getAdvice:這個(gè)就是返回?cái)r截下來(lái)后執(zhí)行的通知,我們就返回前面定義的通知即可,這里有一個(gè)要求,就是 這個(gè) Advice 需要實(shí)現(xiàn) Animal 接口。
- getInterfaces:這個(gè)方法還比較重要,生成代理對(duì)象的時(shí)候,代理對(duì)象需要實(shí)現(xiàn)哪些接口,就是從這個(gè)地方定義的,這里返回 Animal,所以將來(lái)我拿到手的代理對(duì)象就實(shí)現(xiàn)了 Animal 接口,就能調(diào)用 Animal 中的方法了。
- isPerInstance:這個(gè)方法暫時(shí)沒有實(shí)現(xiàn),返回 true 就行了。
- validateInterfaces:這個(gè)方法是做接口校驗(yàn)的,我這里就不校驗(yàn)了。
好啦,我的代碼現(xiàn)在就寫好了,我們來(lái)測(cè)試看下:
ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("introduction.xml"); Dog dog = ctx.getBean(Dog.class); dog.run(); System.out.println("Animal.class.isAssignableFrom(dog.getClass()) = " + Animal.class.isAssignableFrom(dog.getClass())); Animal animal = (Animal) dog; animal.eat();
執(zhí)行結(jié)果如下:
我們拿到手的 dog 對(duì)象其實(shí)也是一個(gè) Animal。
這就是 Spring AOP 中的 IntroductionAdvisor,當(dāng)一個(gè)類需要具備另一個(gè)類的能力的時(shí)候,可以使用 IntroductionAdvisor。
2. 源碼分析
那么這一切是怎么實(shí)現(xiàn)的呢?
因?yàn)檫@篇文章我主要是想和小伙伴們分享 IntroductionAdvisor 的知識(shí)點(diǎn),所以關(guān)于 AOP 完整的創(chuàng)建流程我先不說(shuō),在后續(xù)的文章中我會(huì)和大家做一個(gè)詳細(xì)介紹,我今天就來(lái)和大家聊一聊在 Spring AOP 執(zhí)行的過(guò)程中,究竟是如何處理 IntroductionAdvisor 的。
Spring AOP 中創(chuàng)建代理對(duì)象,一般是通過(guò)后置處理器來(lái)完成,從 AbstractAutoProxyCreator#postProcessAfterInitialization 方法開始,大致時(shí)序圖如下:
我們就從 buildProxy 方法開始看起吧,這個(gè)方法看名字就知道是用來(lái)構(gòu)建代理對(duì)象的。
AbstractAutoProxyCreator#buildProxy:
private Object buildProxy(Class<?> beanClass, @Nullable String beanName, @Nullable Object[] specificInterceptors, TargetSource targetSource, boolean classOnly) { //... Advisor[] advisors = buildAdvisors(beanName, specificInterceptors); proxyFactory.addAdvisors(advisors); //... return (classOnly ? proxyFactory.getProxyClass(classLoader) : proxyFactory.getProxy(classLoader)); }
這里有一個(gè) buildAdvisors 方法,這個(gè)方法是用來(lái)處理 Advisor 的,我們自定義的 DogIntroductionAdvisor 將在這里被讀取進(jìn)來(lái),然后將之添加到 proxyFactory 對(duì)象中,在添加的過(guò)程中,會(huì)進(jìn)行一些額外的處理,proxyFactory#addAdvisors 最終會(huì)來(lái)到 AdvisedSupport#addAdvisors 方法中:
public void addAdvisors(Collection<Advisor> advisors) { if (!CollectionUtils.isEmpty(advisors)) { for (Advisor advisor : advisors) { if (advisor instanceof IntroductionAdvisor introductionAdvisor) { validateIntroductionAdvisor(introductionAdvisor); } this.advisors.add(advisor); } adviceChanged(); } }
在這里會(huì)遍歷所有的 Advisor,判斷類型是不是 IntroductionAdvisor 類型的,我們自定義的 DogIntroductionAdvisor 恰好就是 IntroductionAdvisor 類型的,所以會(huì)進(jìn)一步調(diào)用 validateIntroductionAdvisor 方法,如下:
private void validateIntroductionAdvisor(IntroductionAdvisor advisor) { advisor.validateInterfaces(); Class<?>[] ifcs = advisor.getInterfaces(); for (Class<?> ifc : ifcs) { addInterface(ifc); } } public void addInterface(Class<?> intf) { if (!this.interfaces.contains(intf)) { this.interfaces.add(intf); adviceChanged(); } }
小伙伴們看一下,advisor.getInterfaces();
實(shí)際上就調(diào)用到我們自定義的 DogIntroductionAdvisor 中的 getInterfaces 方法了,所以這里會(huì)返回 Animal 接口,然后這里會(huì)把 Animal 接口存入到 interfaces 這個(gè)變量中,將來(lái)在生成 AOP 對(duì)象的時(shí)候會(huì)用到。
好啦,現(xiàn)在回到 buildProxy 方法中,該方法最終會(huì)執(zhí)行到 proxyFactory.getProxy 方法,該方法最終執(zhí)行的時(shí)候,要么是 JDK 動(dòng)態(tài)代理,要么是 CGLIB 動(dòng)態(tài)代理,我們分別來(lái)說(shuō)一下。
2.1 JDK 動(dòng)態(tài)代理
先說(shuō)如果是 JDK 動(dòng)態(tài)代理,那么 proxyFactory.getProxy 方法就需要構(gòu)建一個(gè) JdkDynamicAopProxy 出來(lái),如下:
public JdkDynamicAopProxy(AdvisedSupport config) throws AopConfigException { this.advised = config; this.proxiedInterfaces = AopProxyUtils.completeProxiedInterfaces(this.advised, true); findDefinedEqualsAndHashCodeMethods(this.proxiedInterfaces); }
參數(shù) config 中就包含了我們前面說(shuō)的要實(shí)現(xiàn)的接口,所以這里 proxiedInterfaces 變量中保存的就是代理對(duì)象將來(lái)要實(shí)現(xiàn)的接口,以我們前面的代碼為例,這里 proxiedInterfaces 的值如下:
可以看到,就包含了 Animal 接口。
最后,調(diào)用 JdkDynamicAopProxy#getProxy 方法生成代理對(duì)象,如下:
@Override public Object getProxy(@Nullable ClassLoader classLoader) { return Proxy.newProxyInstance(classLoader, this.proxiedInterfaces, this); }
這就是大家比較熟悉的 JDK 動(dòng)態(tài)代理了,可以看到,生成的代理對(duì)象有五個(gè)接口,生成的代理對(duì)象不僅僅是 Dog、Animal 的實(shí)例,也是 SpringProxy 等的實(shí)例。現(xiàn)在大家就明白了為什么我們拿到手的 dog 對(duì)象還能強(qiáng)轉(zhuǎn)成 Animal 了。
2.2 CGLIB 動(dòng)態(tài)代理
再來(lái)看 CGLIB 動(dòng)態(tài)代理的實(shí)現(xiàn)邏輯,其實(shí)也差不多:
public CglibAopProxy(AdvisedSupport config) throws AopConfigException { this.advised = config; this.advisedDispatcher = new AdvisedDispatcher(this.advised); } @Override public Object getProxy(@Nullable ClassLoader classLoader) { return buildProxy(classLoader, false); } private Object buildProxy(@Nullable ClassLoader classLoader, boolean classOnly) { //... enhancer.setSuperclass(proxySuperClass); enhancer.setInterfaces(AopProxyUtils.completeProxiedInterfaces(this.advised)); //... // Generate the proxy class and create a proxy instance. return (classOnly ? createProxyClass(enhancer) : createProxyClassAndInstance(enhancer, callbacks)); }
可以看到,其實(shí)跟 JDK 里邊的思路差不多,也是從 advised 中提取出來(lái)接口設(shè)置進(jìn)去,advised 也是在 CglibAopProxy 對(duì)象構(gòu)建的時(shí)候傳入進(jìn)來(lái)的。
3. 小結(jié)
好了,現(xiàn)在小伙伴們應(yīng)該明白了什么是 IntroductionAdvisor 了吧?說(shuō)白了,就是在生成代理對(duì)象的時(shí)候,把我們?cè)?Advisor 中設(shè)置好的接口也考慮進(jìn)去,這樣生成的代理對(duì)象同時(shí)也是該接口的實(shí)現(xiàn)類,當(dāng)然,在我們提供的 Advice 中,必須也要實(shí)現(xiàn)該接口,否則代理對(duì)象執(zhí)行接口中的方法,找不到具體實(shí)現(xiàn)的時(shí)候就會(huì)報(bào)錯(cuò)了。
以上就是Spring中一個(gè)少見的引介增強(qiáng)IntroductionAdvisor的詳細(xì)內(nèi)容,更多關(guān)于Spring引介增強(qiáng)IntroductionAdvisor的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Java Guava排序器Ordering原理及代碼實(shí)例
這篇文章主要介紹了Java Guava排序器Ordering原理及代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-11-11Java實(shí)戰(zhàn)之醫(yī)院管理系統(tǒng)的實(shí)現(xiàn)
這篇文章主要介紹了如何利用Java實(shí)現(xiàn)醫(yī)院管理系統(tǒng),文中用到的技術(shù)有:SpringBoot、Layui、Freemaker等,感興趣的同學(xué)可以了解一下2022-04-04SpringBoot+MyBatis-Plus實(shí)現(xiàn)分頁(yè)示例
本文介紹了SpringBoot+MyBatis-Plus實(shí)現(xiàn)分頁(yè)示例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-12-12Mybatis-Plus @TableField自動(dòng)填充時(shí)間為null的問題解決
本文主要介紹了Mybatis-Plus @TableField自動(dòng)填充時(shí)間為null的問題解決,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-01-01JavaScript實(shí)現(xiàn)鼠標(biāo)移動(dòng)粒子跟隨效果
這篇文章主要為大家詳細(xì)介紹了JavaScript實(shí)現(xiàn)鼠標(biāo)移動(dòng)粒子跟隨效果,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-08-08slf4j與jul、log4j1、log4j2、logback的集成原理
這篇文章主要介紹了slf4j與jul、log4j1、log4j2、logback的集成原理,以及通用日志框架與具體日志實(shí)現(xiàn)系統(tǒng)的機(jī)制機(jī)制介紹,包括依賴的jar包,jar沖突處理等2022-03-03