【Java开发】 Spring 07 ：Spring AOP 实践详解（通过 AOP 打印数据访问层）

AOP 指是面向切面编程（通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术），利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率，阐述完 JDK 动态代理和 CGLIB 动态代理后将通过 AOP 技术打印数据访问层。

1 AOP 实现原理

1.1 AOP 实现

1.2 Spring AOP 核心概念及注释

③ 基于 xml 配置（以 JDK 动态代理为例）

2 通过 AOP 打印数据访问层摘要（以 mybatis-plus 的 mapper 为例）

项目源码：尹煜 / AopDemo · GitCode

1 AOP 实现原理

1.1 AOP 实现

AOP代表的是一个横向的关系，将“对象”比作一个空心的圆柱体，其中封装的是对象的属性和行为；则面向方面编程的方法，就是将这个圆柱体以切面形式剖开，选择性的提供业务逻辑。而剖开的切面，也就是所谓的“方面”了。然后它又以巧夺天功的妙手将这些剖开的切面复原，不留痕迹，但完成了效果。

简单来说，AOP 可以在不改变源码的前提下通过创建类的形式给某个方法添加新的功能。比如一个只能计算加法的方法，它想增加计算乘法的功能，但是又不想改源码！这时候可以在外面创建一个类，在这个类中通过AOP的技术给这个方法进行添加功能的操作，这就是AOP。

AOP 可用于处理系统中分布于各个模块的横切关注点，比如事务管理、日志、缓存等等。

AOP实现主要分为👇

静态代理：AspectJ 技术，是引入特定的语法创建“方面”，从而使得编译器可以在编译期间织入有关“方面”的代码。
动态代理：Spring AOP 技术，利用截取消息的方式，对该消息进行装饰，以取代原有对象行为的执行。

由于本文专注于 Spring AOP ，也就是所谓的动态代理，因此不对静态代理做过多叙述，感兴趣的可以自行百度哈，然后介绍一下Spring AOP 的核心概念及注释，初次接触这些概念可能会有点陌生，不妨敲完后边的举例代码再回头来理解一下 👇

1.2 Spring AOP 核心概念及注释

① 核心概念

概念	含义
Aspect	切面，切面是一个动作，也叫一个过程
Join Point	连接点是在应用执行过程中能够插入切面（Aspect）的一个点，简单来说是可以被增强的方法
Advice	通知，在连接点执行的动作，包括前通知、后通知、返回后通知、异常通知和环绕通知
Pointcut	切入点，说明如何匹配连接点
Introduction	引入，为现有类型声明额外的方法和属性
Target object	目标对象
AOP proxy	AOP 代理对象，可以是 JDK 动态代理，也可以是 CGLIB 代理
Weaving	织入，连接切面与目标对象或类型创建代理的过程

② 常用注解

@EnableAspectJAutoProxy：开启aspectj的支持，对打@aspectj相关注解的类做一个Proxy
@Aspect：用来声明当前这个类是一个切面，需要说明的是光加aspect还不能变成一个bean，要么使用Javaconfig将类声明成一个bean，要么增加一个@Component注解来将这个bean创建出来
@Pointcut：用来指定Pointcut，具体在代码中体现
@Before：用来指定advice是在方法执行前是执行的
@After / @AfterReturning / @AfterThrowing：不管什么情况，在你结束了之后执行；在你成功返回之后执行；在你报错的时候执行
@Around：把这个方法前后都可以处理，把代码封装到里面
@Order；指定切面的一个执行顺序，order越小，优先级越高

1.3 Spring AOP 动态代理

Spring AOP 使用的动态代理，动态代理指的是 AOP 框架不会去修改字节码，而是在内存中临时为方法生成一个AOP对象，这个AOP对象包含了目标对象的全部方法，并且在特定的切点做了增强处理，并回调原对象的方法。

动态代理形式主要分为两种：JDK动态代理和 CGLIB动态代理。

首先需要在 pom.xml 文件中导入 aspectjweaver 依赖 👇


        
        <dependency>
            <groupId>org.aspectjgroupId>
            <artifactId>aspectjweaverartifactId>
            <version>1.9.2version>
        dependency>

① JDK 动态代理

如果目标类实现接口，那么 Spring AOP 会默认选择使用 JDK 来动态代理目标类（若默认：proxy-target-class = false），不过本项目情况不大一样，请往下看~

JDK动态代理通过反射来接收被代理的类，并且要求被代理的类必须实现一个接口，也就是说 JDK 动态代理主要用于接口的 AOP 实现，用于给接口（实现该接口的类也会被增强）增加功能。

核心类包括 👇

InvocationHandler 接口
Proxy.newProxyInstance()

Ⅰ 定义一个 Chinese 接口 :


package com.aopdemo.ajdkDynamicProxy;
 
public interface Chinese {
    //定义一个 sayHello 的抽象方法
    String sayHello(String name);
}

Ⅱ 实现类–Yinyu:

Yinyu 类实现 Chinese 接口，并重写 sayHello 这个抽象方法


package com.aopdemo.ajdkDynamicProxy;
 
@Component //实例化到spring容器中，相当于配置文件中的 
public class Yinyu implements Chinese{
 
    @Override
    public void sayHello(String name) {
        System.out.println(name + "hello, AOP");
    }
 
    public void eat(String food) {
        System.out.println("我正在吃：" + food);
    }
}

Ⅲ 定义Aspect


package com.aopdemo.ajdkDynamicProxy;
 
@Aspect
@Component
public class DynamicProxyAdvice {
 
    //针对 Yinyu 类下的 sayHello 方法进行切入
    @Pointcut("execution(* com.aopdemo.ajdkDynamicProxy.Yinyu.sayHello(..))")
    public void pointcut() {
    }
 
    //接入点的前置操作
    @Before("pointcut()")
    public void before() {
        System.out.println("before");
    }
}

Ⅳ 使用测试类进行测试


package com.aopdemo;
 
@SpringBootTest
class AopdemoTests {
 
    @Autowired
    private Chinese chinese;
 
    @Test
    void ajdkDynamicProxyTest() {
        chinese.sayHello("yinyu say：");
        System.out.println(chinese.getClass());
    }
}

Ⅴ 配置 properties + 输出结果

注意：本项目若不按以下配置，那么将采用 CGLIB 动态代理，按理说 Yinyu 对象实现了接口，默认情况下会采用 JDK 的动态代理实现 AOP（同时默认情况下 spring.aop.proxy-target-class = false），但我实践的话并非如此，因此可以得出默认情况下proxy-target-class="true"（如果目标对象实现了接口，可以强制使用CGLIB实现AOP），至少我这个项目是这样。

所以我将 proxy-target-class 配置成了 false ，如果大家不需要此配置也可输出 $Proxy61 的话就不用这个配置。

路径：src/main/resources/application.properties

spring.aop.proxy-target-class = false

输出结果 👇

可以看到类型是 class com.sun.proxy.$Proxy61，也就是前面提到的 Proxy 类，因此这里 Spring AOP 使用了 JDK 的动态代理。

② CGLIB 动态代理

如果目标类没有实现接口，那么 Spring AOP 会默认选择使用 CGLIB 来动态代理目标类；若目标对象实现了接口，也可以强制使用 CGLIB 实现 AOP（设置 proxy-target-class = true）

CGLIB（Code Generation Library），是一个代码生成的类库，可以在运行时动态的生成某个类的子类，CGLIB 是通过继承的方式做动态代理，因此如果某个类被标记为 final，那么它是无法使用CGLIB做动态代理的。

核心类包括 👇

MethodInterceptor 接口
Enhancer 类

Ⅰ定义类 CGLIBYinyu

定义一个不实现任何接口的类


package com.aopdemo.aCGLIBDynamicProxy;
 
@Component //实例化到spring容器中，相当于配置文件中的 
public class CGLIBYinyu{
 
        public void eat(String food) {
            System.out.println("我正在吃：" + food);
        }
}

Ⅱ 定义Aspect


package com.aopdemo.aCGLIBDynamicProxy;
 
@Aspect
@Component
public class CGLIBAdvice {
 
    //针对 CGLIBYinyu 类下的 eat 方法进行切入
    @Pointcut("execution(* com.aopdemo.aCGLIBDynamicProxy.CGLIBYinyu.eat(..))")
    public void pointcut() {
    }
 
    //接入点的前置操作
    @Before("pointcut()")
    public void before() {
        System.out.println("before");
    }
 
}

Ⅲ 使用测试类进行测试


package com.aopdemo;
 
@SpringBootTest
class AopdemoTests {
 
    @Autowired
    private CGLIBYinyu cglibYinyu;
 
    @Test
    void ajdkDynamicProxyTest() {
        chinese.sayHello("yinyu say：");
        System.out.println(chinese.getClass());
    }
}

Ⅳ 输出结果

此时 application.properties 文件中依然配置 proxy-target-class = false~

可以看到类被 CGLIB 增强了，也就是 CGLIB 动态代理！！说明如果目标对象没有实现接口的话，那么就会默认使用 CGLIB 动态代理。

③ 基于 xml 配置（以 JDK 动态代理为例）

当然，SpringAOP 也是可以基于 xml 实现的，此时 xml 的作用相当于 Advice类文件（定义切面），同时也可将指定类注入 Spring。

注意：以 JDK 动态代理为例，同时我注释了 proxy-target-class 的配置 👇

Ⅰ 定义一个 XmlChinese 接口 :


package com.aopdemo.aaxmlJdkDP;
 
public interface XmlChinese {
    //定义一个 sayHello 的抽象方法
    void sayHello(String name);
}

Ⅱ 定义实现类–XmlYinyu:

XmlYinyu 类实现 XmlChinese 接口，并重写 sayHello 这个抽象方法，同时不用注释做注入操作


package com.aopdemo.aaxmlJdkDP;
 
public class XmlYinyu implements XmlChinese {
 
    @Override
    public void sayHello(String name) {
        System.out.println(name + "hello, AOP");
    }
}

Ⅲ 编写 bean.xml 文件


<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/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
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd">
 
    
    <bean id="xmlYinyu" class="com.aopdemo.aaxmlJdkDP.XmlYinyu"/>
    <bean id="xmlEnpower" class="com.aopdemo.aaxmlJdkDP.XmlEnpower"/>
    
    <aop:config>
        
        <aop:aspect ref="xmlEnpower">
            
            <aop:before method="printbefore"
                        pointcut="execution(public void com.aopdemo.aaxmlJdkDP.XmlYinyu.sayHello(..))"/>
        aop:aspect>
    aop:config>
beans>

Ⅳ 使用测试类进行测试


package com.aopdemo;
 
@SpringBootTest
class AopdemoTests {
 
    @Test
    void xmlJdkDPTest() {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("bean.xml");
        XmlChinese xmlChinese = (XmlChinese) applicationContext.getBean("xmlYinyu");
        xmlChinese.sayHello("yinyu say to xml：");
        System.out.println(xmlChinese.getClass());
    }
}

Ⅴ 输出结果

可以看到类型是 class com.sun.proxy.$Proxy108，显而易见这就是 JDK 的动态代理，因此使用 xml 进行动态代理时，默认 proxy-target-class = false

2 通过 AOP 打印数据访问层摘要（以 mybatis-plus 的 mapper 为例）

2.1 项目初始化

前提是项目已创建，可通过 IDEA Spring Initializr，且已导入web、mysql、lombok等依赖。

① 导入 mybatis-plus 依赖

路径：pom.xml


        
        <dependency>
            <groupId>com.baomidougroupId>
            <artifactId>mybatis-plus-boot-starterartifactId>
            <version>3.5.2version>
        dependency>

② 连接数据库配置

前提是连接的数据库存在与实体类相对应的数据表，数据表初始搭建详解在Spring MVC 实践详解文章的【2/2.1Mysql 数据库初始化】小节

路径：src/main/resources/application.properties


#数据库连接配置
spring.datasource.username=root
spring.datasource.password=root
#mysql5~8 驱动不同driver-class-name     8需要增加时区的配置serverTimezone=UTC，放在url最后
#useSSL=false 安全连接
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

③ 编写实体类

路径：src/main/java/com/aopdemo/pojo/User.java


package com.aopdemo.pojo;
 
@Builder
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
 
    @TableId(type = IdType.AUTO)//新增记录时未命名id时id自增
    private Long id;
 
    private String name;
    private  Integer age;
    private  String email;
}

2.2 AOP 具体代码

① 编写 mapper 接口

路径：src/main/java/com/aopdemo/mapper/UserMapper.java


package com.aopdemo.mapper;
 
//在对应的接口上面继承一个基本的接口 BaseMapper
@Mapper
public interface UserMapper extends BaseMapper {
    //mybatisplus 将所有CRUD操作都编写完成了，不用像以前一样配置一大堆文件
 
}

② 编写 service 实现类

通过 mapper 定义了一些增删改查操作~


package com.aopdemo.service;
 
@Service
public class UserServiceImpl {
 
    @Autowired
    private UserMapper userMapper;
 
    /*
    Mapper CRUD(增删改查)
    */
 
    //增加一个User
    public int addUser_ByMapper(User user){
        return userMapper.insert(user);
    }
 
    //根据id删除一个User
    public int deleteUserById_ByMapper(int id){
        return userMapper.deleteById(id);
    }
 
    //更新User
    public boolean updateUser_ByMapper(User user){
        userMapper.updateById(user);
        return true;
    }
 
    //根据id查询,返回一个User
    public User queryUser_ByMapper(int id){
        return userMapper.selectById(id);
    }
 
    //查询全部User,返回list集合
    public List queryAllUser_ByMapper(){
        return userMapper.selectList(new QueryWrapper<>());//QueryWrapper没有任何条件
    }
}

③ 编写 Aspect 类

针对 mapper 接口进行切入，该接口下的所有抽象方法都将得到增强！

路径：src/main/java/com/aopdemo/aspect/PerformanceAspect.java


package com.aopdemo.aspect;
 
@Aspect
@Component
@Slf4j
public class PerformanceAspect {
    //针对某个接口进行切面注入，ProceedingJoinPoint只是给 @Around 用的
    @Around(value = "execution(* com.baomidou.mybatisplus.core.mapper..*(..))")
    public Object logPerformance(ProceedingJoinPoint pjp) throws Throwable {
        long startTime = System.currentTimeMillis();
        String name = "--";
        String result = "YES";
        try {
            name = pjp.getSignature().toShortString();
            return pjp.proceed();
        } catch (Throwable t) {
            result = "NO";
            throw t;
        } finally {
            long endTime = System.currentTimeMillis();
            log.info("{};{};{}ms", name, result, endTime - startTime);
        }
    }
}

④ 编写测试类

路径：src/test/java/com/aopdemo/AopdemoTests.java


package com.aopdemo;
 
@Slf4j
@SpringBootTest
class AopdemoTests {
 
    @Autowired
    private UserServiceImpl userService;
 
    @Test
    void contextLoads() {
        log.info("All Users: {}", userService.queryAllUser_ByMapper());
        User user =userService.queryUser_ByMapper(1);
        log.info("The User of id = 1 : {}", user);
    }
}

⑤ 输出结果

说明 mapper 接口已被增强成功，按照切面增加的功能输出~

参考文章

通过 AOP 打印数据访问层摘要_L# S@的博客-CSDN博客

5.Spring Aop xml配置代理注解代理_多加香菜_0505的博客-CSDN博客

相关阅读:
计算机视觉领域经典模型汇总（2023.09.08
【设计模式】适配器模式
 用vite搭建一个vue3 + ts项目
 vue项目读取全局配置
 python实战故障诊断之CWRU数据集（五）：线性判别模型及二次判别模型的应用
 文件上传与Phar反序列化的摩擦
 STM32内部flash详解（1）
AI大模型量化格式介绍（GPTQ，GGML，GGUF，FP16/INT8/INT4）
VFP技巧
 学习总结 | 真实记录 MindSpore 两日集训营能带给你什么（一）！
原文地址：https://blog.csdn.net/weixin_51407397/article/details/128088644