【Java从0到架构师】Spring - AOP

桃扇骨 2022-08-29 01:29 208阅读 0赞

### AOP ###

*  AOP 编程使用
 *   *  AOP - MethodBeforeAdvice
     *  AOP - MethodInterceptor
 *  AOP - 动态代理的底层实现
 *  AOP - 切入点表达式
 *   *  AOP - 目标方法相互调用的细节
     *  AOP - 配置多个 pointcut、advisor

> Java 从 0 到架构师目录：[【Java从0到架构师】学习记录][Java_0]

> 学习 Spring 搭配这门课效果更好：[《孙哥说Spring5》学习笔记][Spring5]

Gitee 代码：[https://gitee.com/szluyu99/mj\_java\_frame/tree/master/02\_Spring/][https_gitee.com_szluyu99_mj_java_frame_tree_master_02_Spring]

> 本章关联文章：孙哥说 Spring5 系列
> 
>  *  [静态代理设计模式、Spring 动态代理开发详解、切入点详解（切入点表达式、切入点函数）][Spring]
>  *  [AOP 底层实现原理 —— 动态代理类的创建（JDK、CGlib）、工厂如何加工原始对象][AOP _ _ _JDK_CGlib]

**AOP (Aspect Oriented Programming)，面向切面编程**

Spring 使用 AOP 技术封装了动态代理的功能，使用起来非常简单

*  它依赖于 AspectJ 库

<dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjrt</artifactId>
        <version>1.9.6</version>
    </dependency>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.6</version>
    </dependency>

# AOP 编程使用 #

## AOP - MethodBeforeAdvice ##

实现 MethodBeforeAdvice 接口，用来编写额外功能（会在目标方法执行之前执行）

public class LogAdvice implements MethodBeforeAdvice { 
        @Override
        public void before(Method method, Object[] args, Object target) throws Throwable { 
            System.out.println("LogAdvice - before ------------------");
        }
    }

<bean id="logAdvice" class="com.mj.aop.LogAdvice"/>
    
    
    <aop:config>
    	 
    	<aop:pointcut id="pc" expression="execution(* *(..))"/>
    	
    	<aop:advisor advice-ref="logAdvice" pointcut-ref="pc"/>
    </aop:config>

## AOP - MethodInterceptor ##

实现 org.aopalliance.intercept.MethodInterceptor 接口，用来编写额外功能

public class LogInterceptor implements MethodInterceptor { 
        @Override
        public Object invoke(MethodInvocation invocation) throws Throwable { 
            System.out.println("before");
            // 调用目标对象的目标方法
            Object result = invocation.proceed();
            System.out.println("after");
            return result;
        }
    }

<bean id="logInterceptor" class="com.mj.aop.LogInterceptor"/>
    
    
    <aop:config>
    	 
    	<aop:pointcut id="pc" expression="execution(* *(..))"/>
    	
    	<aop:advisor advice-ref="logInterceptor" pointcut-ref="pc"/>
    </aop:config>

# AOP - 动态代理的底层实现 #

Spring 动态代理的底层实现：

*  如果目标类有实现接口，使用 JDK 实现
 *  如果目标类没有实现接口，使用 CGLib 实现
 *  在 **BeanPostProcessor** 的 **postProcessAfterInitialization** 方法中创建代理对象
    
    > 详见 [bean 的生命周期][bean]

在配置文件中可以通过 `proxy-target-class` 属性修改底层实现方案：

*  true：强制使用 CGlib
 *  false：默认值，使用默认方案（实现接口—>JDK、没有实现接口—> CGLib）

<aop:config proxy-target-class="true">

# AOP - 切入点表达式 #

> 参考资料：[官方文档][Link 1]  
> [【Spring AOP】静态代理设计模式、Spring 动态代理开发详解、切入点详解（切入点表达式、切入点函数）][Spring]

切入点表达式理解：

execution(public String com.mj.service.UserService.login(String, String))
    ↓
    ↓---------------------------------------------
    ↓ 	public String ---> *
    ↓	com.mj.service.UserService.login ---> *
    ↓	(String, String) ---> (..)
    ↓---------------------------------------------
    ↓
    execution(* *(..))

常见的切入点指示符 (pointcut designators)：

*  execution
 *  args
 *  within
 *  @annotation

还可以使用 `&&`（`and`）、`||`(`or`)、`!` 组合切入点表达式

--------------------

切入点表达式示例：

*  任意公共方法：`execution(public * *(..))`
 *  名字以 set 开头的任意方法：`execution(* set*(..))`
 *  UserService 接口定义的任意方法：`execution(* com.mj.service.UserService.*(..))`
 *  service 包中定义的任意方法：`execution(* com.mj.service.*.*(..))`
 *  service 包中定义的任意方法（包括子包）：`execution(* com.mj.service..*.*(..))`
 *  包含 2 个 String 参数的任意方法：`execution(* *(String, String))`
 *  只有 1 个 Serializable 参数的任意方法：`args(java.il.Serializable)`
 *  service 包中的任意方法：`within(com.mj.service.*)`
 *  service 包中的任意方法（包括子包）：`within(com.mj.service..* )`
 *  带有自定义注解（Hehe）的方法：`@annotation(com.mj.aop.Hehe)`

## AOP - 目标方法相互调用的细节 ##

默认情况下，目标方法相互调用时，总共只会被切入 1 次。

*  解决方法：拿到代理对象去调用目标方法

public class UserServiceImpl implements 
    		UserService, BeanNameAware, ApplicationContextAware { 
        private ApplicationContext ctx;
        private String beanName;
    
        @Override
        public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { 
            ctx = applicationContext;
        }
    
        @Override
        public void setBeanName(String name) { 
            beanName = name;
        }
    
        @Override
        public boolean login(String username, String password) { 
            System.out.println("UserServiceImpl - login");
    		// 拿到代理对象去调用,会被切入
            ctx.getBean(beanName, UserService.class).login2(username, password);
            // login(username, password); // 直接调用不会被切入,因为不是由代理对象调用
            return false;
        }
    
        @Override
        public boolean login2(String username) { 
            System.out.println("UserServiceImpl - login2");
            return false;
        }
    
    }

## AOP - 配置多个 pointcut、advisor ##

<bean id="logAdvice" class="com.mj.aop.LogAdvice"/>
    <bean id="logInterceptor" class="com.mj.aop.LogInterceptor"/>
    
    
    <aop:config>
        <aop:pointcut id="pc1" expression="execution(* *.login(..))"/>
        <aop:pointcut id="pc2" expression="execution(* *.save(..))"/>
    
        <aop:advisor advice-ref="logInterceptor" pointcut-ref="pc1"/>
        <aop:advisor advice-ref="logInterceptor" pointcut-ref="pc2"/>
        <aop:advisor advice-ref="logAdvice" pointcut-ref="pc2"/>
    </aop:config>

下面这种写法也可以：

<bean id="logAdvice" class="com.mj.aop.LogAdvice"/>
    <bean id="logInterceptor" class="com.mj.aop.LogInterceptor"/>
    
    <aop:config>
        <aop:pointcut id="pc1" expression="execution(* *.login(..))"/>
        <aop:advisor advice-ref="logInterceptor" pointcut-ref="pc1"/>
    </aop:config>
    
    <aop:config>
        <aop:pointcut id="pc2" expression="execution(* *.save(..))"/>
        <aop:advisor advice-ref="logInterceptor" pointcut-ref="pc2"/>
        <aop:advisor advice-ref="logAdvice" pointcut-ref="pc2"/>
    </aop:config>

[Java_0]: https://blog.csdn.net/weixin_43734095/article/details/119067034
[Spring5]: https://blog.csdn.net/weixin_43734095/article/details/106309373
[https_gitee.com_szluyu99_mj_java_frame_tree_master_02_Spring]: https://gitee.com/szluyu99/mj_java_frame/tree/master/02_Spring/
[Spring]: https://blog.csdn.net/weixin_43734095/article/details/106367747
[AOP _ _ _JDK_CGlib]: https://blog.csdn.net/weixin_43734095/article/details/106447463
[bean]: https://blog.csdn.net/weixin_43734095/article/details/119384759
[Link 1]: https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#aop-pointcuts