Spring学习总结 (3)

迷南。 2022-11-20 03:59 131阅读 0赞

# AOP的使用 #

### 文章目录 ###

*  AOP的使用
 *   *  一、AOP介绍
     *   *  1. AOP概述
         *  2. AOP专业术语
     *  二、AOP使用步骤
     *   *  1. 导包
         *  2. 写配置
         *  3. xml中开启基于注解的AOP模式
         *   *  4. 代码演示
         *  5. 通知方法的执行顺序
     *  三、使用JoinPoint获取目标方法的详细信息
     *  四、获取目标方法的返回值
     *  五、获取目标方法的异常信息
     *  六、可重用的切入点表达式
     *   *  1. 背景
         *  2. 使用步骤
         *  3. 代码演示
     *  七、环绕通知
     *  八、五种通知方法都使用的执行顺序
     *  九、环绕通知与其余四个通知的不同
     *  十、多个切面类的运行顺序
     *  十一、使用基于xml中配置的AOP (不使用注解)

## 一、AOP介绍 ##

### 1. AOP概述 ###

AOP：面向切面编程，指在程序的运行期间，将某段代码动态的切入到指定方法的指定位置

某段代码：日志信息等  
动态的切入：不写死在业务逻辑方法中，这样不利于修改  
指定位置：方法的开始、结束、异常等

AOP底层是动态代理，而且并没有要求被代理类一定要实现某一个接口

### 2. AOP专业术语 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center]

Calculator类中有四个方法，每个方法都有开始、返回、异常、结束四个状态(位置)

目标方法：Calculator类中的四个方法(被切入的方法)

目标类：包含目标方法的类(Calculator类)

通知方法：将要切入到目标方法指定位置的方法(在目标方法指定位置执行)

切面类：包含通知方法的类

横切关注点：所有目标方法的同一位置

连接点：某个目标方法的四个位置都是连接点

切入点：通知方法具体要切入的位置

切入点表达式：根据这个表达式从连接点中选出切入点

## 二、AOP使用步骤 ##

### 1. 导包 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 1]

### 2. 写配置 ###

(1) 将目标类(被代理类)和切面类加入到ioc容器中：使用四个注解之一，并在xml中扫描  
(2) 告诉Spring哪一个是切面类，类上加注解@Aspect  
(3) 告诉Spring切面类中的每个通知方法都是何时何地运行：

① 在通知方法之上加注解告知何时运行：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 2]

② 在以上注解之后跟括号，其中写切入点表达式，告知何地运行：

切入点表达式的写法：

execution(访问权限符 返回值类型 目标方法的全类名(参数列表))

切入点表达式中通配符、逻辑运算符的使用：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 3]

注意：  
i. 最精确的写法：execution(public int com.qizegao.test.MyMathCalculator.add(int,int))  
ii. 复制方法的全类名：

![在这里插入图片描述][20201113141931200.png_pic_center]

### 3. xml中开启基于注解的AOP模式 ###

<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

#### 4. 代码演示 ####

(1) 被代理对象实现的接口

public interface Calculator { 
       
       public int add(int i, int j);
       public int sub(int i, int j);
       public int mul(int i, int j);
       public int div(int i, int j);
    }

(2) 目标类(被代理类)

@Component
    //目标类
    public class MyMathCalculator implements Calculator{ 
       @Override
       public int add(int i, int j) { 
           return i + j;
       }
       @Override
       public int sub(int i, int j) { 
           return i - j;
       }
       @Override
       public int mul(int i, int j) { 
           return i * j;
       }
       @Override
       public int div(int i, int j) { 
           return i / j;
       }
    }

(3) 切面类

@Component
    @Aspect
    //切面类
    public class LogUtils { 
       //以下为通知方法
       
       //在执行目标方法之前运行
       @Before("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void start() { 
           System.out.println("方法开始了！");
       }
       
       //目标方法正常执行完之后执行
       @AfterReturning("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void afterreturn() { 
           System.out.println("正常执行完成！");
       }
       
       //目标方法出现异常之后执行
       @AfterThrowing("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void afterexception() { 
           System.out.println("出现异常啦！");
       }
       
       //目标方法运行结束之后执行
       @After("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void after() { 
           System.out.println("整个方法执行完毕！");
       }
    }

(4) 测试类

@Test
       public void test1() { 
           
           //AOP底层是动态代理，ioc容器中保存的是目标类的代理对象
           //所以使用类型获取代理对象时不能使用MyMathCalculator.class获取
           //应该使用二者唯一可以产生联系的实现的接口获取
           
           ApplicationContext ioc = new ClassPathXmlApplicationContext("ioc.xml");
           Calculator calculator = ioc.getBean(Calculator.class);
           calculator.add(1, 2);
           /** * 方法开始了！ * 整个方法执行完毕！ * 正常执行完成！ */
           System.out.println(calculator); //com.qizegao.aop.MyMathCalculator@47eaca72
           System.out.println(calculator.getClass()); //class com.sun.proxy.$Proxy11
           //$Proxy是代理对象的类型
       }     
    
       @Test
       //通过id获取目标类的代理对象
       public void test2() { 
           //代理对象的id默认是目标类的类名首字母小写
           Calculator calculator = (Calculator)ioc.getBean("myMathCalculator");
           System.out.println(calculator.getClass()); //class com.sun.proxy.$Proxy11
       }

即使被代理对象(目标类)没有实现任何接口，Spring也可为其创建对象，演示如下：

(1) 取消MyMathCalculator继承Calculator(去掉override)

(2) 测试

@Test
       public void test1() {    
           //如果没有实现任何接口，通过类型获取代理对象时使用的就是本类类型
           MyMathCalculator mymathCalculator =  ioc.getBean(MyMathCalculator.class);
           mymathCalculator.add(1, 2);
           /** * 方法开始了！ * 整个方法执行完毕！ * 正常执行完成！ */
           System.out.println(mymathCalculator.getClass());
           //class com.qizegao.aop.MyMathCalculator$$EnhancerByCGLIB$$acfb5ca0
           //没有实现接口时获取到的代理对象是由CGLIB(一个组织)创建
       }
    
       @Test
       public void test2() { 
           
           //如果没有实现任何接口，通过id获取代理对象时使用的就是本类类型对应的id值
           MyMathCalculator myMathCalculator = (MyMathCalculator)ioc.getBean("myMathCalculator");
           System.out.println(myMathCalculator.getClass());
           //class com.qizegao.aop.MyMathCalculator$$EnhancerByCGLIB$$acfb5ca0
       }

### 5. 通知方法的执行顺序 ###

![在这里插入图片描述][20201113142058154.png_pic_center]

## 三、使用JoinPoint获取目标方法的详细信息 ##

1.  切面类的通知方法中

/** * 可以在通知方法中获取目标方法的详细信息 * 只需要在通知方法的参数列表上添加一个JoinPoint类型的参数 * JoinPoint：封装了当前目标方法的详细信息 */
       
       //在执行目标方法之前运行
       @Before("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void start(JoinPoint joinPoint) { 
           //获取到目标方法使用的参数
           Object[] args = joinPoint.getArgs();
           System.out.println("目标方法使用的参数是：" + Arrays.asList(args));
           //获取到目标方法的签名
           org.aspectj.lang.Signature signature = joinPoint.getSignature();
           //获取目标方法的方法名
           String name = signature.getName();
           System.out.println("目标方法的方法名是：" + name);
       }

1.  测试类

@Test
       public void test() { 
           MyMathCalculator bean = ioc.getBean(MyMathCalculator.class);
           bean.add(1, 2);
           /** * 目标方法使用的参数是：[1, 2] * 目标方法的方法名是：add * 整个方法执行完毕！ * 正常执行完成！ */
       }

## 四、获取目标方法的返回值 ##

1.  切面类的通知方法中

/** * 获取目标方法的返回值： * 在通知方法的参数中加返回值类型的参数 * 在注解中说明此参数是用来做什么的(只有在@AfterReturning注解中才有returning)： * returning = "参数名" * 表示此参数是用来接收目标方法的返回值的 * * 注：切入点表达式是注解中的value属性值 */
       
       //目标方法正常执行完之后执行
       @AfterReturning(value="execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))", returning="obj")
       public static void afterreturn(JoinPoint joinPoint, Object obj) { 
           System.out.println("目标方法的参数是：" + Arrays.asList(joinPoint.getArgs()));
           System.out.println("目标方法的返回值是：" + obj);
       }

1.  测试类

@Test
       public void test() { 
           MyMathCalculator bean = ioc.getBean(MyMathCalculator.class);
           bean.add(1, 2);
           /** * 目标方法开始执行了 * 整个方法执行完毕！ * 目标方法的参数是：[1, 2] * 目标方法的返回值是：3 */
       }

## 五、获取目标方法的异常信息 ##

用法与获取目标方法的返回值类似，只是只有在@AfterThrowing注解中才能使用：  
throwing = “异常类型的参数名”

注意：切面类中通知方法的参数不可以乱写，每个参数Spring都必须知道是什么

## 六、可重用的切入点表达式 ##

### 1. 背景 ###

修改切入点表达式时需要去每个通知方法的切入点表达式一个一个的去修改，如果将这些通知方法的切入点表达式抽取出来，别的通知方法都来引用，则修改一处即可使所有通知方法的切入点表达式都修改

### 2. 使用步骤 ###

(1) 随便声明一个方法体中没有任何内容的返回值为void的空方法  
(2) 给声明的此方法加注解@Pointcut(“抽取的切入点表达式”)  
(3) 在其余通知方法原来使用切入点表达式的地方修改为此方法名

### 3. 代码演示 ###

![在这里插入图片描述][20201113142205843.png_pic_center]

## 七、环绕通知 ##

以上四种通知方法结合在一起就是环绕通知

环绕通知的通知方法中有一个ProceedingJoinPoint类型的参数，ProceedingJoinPoint接口继承于 JoinPoint接口，有一个返回Object类型的proceed(Object\[\] args)方法，相当于动态代理中的 method.invoke方法，用来执行目标方法，参数是目标方法的参数列表

代码演示：

@Around("execution(public int com.qizegao.aop.MyMathCalculator.add(int, int))")
       public Object myAround(ProceedingJoinPoint pjp) throws Throwable { 
           Object[] args = pjp.getArgs();
           Object proceed = null; //记录目标方法的返回值
           try { 
              System.out.println("环绕通知的@Before执行");
              
              proceed = pjp.proceed(args); //method.invoke();
              
              System.out.println("环绕通知的@AfterReturning执行");
           } catch (Exception e) { 
              System.out.println("环绕通知的@AfterThrowing执行");
           } finally { 
              System.out.println("环绕通知的@After执行");
           }
           System.out.println("目标方法的返回值是:" + proceed);
           return proceed; //返回目标方法的返回值
       }
    
       @Test
       public void test() { 
           MyMathCalculator bean = ioc.getBean(MyMathCalculator.class);
           bean.add(1, 2);
       }

运行结果：

![在这里插入图片描述][20201113142228306.png_pic_center]

## 八、五种通知方法都使用的执行顺序 ##

![在这里插入图片描述][20201113142238877.png_pic_center]

注意：

1.  由于环绕通知的@AfterThrowing会先执行，故出现异常如果环绕通知将其catch掉，则普通 的@AfterThrowing将检测不到这个异常，故需要在通知方法的@AfterThrowing中将此异常 抛出去，方便普通@AfterThrowing也可检测到此异常
2.  可以看出环绕通知比其余通知先执行

## 九、环绕通知与其余四个通知的不同 ##

1.  其余四个通知都是简单的通知方法，不可以对目标方法进行修改
2.  环绕通知可以修改目标方法的参数(获取到之后可以在通知方法中修改)，也可以修改目标方法的 返回值(直接修改通知方法中return语句的返回值)

## 十、多个切面类的运行顺序 ##

使用@Order注解指定切面类的运行顺序，注解中是int型的数字，数字越小越先执行；  
如果没有使用@Order注解，则切面类的执行顺序由类名按字母排序的大小决定

代码演示：

@Component
    @Aspect
    @Order(1)
    public class class1 { 
       //在执行目标方法之前运行
       @Before("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void start() { 
           System.out.println("class1的普通@Before执行");
       }
       
       //目标方法正常执行完之后执行
       @AfterReturning("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void afterreturn() { 
           System.out.println("class1的普通@AfterReturning / @AfterThrowing执行");
       }
       
       //目标方法出现异常之后执行
       @AfterThrowing("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void afterexception() { 
           System.out.println("class1的普通@AfterThrowing执行");
       }
    }
    
    
    @Aspect
    @Component
    @Order(2)
    public class class2 { 
       //在执行目标方法之前运行
       @Before("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void start() { 
           System.out.println("class2的普通@Before执行");
       }
       
       //目标方法正常执行完之后执行
       @AfterReturning("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void afterreturn() { 
           System.out.println("class2的普通@AfterReturning / @AfterThrowing执行");
       }
       
       //目标方法出现异常之后执行
       @AfterThrowing("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void afterexception() { 
           System.out.println("class2的普通@AfterThrowing执行");
       }
       
       //目标方法运行结束之后执行
       @After("execution(public int com.qizegao.aop.MyMathCalculator.*(int, int))")
       public static void after() { 
           System.out.println("class2的普通@After执行");
       }
    }

测试：

![在这里插入图片描述][20201113142306908.png_pic_center]

解释：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 4]

在切面类class1加上环绕通知后的执行顺序：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 5]

## 十一、使用基于xml中配置的AOP (不使用注解) ##

<bean id="myMathCalculator" class="com.atguigu.impl.MyMathCalculator"></bean>
       
       <bean id="BValidateApsect" class="com.atguigu.utils.BValidateApsect"></bean>
       <bean id="logUtils" class="com.atguigu.utils.LogUtils"></bean>
       
       
       <aop:config>
           
           <aop:pointcut id="globalPoint" expression="execution(* com.atguigu.impl.*.*(..))"/>
       
           
           <aop:aspect ref="logUtils" order="1">
              
              
              
              <aop:before method="logStart" pointcut="execution(* com.atguigu.impl.*.*(..))"/>
              <aop:after-returning method="logReturn" pointcut-ref="globalPoint" returning="result"/>
              <aop:after-throwing method="logException" pointcut-ref="globalPoint" throwing="exception"/>
              <aop:after method="logEnd" pointcut-ref="globalPoint"/>
              <aop:around method="myaround" pointcut-ref="globalPoint"/>
           </aop:aspect>
       
           
           <aop:aspect ref="BValidateApsect" order="2">
              <aop:before method="logStart" pointcut-ref="globalPoint"/>
              <aop:after-returning method="logReturn" pointcut-ref="globalPoint" returning="result"/>
              <aop:after-throwing method="logException" pointcut-ref="globalPoint" throwing="exception"/>
              <aop:after method="logEnd" pointcut-ref="globalPoint"/>
           </aop:aspect>
       </aop:config>

![在这里插入图片描述][20201113142341755.png_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/eca7c7fff04b48918853c4517a0ebd82.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/2051c77b7e8641e799ad1fb261b3469c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221120/a5dd0d645fbe43a38d43359ec52229f0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221120/eab7ce834add40efa07f357cfae400f7.png
[20201113141931200.png_pic_center]: /images/20221120/f701a1af59c141b79a11ba44f8453212.png
[20201113142058154.png_pic_center]: /images/20221120/cb022f962805463b8b200c73172154c4.png
[20201113142205843.png_pic_center]: /images/20221120/7b738b471f67446eb7040983c39a2dbb.png
[20201113142228306.png_pic_center]: /images/20221120/dbd99178281747bfbdfc58bdc06cc8af.png
[20201113142238877.png_pic_center]: /images/20221120/1ccf3f3f30fc446bb49c4bd5c7421cd2.png
[20201113142306908.png_pic_center]: /images/20221120/b39763fbaf814de880cb34f0cf3dc480.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221120/d19035576be84256ac9b006481998913.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221120/170864bd3ede4797a94fc268ae193ee2.png
[20201113142341755.png_pic_center]: /images/20221120/20661544d8ce4de49dbc69701549e838.png