Spring-AOP

小简

发布于 2023-01-04 15:00:20

3330

发布于 2023-01-04 15:00:20

文章被收录于专栏：简言之简言之

前言

今天开始学习我自己总结的 Java-学习路线中的《Spring-AOP》，小简从 0 开始学 Java 知识，并不定期更新所学笔记，期待一年后的蜕变吧！

概念

AOP：面向切面编程，利用 AOP 可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

通俗描述：不通过修改源代码方式，在主干功能里面添加新功能

底层原理

AOP底层使用动态代理

1、有接口情况，使用 JDK 动态代理
- 创建接口实现类代理对象，增强类的方法
2、没有接口情况，使用 CGLIB 动态代理
- 创建子类的代理对象，增强类的方法

JDK动态代理

JDK 动态代理，使用 Proxy 类里面的方法创建代理对象，调用 newProxyInstance 方法

public static Object newProxyInstance(ClassLoader loader,
                                      Class<?>[] interfaces,
                                      InvocationHandler h)

第一参数，类加载器
第二参数，增强方法所在的类，这个类实现的接口，支持多个接口
第三参数，实现这个接口 InvocationHandler，创建代理对象，写增强的部分

模拟 JDK 动态代理代码

场景：现有 add 和 update 两方法，在不改变源码的情况下，增强这两方法

Step1：创建接口，定义方法

public interface UserDao {
    public int add(int a, int b);
    public String update(String id);
}

Step2：创建接口实现类，实现方法

public class UserDaoImpl implements UserDao {
    @Override
    public int add(int a, int b) {
        System.out.println("add方法执行了 ...");
        return a + b;
    }
    @Override
    public String update(String id) {
        System.out.println("update方法执行了 ...");
        return id;
    }
}

Step3: 使用 Proxy 类创建接口代理对象

public class JDKProxy {
    public static void main(String[] args) {
        // 创建接口实现类代理对象
        Class[] interfaces = {UserDao.class};
        // 注入接口实现类
        UserDaoImpl userDao = new UserDaoImpl();
        UserDao dao = (UserDao) Proxy.newProxyInstance(JDKProxy.class.getClassLoader(), interfaces, new UserDaoProxy(userDao));
        int add = dao.add(1, 2);
        System.out.println("add结果："+ add);
        String update = dao.update("1");
        System.out.println("update结果："+ update);
    }
}
// 创建代理对象代码
class UserDaoProxy implements InvocationHandler {
    // 把创建的代理对象传递过来
    // 通过有参构造传递
    private Object obj;
    public UserDaoProxy(Object obj) {
        this.obj = obj;
    }
    // 当该对象被调用就执行invoke方法
    // 增强逻辑编写在invoke方法中
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        // 方法之前处理
        System.out.println("方法之前执行...\n" + method.getName() + "传递的参数：" + Arrays.toString(args));
        // 被增强的方法执行
        Object res = method.invoke(obj, args);
        // 对不同方法进行不同增强
        if (method.getName() == "add") {
            System.out.println("增强add方法 ...");
        } else if (method.getName() == "update") {
            System.out.println("增强update方法 ...");
        }
        // 方法之后处理
        System.out.println("方法之后执行..." + obj);
        return res;
    }
}
/**
方法之前执行...
add传递的参数：[1, 2]
add方法执行了 ...
增强add方法 ...
方法之后执行...com.jwt.aop.UserDaoImpl@63947c6b
add结果：3
方法之前执行...
update传递的参数：[1]
update方法执行了 ...
增强update方法 ...
方法之后执行...com.jwt.aop.UserDaoImpl@63947c6b
update结果：1
**/

操作术语

连接点：类里面哪些方法可以被增强，哪些方法就被称为连接点

切入点：实际上被增强的方法，称为切入点

通知(增强)：实际增强的逻辑部分称为通知(增强)，即在切入点加入的逻辑代码就称为通知(增强)，通知有多种类型

①前置通知：在切入点之前所执行的方法
②后置通知：在切入点之后所执行的方法
③环绕通知：在切入点之前之后都执行的方法
④异常通知：当切入点异常时执行的方法
⑤最终通知：最终一定会执行的方法

切面：一个动作，将通知应用到切入点的过程就叫切面

AOP操作

Spring 框架一般都是基于 AspectJ 实现 AOP 操作，AspectJ 是独立 AOP 框架而不是 Spring 组成部分，一般把 AspectJ 和 Spirng 框架一起使用，进行 AOP 操作

基于 AspectJ 实现 AOP 操作

1、基于 xml 配置文件实现
2、基于注解方式实现

准备工作

1、引入AOP相关依赖

需要导入如下5个依赖包

spring-aop-5.3.18.jar //（Spring自带）
spring-aspects-5.3.18.jar //（Spring自带）
aspectjweaver.jar
aopalliance.jar
cglib-3.3.0.jar

AspectJ下载：AspectJ Downloads
下载后运行 aspectj-1.9.6.jar 在 lib 目录下可以找到 aspectjweaver.jar
或者直接在这下载aspectjweaver
aopalliance下载：aopalliance.jar，需要等待一下才会弹出下载框。
cglib下载：cglib/cglib (github.com)

2、了解切入点表达式

切入点表达式作用：知道对哪个类里面的哪个方法进行增强
语法结构：execution([权限修饰符] [返回类型] [类全路径].[方法名称](..))
- 权限修饰符：可以省略
- 返回类型：可使用通配符*，表示任意返回值
- 类全类名：类路径下的完整路径
- 方法名称()：指定哪个方法增强，()填入方法参数列表，..两个点表示方法中的参数

//例 1：对 com..dao.BookDao 类里面的 add 进行增强
execution(* com.atguigu.dao.BookDao.add(..))

//例 2：对 com.dao.BookDao 类里面的所有的方法进行增强
execution(* com.atguigu.dao.BookDao.*(..))

//例 3：对 com.dao 包里面所有类，类里面所有方法进行增强
execution(* com.atguigu.dao.*.*(..))

基于注解方式实现

Step1：创建类，在类里面定义方法

// 被增强的类
@Component
public class User {
    public void add() {
        //int i = 10 / 0;
        System.out.println("add ...");
    }
}

Step2：创建增强类(编写增强逻辑)

// 增强类
@Component
// 生成代理对象
@Aspect
public class UserProxy {
    // 前置通知 @Before:表示前置通知 value增强User的add方法
    @Before(value = "execution(* com.jwt.aop.User.add(..))")
    public void before() {
        System.out.println("before前置通知 ...");
    }
    // 最终通知
    @After(value = "execution(* com.jwt.aop.User.add(..))")
    public void after() {
        System.out.println("after最终通知 ...");
    }
    // 后置通知（返回通知）
    @AfterReturning(value = "execution(* com.jwt.aop.User.add(..))")
    public void afterReturning() {
        System.out.println("afterReturning后置通知（返回通知） ...");
    }
    // 异常通知
    @AfterThrowing(value = "execution(* com.jwt.aop.User.add(..))")
    public void afterThrowing() {
        System.out.println("afterThrowing异常通知 ...");
    }
    // 环绕通知
    @Around(value = "execution(* com.jwt.aop.User.add(..))")
    public void around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        System.out.println("环绕通知around环绕之前 ...");
        // 执行被增强的方法
        proceedingJoinPoint.proceed();
        System.out.println("环绕通知around环绕之后 ...");
    }
}

Step3：在 spring 配置文件中，进行通知的配置

1、开启context和aop命名空间
2、开启注解包扫描
3、开启AspectJ生成代理对象

<!-- 开启context和aop命名空间-->
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!-- 开启注解扫描 -->
    <context:component-scan base-package="com.jwt.aop"></context:component-scan>
    <!-- 开启Aspect生成代理对象-->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>

Step4：测试

public class TestBean {
    @Test
    public void test() {
        //1 加载 spring 配置文件
        ApplicationContext context =
                new ClassPathXmlApplicationContext("bean2.xml");
        //2 获取配置创建的对象
        User user = context.getBean("user", User.class);
        System.out.println(user);
        user.add();
    }
}
/**
com.jwt.aop.User@3cebbb30
环绕通知around环绕之前 ...
before前置通知 ...
add ...
afterReturning后置通知（返回通知） ...
after最终通知 ...
环绕通知around环绕之后 ...
**/

抽取公共切入点

定义公共切入点

@Pointcut(value = "execution(* com.jwt.aop.User.add(..))")
public void pointDemo() {}

引用公共切入点

// 前置通知
@Before(value = "pointDemo()")
public void before() {
    System.out.println("before前置通知 ...");
}

// 最终通知
@After(value = "pointDemo()")
public void after() {
      System.out.println("after最终通知 ...");
}

对同一切入点设置优先级

场景：有多个增强类对同一个方法进行增强，设置增强类优先级

@Component
@Aspect
@Order(0) // 对同一切入点增强的优先级 值越小优先级别越高
public class PersonProxy {
}

@Component
@Aspect
@Order(1) // 对同一切入点增强的优先级 值越小优先级别越高
public class UserProxy {
}

PersonProxy 比 UserProxy 先对方法进行增强

完全使用注解开发

创建配置类

@Configuration// @Configuration作为配置类 替代xml配置文件
@ComponentScan(basePackages = {"com.jwt.aop"})
@EnableAspectJAutoProxy(proxyTargetClass = true)
public class SpringConfig2 {
}

测试

@Test
public void test2() {
  AnnotationConfigApplicationContext context = 
    new AnnotationConfigApplicationContext(SpringConfig2.class);
  User user = context.getBean("user", User.class);
  System.out.println(user);
  user.add();
}

/**
com.jwt.aop.User@f736069
环绕通知around环绕之前 ...
before前置通知 ...
add ...
afterReturning后置通知（返回通知） ...
after最终通知 ...
环绕通知around环绕之后 ...
**/

基于 xml 配置实现

Step1：创建两个类,增强类和被增强类

public class Book {
    public void buy() {
        System.out.println("buy ...");
    }
}

public class BookProxy {
    public void before() {
        System.out.println("before ...");
    }
    public void after() {
        System.out.println("after ...");
    }
}

Step2：开启aop命名空间

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
   
</beans>

Step3：在spring配置文件中创建两个类的实例对象

<!--创建对象-->
<bean id="book" class="com.jwt.aop.Book"/>
<bean id="bookProxy" class="com.jwt.aop.BookProxy"/>

Step4：在spring配置文件中配置切入点

<!--配置aop增强-->
<aop:config>
  <!--配置切入点-->
  <aop:pointcut id="p" expression="execution(* com.jwt.aop.Book.buy(..))"/>
  <!--配置切面-->
  <aop:aspect ref="bookProxy">
    <!--把before方法作用在公共切入点指定的切入点上面-->
    <aop:before method="before" pointcut-ref="p"/>

    <!--不适用公共切入点-->
    <aop:after method="after" pointcut="execution(* com.jwt.aop.Book.buy(..))"/>
  </aop:aspect>
</aop:config>

Step5：测试

@Test
public void testAopXml() {
  ClassPathXmlApplicationContext context = 
    new ClassPathXmlApplicationContext("bean3.xml");
  Book book = context.getBean("book", Book.class);
  book.buy();
}
/**
before ...
buy ...
after ...
**/