切面编程(三):AspectJ与Shiro不兼容和Spring二次代理错误分析

时间 2019-11-12

标签切面编程 aspectj shiro 不兼容 spring 二次代理错误分析栏目 Java 繁體版

原文原文链接

切面编程(三):AspectJ与Shiro不兼容和Spring二次代理错误分析

Shiro与AspectJ的配置 Shiro的配置根据个人BLOG文章和官方文档咱们能够得知Shiro在使用注解的时的配置是html

Shiro与AspectJ的配置

Shiro的配置

根据个人BLOG文章和官方文档咱们能够得知Shiro在使用注解的时的配置是java

<bean class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" depends-on="lifecycleBeanPostProcessor"/>
<bean class="org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor">
 <property name="securityManager" ref="securityManager"/>
</bean>

其基于注解的权限控制功能git

根据类名能够推断是经过切面的Advisor来完成的(AuthorizationAttributeSourceAdvisor)
因此说它须要建立本身的动态代理类，是由Spring的DefaultAdvisorAutoProxyCreator动态代理建立的

SpringMVC中AspectJ的配置

根据上文，启用基于注解的AspectJ就很简单了，由于基于注解的Shiro通常也在SpringMVC的Context里，咱们采用以下配置github

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

在二者分别配置的时候，配置方法都是对的可是一旦公用，会发现AspectJ会失效web

失效的解决办法

方法一

解决办法也很简单，注释掉Shiro配置中的第一句spring

<!--<bean class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" depends-on="lifecycleBeanPostProcessor"/>-->

注释以后Shiro的注解权限管理功能并不会失效，具体缘由咱们来细细分析apache

方法二

给DefaultAdvisorAutoProxyCreator加入参数proxyTargetClass为true编程

<bean class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" depends-on="lifecycleBeanPostProcessor">
 <property name="proxyTargetClass" value="true"/>
</bean>

配置失效的缘由

缘由在于二次代理api

因为使用了aop:aspectj-autoproxy强制了proxy-target-class
也就是说对Web层的Class(主要是Controller)使用了CGLib代理
而后在Shiro进行代理时使用DefaultAdvisorAutoProxyCreator
本来应该判断Controller，发现没有任何接口，因此使用CGLib来代理
可是因为Controller已经被CGLib代理过一次了
DefaultAdvisorAutoProxyCreator拿到对不是Contoller自己，而是CGLib的代理结果
CGLib的代理结果自己是有接口的，干扰了DefaultAdvisorAutoProxyCreator的内部判断
使用JDK去代理CGLib的代理结果
结果Controller的函数时去了CGLib的接口中找方法名，发现方法不存在，致使代理失败

为何会肯定是这个缘由，废了我好大功夫，详情请看代码追踪。。。。没精力就别看了网络

代码的追踪(能够不看)

aspectj-autoproxy

在配置文件中的 aop:aspectj-autoproxy会最终交给名为 AopNamespaceHandler的类进行处理，进入该类(直接在工程全局搜)咱们能够看到

public class AopNamespaceHandler extends NamespaceHandlerSupport {
 public AopNamespaceHandler() {
 }

 public void init() {
 this.registerBeanDefinitionParser("config", new ConfigBeanDefinitionParser());
 this.registerBeanDefinitionParser("aspectj-autoproxy", new AspectJAutoProxyBeanDefinitionParser());
 this.registerBeanDefinitionDecorator("scoped-proxy", new ScopedProxyBeanDefinitionDecorator());
 this.registerBeanDefinitionParser("spring-configured", new SpringConfiguredBeanDefinitionParser());
 }
}

aspectj-autoproxy 是由 AspectJAutoProxyBeanDefinitionParser 注册的，而后根据该Blog提出的说法

进入AspectJAutoProxyBeanDefinitionParser
找到parse函数，看到其调用registerAspectJAnnotationAutoProxyCreatorIfNecessary来注册BeanDefinition
进入registerAspectJAnnotationAutoProxyCreatorIfNecessary能够看到内部的三个register方法
三个register方法分别对应上述代码中第一个参数的输入，可是均调用了AopConfigUtils
点击AopConfigUtils，能够发现全部的方法都最终调用registerOrEscalateApcAsRequired
registerOrEscalateApcAsRequired中有个简单的if…else判断
主要控制了逻辑，若是存在internalAutoProxyCreator则不进行建立新的

该Blog做者提出，因为

<aop:aspectj-autoproxy/> 方式对应的注册AutoProxyCreator 的方法是：registerAspectJAnnotationAutoProxyCreatorIfNecessary
DefaultAdvisorAutoProxyCreator 方式对应的注册AutoProxyCreator 的方法是：registerAutoProxyCreatorIfNecessary；

最终会在第七步骤的函数里，因为这个if…else判断致使不能存在两个代理，因此不能混合使用 DefaultAdvisorAutoProxyCreator与 aop:aspectj-autoproxy

这个结论是错误的，是由于DefaultAdvisorAutoProxyCreator不会调用registerAutoProxyCreatorIfNecessary，产生错误的缘由是二次代理做者追踪错了代码，只是恰巧改对了

DefaultAdvisorAutoProxyCreator

来，跟着我找 DefaultAdvisorAutoProxyCreator 如何建立代理的代码

进入DefaultAdvisorAutoProxyCreator(直接Command或者Ctrl+点击进入)
看到其继承于AbstractAdvisorAutoProxyCreator，进入
能够看到AbstractAdvisorAutoProxyCreator继承于AbstractAutoProxyCreator继续进入
AbstractAutoProxyCreator中有一个方法叫作createProxy，名字太直接了，叫作建立代理
在createProxy中有一个ProxyFactory对象，就是代理的工厂模式(工厂模式请自行学习)
ProxyFactory对象继承于ProxyCreatorSupport
ProxyCreatorSupport中有对象aopProxyFactory用来建立AOP代理(就是切面代理，注意切面代理是属于动态代理的一种)
ProxyCreatorSupport在构造函数中new了一个DefaultAopProxyFactory给aopProxyFactory赋值
进入DefaultAopProxyFactory能够看到切面代理建立方法createAopProxy
在判断条件包含 !config.isProxyTargetClass() 时，也就是不使用针对Class的代理的时候，看下一句
return new JdkDynamicAopProxy(config) 根据config配置返回JDK动态代理

这也是咱们在文章一中所说的，一般状况下Spring使用针对接口的JDK代理进行动态代理，绕了这么久，咱们回到第五步，看 createProxy方法如何使用 ProxyFactory对象

能够看到createProxy 返回值 return proxyFactory.getProxy(this.getProxyClassLoader())
进入ProxyFactory对象的getProxy方法
能够看到 return this.createAopProxy().getProxy(classLoader)
首先调用了createAopProxy，发现ProxyFactory没有这个方法，因此来自父类 ProxyCreatorSupport
点击进入看到createAopProxy 内包含this.getAopProxyFactory().createAopProxy(this)
首先拿到了上文第九步建立的DefaultAopProxyFactory，而后调用了其createAopProxy

以上完成了 DefaultAdvisorAutoProxyCreator 动态代理的建立

两次代理的内部细节

有一些文章分析给出没法肯定二次代理的状况下哪一个代理成功，可是根据我自己追踪日志发现，在Spring启动时，个人切面类日志输出成功

[2016-10-23 14:00:13][qtp1938298155-28][INFO ][] c.b.psas.web.aspect.ControllerLogAspect 28 -- 网络请求开始 RequestURL: / RequestVO参数: null
[2016-10-23 14:00:13][qtp1938298155-28][INFO ][] c.b.psas.web.aspect.ControllerLogAspect 33 -- 网络请求结束 RequestURL: / RequestVO参数: null

可是在调用接口时，开启DEBUG日志，会发现Shiro抛出的异常为

[2016-10-23 13:38:52][qtp1386909980-27][DEBUG][] o.s.web.servlet.DispatcherServlet 1197 -- Handler execution resulted in exception - forwarding to resolved error view: ModelAndView: reference to view with name '/errors/500'; model is {exception=java.lang.IllegalStateException: The mapped controller method class 'com.bestpay.psas.web.controller.manage.LoginController' is not an instance of the actual controller bean class 'com.sun.proxy.$Proxy103'. If the controller requires proxying (e.g. due to @Transactional), please use class-based proxying.
HandlerMethod details:
Controller [com.bestpay.psas.web.controller.manage.LoginController]
Method [public java.lang.String com.bestpay.psas.web.controller.manage.LoginController.login()]
Resolved arguments:
}
java.lang.IllegalStateException: The mapped controller method class 'com.bestpay.psas.web.controller.manage.LoginController' is not an instance of the actual controller bean class 'com.sun.proxy.$Proxy103'. If the controller requires proxying (e.g. due to @Transactional), please use class-based proxying.
HandlerMethod details:
Controller [com.bestpay.psas.web.controller.manage.LoginController]
Method [public java.lang.String com.bestpay.psas.web.controller.manage.LoginController.login()]
Resolved arguments:

 at org.springframework.web.method.support.InvocableHandlerMethod.assertTargetBean(InvocableHandlerMethod.java:262) ~[spring-web-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:225) ~[spring-web-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:137) ~[spring-web-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:110) ~[spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:775) ~[spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:705) ~[spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85) ~[spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:959) [spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:893) [spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:965) [spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:856) [spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at javax.servlet.http.HttpServlet.service(HttpServlet.java:735) [servlet-api-3.0.jar:na]
 at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:841) [spring-webmvc-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at javax.servlet.http.HttpServlet.service(HttpServlet.java:848) [servlet-api-3.0.jar:na]
 at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:684) [jetty-servlet-8.1.17.v20150415.jar:8.1.17.v20150415]
 at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1496) [jetty-servlet-8.1.17.v20150415.jar:8.1.17.v20150415]
 at org.apache.shiro.web.servlet.AbstractShiroFilter.executeChain(AbstractShiroFilter.java:449) [shiro-web-1.2.4.jar:1.2.4]
 at org.apache.shiro.web.servlet.AbstractShiroFilter$1.call(AbstractShiroFilter.java:365) [shiro-web-1.2.4.jar:1.2.4]
 at org.apache.shiro.subject.support.SubjectCallable.doCall(SubjectCallable.java:90) [shiro-core-1.2.4.jar:1.2.4]
 at org.apache.shiro.subject.support.SubjectCallable.call(SubjectCallable.java:83) [shiro-core-1.2.4.jar:1.2.4]
 at org.apache.shiro.subject.support.DelegatingSubject.execute(DelegatingSubject.java:383) [shiro-core-1.2.4.jar:1.2.4]
 at org.apache.shiro.web.servlet.AbstractShiroFilter.doFilterInternal(AbstractShiroFilter.java:362) [shiro-web-1.2.4.jar:1.2.4]
 at org.apache.shiro.web.servlet.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:125) [shiro-web-1.2.4.jar:1.2.4]
 at org.springframework.web.filter.DelegatingFilterProxy.invokeDelegate(DelegatingFilterProxy.java:344) [spring-web-4.1.9.RELEASE.jar:4.1.9.RELEASE]
 at org.springframework.web.filter.DelegatingFilterProxy.doFilter(DelegatingFilterProxy.java:261) [spring-web-4.1.9.RELEASE.jar:4.1.9.RELEASE]

能够在日志中发现几个关键字

org.apache.shiro.web.servlet.AbstractShiroFilter.executeChain
com.sun.proxy.$Proxy103
InvocableHandlerMethod.doInvoke

三个关键字分别说明了

是Shiro产生了异常，而不是AOP
Shiro尝试去采用了JDK代理
报错在Invoke方法时

解决方法生效的缘由

方法一

由于Shiro也是基于Spring的AOP类的，若是找不到合适的配置，就是默认采用同一个Context下的AOP代理配置，咱们给了其proxy-target-class为true，天然就在第二次代理的时候找获得方法

方法二

方法二就更直接了，告诉DefaultAdvisorAutoProxyCreator为True就好

杂想

我之前写过另外一个文章，讨论了 SpringMVC和Spring公用的状况下Transactional失效的问题颇有可能底层缘由也是二次代理