• Spring框架之AOP

    目录

    一、AOP的简介

            1.1 对aop的理解？

            1.2 aop能解决的问题？

            1.3 aop的关键概念名词？

    二、通知代码的分类

            2.1 前置通知

            2.2 后置通知

            2.3 环绕通知

            2.4 异常通知

            2.5 过滤通知（适配器）

    一、AOP的简介

            1.1 对aop的理解？

        AOP是一种面向切面编程，可以完成一些非核心业务的功能。

            1.2 aop能解决的问题？

    不需要在原有的业务逻辑中添加任何代码，就可以实现共性非业务功能。

    例如：书籍的增删改，本身只需要完成增删改的功能即可，这是如果需要添加日志功能，那么需要在原有的代码基础上，去修改添加日志功能，受牵连的方法就三个（add/edit/del）了;

            1.3 aop的关键概念名词？

            AOP有一些关键性的概念名词，非常重要，我们来一一看看：

            ①：连接点(Joinpoint)

    连接点(Joinpoint)：程序执行过程中明确的点，如方法的调用，或者异常的抛出。

            ②：目标对象(Target)

    目标(Target)：被通知(被代理)的对象

    注1：完成具体的业务逻辑

            ③：通知(Advice)

    通知(Advice)：在某个特定的连接点上执行的动作，同时Advice也是程序代码的具体实现，例如一个实现日志记录的代码(通知有些书上也称为处理)

    注2：完成切面编程

            ④：代理(Proxy)

    代理(Proxy)：将通知应用到目标对象后创建的对象(代理=目标+通知),

                 例子：外科医生+护士

    注3：只有代理对象才有AOP功能，而AOP的代码是写在通知的方法里面的

            ⑤：切入点(Pointcut)

    切入点(Pointcut)：多个连接点的集合，定义了通知应该应用到那些连接点。

                     (也将Pointcut理解成一个条件 ，此条件决定了容器在什么情况下将通知和目标组合成代理返回给外部程序)

            ⑥：适配器(Advisor)

    适配器(Advisor)：适配器=通知(Advice)+切入点(Pointcut) 

    二、通知代码的分类

    关于aop切面编程主要就是写通知，所以我们着重来看一下通知方面的一些案例！

            2.1 前置通知

            首先我们准备一些类：

            BookBiz接口类：

    1. package com.leaf.aop.biz;
    2.  
    3. public interface BookBiz {
    4. 	
    5. 	// 购书
    6. 	public boolean buy(String userName, String bookName, Double price);
    7.  
    8. 	// 发表书评
    9. 	public void comment(String userName, String comments);
    10. 	
    11. }

            PriceException 异常类：

    1. package com.leaf.aop.exception;
    2.  
    3. /**
    4.  * 异常类
    5.  * @author Leaf
    6.  *
    7.  * 2022年8月7日 下午11:13:58
    8.  */
    9. public class PriceException extends RuntimeException {
    10.  
    11. 	public PriceException() {
    12. 		super();
    13. 	}
    14.  
    15. 	public PriceException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
    16. 		super(message, cause, enableSuppression, writableStackTrace);
    17. 	}
    18.  
    19. 	public PriceException(String message, Throwable cause) {
    20. 		super(message, cause);
    21. 	}
    22.  
    23. 	public PriceException(String message) {
    24. 		super(message);
    25. 	}
    26.  
    27. 	public PriceException(Throwable cause) {
    28. 		super(cause);
    29. 	}
    30. 	
    31. }

    BookBizImpl实现类：就是前面说的目标对象

    1. package com.leaf.aop.impl;
    2.  
    3. import com.leaf.aop.biz.BookBiz;
    4. import com.leaf.aop.exception.PriceException;
    5.  
    6. /**
    7.  * 实现类
    8.  * @author Leaf
    9.  *
    10.  * 2022年8月7日 下午11:15:02
    11.  */
    12. public class BookBizImpl implements BookBiz {
    13.  
    14. 	public BookBizImpl() {
    15. 		super();
    16. 	}
    17.  
    18. 	public boolean buy(String userName, String bookName, Double price) {
    19. 		// 通过控制台的输出方式模拟购书
    20. 		if (null == price || price <= 0) {
    21. 			throw new PriceException("book price exception");
    22. 		}
    23. 		System.out.println(userName + " buy " + bookName + ", spend " + price);
    24. 		return true;
    25. 	}
    26.  
    27. 	public void comment(String userName, String comments) {
    28. 		// 通过控制台的输出方式模拟发表书评
    29. 		System.out.println(userName + " say:" + comments);
    30. 	}
    31.  
    32. }

     准备工作做好了后我们就可以开始来编写第一个通知啦：

    目标：实现在买书、评论前加系统日志

    前置通知类：MyMethodBeforeAdvice

    1. package com.leaf.aop.advice;
    2.  
    3. import java.lang.reflect.Method;
    4. import java.util.Arrays;
    5.  
    6. import org.springframework.aop.MethodBeforeAdvice;
    7.  
    8. /**
    9.  * 前置通知
    10.  *	实现org.springframework.aop.MethodBeforeAdvice接口
    11.  *	买书、评论前加系统日志
    12.  * @author Leaf
    13.  *
    14.  * 2022年8月7日 下午11:20:13
    15.  */
    16. public class MyMethodBeforeAdvice implements MethodBeforeAdvice {
    17.  
    18. 	@Override
    19. 	public void before(Method arg0, Object[] arg1, Object arg2) throws Throwable {
    20. 		//买书、评论前加系统日志
    21. 		//拿到目标对象的类名
    22. 		String clzName = arg2.getClass().getName();
    23. 		//拿到当前调用的方法名
    24. 		String methodName = arg0.getName();
    25. 		//调用当前方法所传递的参数
    26. 		String args = Arrays.toString(arg1);
    27. 		//系统日志
    28. 		System.out.println("【系统日志】："+clzName+"."+methodName+"被调用，传递的参数为："+args);
    29. 	}
    30. 	
    31. }

    配置到Spring-context.xml文件： 

    2. <beans xmlns="http://www.springframework.org/schema/beans"
    3. 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4. 	xmlns:aop="http://www.springframework.org/schema/aop"
    5. 	xmlns:context="http://www.springframework.org/schema/context"
    6. 	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
    7. 		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
    8. 		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">
    9. 	
    10. 	
    11. 	<bean class="com.leaf.aop.impl.BookBizImpl" id="bookBiz">bean>
    12. 	
    13. 	
    14. 	<bean class="com.leaf.aop.advice.MyMethodBeforeAdvice" id="myBefore">bean>
    15. 	
    16. 	
    17. 	<bean class="org.springframework.aop.framework.ProxyFactoryBean" id="bookProxy">
    18. 		
    19. 		<property name="target" ref="bookBiz">property>
    20. 		
    21. 		<property name="proxyInterfaces" >
    22. 			<list>
    23. 				<value>com.leaf.aop.biz.BookBizvalue>
    24. 			list>
    25. 		property>
    26. 		
    27. 		<property name="interceptorNames" >
    28. 			<list>
    29. 				<value>myBeforevalue>
    30. 			list>
    31. 		property>
    32. 	bean>
    33. 	
    34. beans>

    最后我们建立一个测试类来看看是否实现了前置通知：Demo1

    1. package com.leaf.aop.test;
    2.  
    3. import org.springframework.context.support.ClassPathXmlApplicationContext;
    4.  
    5. import com.leaf.aop.biz.BookBiz;
    6.  
    7. public class Demo1 {
    8. 	
    9.     @SuppressWarnings("resource")
    10. 	public static void main(String[] args) {
    11. 		
    12. 		ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("/spring-context.xml");
    13. 		//获取目标对象
    14. 		//BookBiz bean = (BookBiz) context.getBean("bookBiz");
    15. 		//获取代理对象
    16. 		BookBiz bean = (BookBiz) context.getBean("bookProxy");
    17. 		//调用买书的方法
    18. 		bean.buy("Leaf", "《JAVA编程思想》", 58.90d);
    19. 		//调用评论的方法
    20. 		bean.comment("Leaf", "对Java代码理解更深了");
    21. 		
    22. 	}
    23. 	
    24. }

     运行：

             2.2 后置通知

            目标：实现买书返利（存在bug）

            后置通知类：MyAfterReturningAdvice

    1. package com.leaf.aop.advice;
    2.  
    3. import java.lang.reflect.Method;
    4. import java.util.Arrays;
    5.  
    6. import org.springframework.aop.AfterReturningAdvice;
    7.  
    8. /**
    9.  * 后置通知
    10.  * @author Leaf
    11.  *
    12.  * 2022年8月8日 上午12:07:56
    13.  */
    14. public class MyAfterReturningAdvice implements AfterReturningAdvice {
    15. 	
    16. 	@Override
    17. 	public void afterReturning(Object arg0, Method arg1, Object[] arg2, Object arg3) throws Throwable {
    18. 		//拿到目标对象的类名
    19. 		String clzName = arg3.getClass().getName();
    20. 		//拿到当前调用的方法名
    21. 		String methodName = arg1.getName();
    22. 		//调用当前方法所传递的参数
    23. 		String args = Arrays.toString(arg2);
    24. 		//方法调用的返回值
    25. 		System.out.println("【买书返利】："+clzName+"."+methodName+"被调用，传递的参数为："+args+";目标对象方法返回值为："+arg0);
    26. 	}
    27. 	
    28. }

    然后配置到spring-context.xml的步骤和上面是一样的；

    然后我们依然运行Demo1：

    但是呢，这个时候我们的买书返利存在着一定的bug：

    不管是买书还是评论都会有返利，这不符合常规。 

    我们在后面的通知中会解决掉。 

            2.3 环绕通知

            类似拦截器，会包括切入点，目标类前后都会执行代码。

            环绕通知就等于：前置通知加上后置通知，所以我们一般就写一个环绕通知就行了。

           我们还是先写一个通知类：MyMethodInterceptor

    1. package com.leaf.aop.advice;
    2.  
    3. import java.util.Arrays;
    4.  
    5. import org.aopalliance.intercept.MethodInterceptor;
    6. import org.aopalliance.intercept.MethodInvocation;
    7.  
    8. /**
    9.  * 环绕通知=前置通知+后置通知
    10.  * @author Leaf
    11.  *
    12.  * 2022年8月8日 上午12:28:46
    13.  */
    14. public class MyMethodInterceptor implements MethodInterceptor {
    15.  
    16. 	@Override
    17. 	public Object invoke(MethodInvocation arg0) throws Throwable {
    18. 		//拿到目标对象的类名
    19. 		String clzName = arg0.getThis().getClass().getName();
    20. 		//拿到当前调用的方法名
    21. 		String methodName = arg0.getMethod().getName();
    22. 		
    23. 		//调用当前方法所传递的参数
    24. 		String args = Arrays.toString(arg0.getArguments());
    25. 		System.out.println("【环绕通知】："+clzName+"."+methodName+"被调用，传递的参数为："+args);
    26.  
    27. 		//方法调用的返回值：arg0.proceed();
    28. 		Object rs = arg0.proceed();
    29. 		System.out.println("【环绕通知】：目标对象方法返回值为："+rs);
    30. 		return rs;
    31. 	}
    32. 	
    33. }

    然后配置到spring-context.xml的步骤都还是一样的；

    最后我们就还是运行Demo1测试看效果： 

            

            2.4 异常通知

            出现异常执行系统提示，然后进行处理。价格异常为例；

            但是我们的异常通知与前面三大通知又有点不一样，它不需要实现其中的方法，

    但是它的方法名却又必须固定为：afterThrowing

    我们一起编写一 个异常通知类来看看：MyThrowsAdvice

    1. package com.leaf.aop.advice;
    2.  
    3. import org.springframework.aop.ThrowsAdvice;
    4.  
    5. import com.leaf.aop.exception.PriceException;
    6.  
    7. /**
    8.  * 关于异常通知
    9.  * 	相较于前置通知、后置通知、环绕通知有一个非常大的区别
    10.  * 	前面三大通知都需要实现其中的方法
    11.  * 	异常通知则不需要，但是，它的方法名又是固定的
    12.  * @author Leaf
    13.  *
    14.  * 2022年8月8日 上午1:48:07
    15.  */
    16. public class MyThrowsAdvice implements ThrowsAdvice {
    17. 	
    18. 	/**
    19. 	 * 异常通知方法：
    20. 	 * 	方法名必须是：afterThrowing
    21. 	 * 	不然就会报错
    22. 	 * @param p 异常类
    23. 	 */
    24. 	public void afterThrowing(PriceException p) {
    25. 		System.out.println("【异常通知】：当价格发生异常，那么执行此处代码块！！！");
    26. 	}
    27. 	
    28. }

    然后照样配置到spring-context.xml文件中；

    这次我们测试Demo1的时候把价格改为负数，即为价格异常：

    然后我们看看结果：

            

            2.5 过滤通知（适配器）

                   这个过滤通知就可以解决：我们前面后置通知写的 返利功能 的 bug；

            但是过滤通知与其他的几大通知有所不一样，不用特别写一个通知类实现，

    而是Spring提供了一个类，我们只需要在spring-context.xml中配置就好了。

    我们看看如何配置：

    2. <beans xmlns="http://www.springframework.org/schema/beans"
    3. 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4. 	xmlns:aop="http://www.springframework.org/schema/aop"
    5. 	xmlns:context="http://www.springframework.org/schema/context"
    6. 	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
    7. 		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
    8. 		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">
    9. 	
    10. 	
    11. 	<bean class="com.leaf.aop.advice.MyAfterReturningAdvice" id="myAfter">bean>
    12.  
    13. 	
    14. 	<bean class="org.springframework.aop.support.RegexpMethodPointcutAdvisor" id="myAfterPlus">
    15. 		
    16. 		<property name="advice" ref="myAfter">property>
    17. 		<property name="pattern" value=".*buy">property>
    18. 	bean>
    19.  
    21. 	<bean class="org.springframework.aop.framework.ProxyFactoryBean" id="bookProxy">
    22. 		
    23. 		<property name="target" ref="bookBiz">property>
    24. 		
    25. 		<property name="proxyInterfaces" >
    26. 			<list>
    27. 				<value>com.leaf.aop.biz.BookBizvalue>
    28. 			list>
    29. 		property>
    30. 		
    31. 		<property name="interceptorNames" >
    32. 			<list>
    33. 				
    34. 				<value>myAfterPlusvalue>
    35. 			list>
    36. 		property>
    37. 	bean>
    38. 	
    39. beans>

    然后最后我们来测试运行Demo1看看结果：

     

    OK，到这里今天Leaf带来的关于Spring的AOP模块的相关知识就结束啦，有不理解的地方可以私信或者评论问我，我们下次见啦！！！

  • 相关阅读:
    关于Google推出的AAB，你了解多少
    Idea中使用测试类，提示无可任务No tasks available
    【leetcode】【2022/9/3】646. 最长数对链
    TS项目实战三：Express实现登录注册功能后端
    Sulfo-Cy5 羧酸，Sulfo-Cyanine5 carboxylic acid，花青素荧光染料Cy5标记羧酸
    iOS - 多线程-GCD
    springboot弘德图书馆座位预约管理系统-计算机毕业设计源码07028
    记录一次Idea 无法下载源码事件
    Go在招聘中最吃香、安全工程师薪资涨幅最高 | Hired年度软件工程师报告出炉
    从零入门激光SLAM（十一）——LeGo-LOAM源码超详细解析1
  • 原文地址：https://blog.csdn.net/qq_63492318/article/details/126218611