0%

Java 企业开发基础 Spring5-AOP

AOP概述

面向切面(方面)编程,不修改源代码进行功能增强。

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

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

在这里插入图片描述

AOP底层原理

底层是通过动态代理的方式实现的。

动态代理的两种情况

  • 有接口情况:使用 JDK 动态代理。

    创建接口实现类的代理对象,增强类的方法。

    有接口情况

  • 没有接口情况:使用 CGLIB 动态代理

    创建当前类的子类的代理对象,增强类的方法。

    没有接口情况

JDK 动态代理

使用 JDK 动态代理,使用 Proxy 类里面的方法创建代理对象。调用 newProxyInstance 方法,方法有三个参数:

  • ClassLoader 类加载器
  • interfaces 增强方法所在的类,这个类实现的接口,支持多个接口
  • InvocationHandler 实现这个接口 InvocationHandler,创建代理对象,写增强的部分

实例代码

创建接口

1
2
3
4
5
6
7
8
9
10
11
package com.xzt;

/**
* @author xzt
* @version 1.0
*/
public interface UserDao {
public int add(int a, int b);

public String update(String id);
}

创建接口实现类,实现方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.xzt;

/**
* @author xzt
* @version 1.0
*/
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;
}
}

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.xzt;

import java.lang.reflect.Array;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.Arrays;

/**
* @author xzt
* @version 1.0
*/
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 result = dao.add(1, 2);
System.out.println(result);
// 下面这样也可以
/*Proxy.newProxyInstance(JDKProxy.class.getClassLoader(), interfaces, new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
return null;
}
});*/
}
}

// 创建代理对象代码
class UserDaoProxy implements InvocationHandler {
// 1.把创建的是谁的代理对象,把谁传递过来。
// 通过有参构造传递
private Object obj;

public UserDaoProxy(Object obj) {
this.obj = obj;
}

// 增强的逻辑
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

// 方法执行之前
System.out.println("方法执行之前执行...." + method.getName() + ":" + Arrays.toString(args));

// 增强的方法执行
Object res = method.invoke(obj, args);

// 方法执行之后执行
System.out.println("方法之后执行..." + obj);

return res;
}
}

运行结果

image-20220927144305893

AOP 相关术语

  • 连接点:类里面哪些方法可以被增强,这些方法称为连接点
  • 切入点:实际被真正增强的方法称为切入点
  • 通知(增强):实际增强的逻辑部分称为通知,且分为以下五种类型:
    • 1)前置通知 2)后置通知 3)环绕通知 4)异常通知 5)最终通知
  • 切面:把通知应用到切入点过程

AOP 操作

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

基于 AspectJ 实现 AOP 操作:

  • 基于 xml 配置文件实现
  • 基于注解方式实现(最常使用)

步骤

  • 引入相关依赖 spring-aspects-5.3.23.jar com.springsource.net.sf.cglib-2.2.0.jar com.springsource.org.aopalliance-1.0.0.jar com.springsource.org.aspectj.weaver-1.6.8.RELEASE.jar

切入点表达式

作用:知道对哪个类里面的哪个方法进行增强

语法结构execution([权限修饰符] [返回类型] [类全路径] [方法名称]([参数列表]))

示例代码

1
2
3
4
5
6
// 对 com.atguigu.dao.BookDao 类里面的 add 进行增强
execution(* com.atguigu.dao.BookDao.add(..))
// 对 com.atguigu.dao.BookDao 类里面的所有的方法进行增强
execution(* com.atguigu.dao.BookDao.*(..))
// 对 com.atguigu.dao 包里面所有类,类里面所有方法进行增强
execution(* com.atguigu.dao.*.*(..))

AspectJ 注解

  1. 创建类,在类里面定义方法

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    package com.xzt.aopanno;

    /**
    * @author xzt
    * @version 1.0
    * 被增强的类
    */
    public class User {
    public void add() {
    System.out.println("add......");
    }
    }

  2. 创建增强类(编写增强的逻辑)。在增强类里面创建方法,让不同的方法代表不同的通知类型。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    package com.xzt.aopanno;

    import org.aspectj.lang.annotation.Aspect;
    import org.springframework.stereotype.Component;

    /**
    * @author xzt
    * @version 1.0
    * 增强的类
    */
    public class UserProxy {
    // 前置通知
    public void before(){
    System.out.println("before.....");
    }
    }

  3. 进行通知的配置

    1. 在Spring的配置文件中,开启注解扫描

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      <?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.xzt.aopanno"></context:component-scan>
      </beans>
    2. 使用注解创建 UserUserProxy 对象,在每个类上添加注解@Component

      1
      2
      3
      4
      5
      6
      7
      @Component
      public class User {
      }

      @Component
      public class UserProxy {
      }
    3. 在增强类上添加注解@Aspect

      1
      2
      3
      @Component
      @Aspect // 生成代理对象
      public class UserProxy {
    4. 在 spring 配置文件中开启生成代理对象

      1
      2
      <!-- 开启AspectJ 生成代理对象 -->
      <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
  4. 配置不同类型的通知。在增强类的里面,在作为通知方法上面添加通知类型注解,使用切入点表达式配置。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    package com.xzt.aopanno;

    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.*;
    import org.springframework.stereotype.Component;

    /**
    * @author xzt
    * @version 1.0
    * 增强的类
    */
    @Component
    @Aspect // 生成代理对象
    public class UserProxy {
    // 前置通知
    // @Before注解表示作为前置通知
    @Before(value = "execution(* com.xzt.aopanno.User.add(..))")
    public void before() {
    System.out.println("before.....");
    }

    @After(value = "execution(* com.xzt.aopanno.User.add(..))")
    public void after() {
    System.out.println("after.....");
    }

    @AfterReturning(value = "execution(* com.xzt.aopanno.User.add(..))")
    public void afterReturning() {
    System.out.println("afterReturning.....");
    }

    @AfterThrowing(value = "execution(* com.xzt.aopanno.User.add(..))")
    public void afterThrowing() {
    System.out.println("afterThrowing.....");
    }

    // 环绕通知
    @Around(value = "execution(* com.xzt.aopanno.User.add(..))")
    public void around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
    System.out.println("环绕之前.....");
    // 被增强的方法执行
    proceedingJoinPoint.proceed();

    System.out.println("环绕之后.....");
    }

    }
  5. 进行测试

    1
    2
    3
    4
    5
    6
    7
    @Test
    public void testDemo() {
    ApplicationContext context = new ClassPathXmlApplicationContext("bean.xml");
    User user = context.getBean("user", User.class);

    user.add();
    }

    image-20220927152920890

公共切入点抽取

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.xzt.aopanno;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

/**
* @author xzt
* @version 1.0
* 增强的类
*/
@Component
@Aspect // 生成代理对象
public class UserProxy {

// 相同切入点抽取
@Pointcut(value = "execution(* com.xzt.aopanno.User.add(..))")
public void pointdemo() {

}
// 前置通知
// @Before注解表示作为前置通知
@Before(value = "pointdemo()")
public void before() {
System.out.println("before.....");
}

@After(value = "pointdemo()")
public void after() {
System.out.println("after.....");
}

@AfterReturning(value = "pointdemo()")
public void afterReturning() {
System.out.println("afterReturning.....");
}

@AfterThrowing(value = "pointdemo()")
public void afterThrowing() {
System.out.println("afterThrowing.....");
}

// 环绕通知
@Around(value = "pointdemo()")
public void around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
System.out.println("环绕之前.....");
// 被增强的方法执行
proceedingJoinPoint.proceed();

System.out.println("环绕之后.....");
}

}

设置增强类的优先级

多个增强类 对同一个方法 进行增强,可以设置优先级:

  • 在增强类的上面添加注解@Order(值),值越小优先级越高
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package com.xzt.aopanno;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

/**
* @author xzt
* @version 1.0
*/
@Component
@Aspect
@Order(3) // 设置有优先级
public class PersonProxy {
// 前置通知
// @Before注解表示作为前置通知
@Before(value = "execution(* com.xzt.aopanno.User.add(..))")
public void before() {
System.out.println("Person before.....");
}
}

AspectJ 配置文件💤

  1. 创建两个类 增强类 和 被增强类,创建方法

  2. 在 spring 配置文件中创建两个类对象

    1
    2
    <bean id="user" class="com.xzt.aopanno.User"></bean>
    <bean id="userProxy" class="com.xzt.aopanno.UserProxy"></bean>
  3. 在 spring 配置文件中配置切入点。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    <!-- 配置aop增强 -->
    <aop:config>
    <!-- 配置切入点 -->
    <aop:pointcut id="p" expression="execution(* com.xzt.aopanno.User.add(..))"/>

    <!-- 配置切面 -->
    <aop:aspect ref="userProxy">
    <!-- 增强作用在具体的方法上 -->
    <aop:before method="before" pointcut-ref="p"></aop:before>
    </aop:aspect>
    </aop:config>

纯注解开发⭐⭐⭐

需要编写配置文件(ConfigAPP.java)代替xml配置文件,上面写上三个注解。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.xzt.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;

/**
* @author xzt
* @version 1.0
*/
@Configuration // 配置文件
@ComponentScan(basePackages = {"com.xzt"}) // IOC组件扫描
@EnableAspectJAutoProxy(proxyTargetClass = true) // 生成AspectJ代理对象
public class ConfigApp {
}
正在加载今日诗词....