《Spring注解驱动开发》第31章：现场搭建一个AOP测试环境

写在前面

今天是9月1号，金九银十的跳槽黄金期已拉开序幕，相信很多小伙伴也在摩拳擦掌，想换一个新的工作环境。然而，由于今年疫情的影响，很多企业对于招聘的要求是越来越严格。之前，很多不被问及的知识点，最近面试时都会被问到了。这不，有些面试官竟然让面试者现场搭建一个AOP测试环境。那怎么办呢？那就给他搭建一个呗！

关注 冰河技术 微信公众号，后台回复 “Spring注解” 领取源码。

什么是AOP？

AOP （Aspect Orient Programming）,直译过来就是 面向切面编程。AOP 是一种编程思想，是面向对象编程（OOP）的一种补充。面向对象编程将程序抽象成各个层次的对象，而面向切面编程是将程序抽象成各个切面。

比如，在《Spring实战（第4版）》中有如下一张图描述了AOP的大体模型。 在这里插入图片描述

从这张图中，我们可以看出：所谓切面，相当于应用对象间的横切点，我们可以将其单独抽象为单独的模块。

总之一句话：AOP是指在程序的运行期间动态的将某段代码切入到指定方法、指定位置进行运行的编程方式。AOP的底层是使用动态代理实现的。

搭建环境

1.导入AOP依赖

要想搭建AOP环境，首先，我们就需要在项目的pom.xml文件中引入AOP的依赖，如下所示。

<properties>
    <spring.version>5.2.6.RELEASE</spring.version>
</properties>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aspects</artifactId>
    <version>${spring.version}</version>
</dependency>

2.定义目标类

在io.mykit.spring.plugins.register.aop包下创建一个MathHandler类，用于处理数学计算上的一些逻辑。比如，我们在MathHandler类中定义了一个加法操作，返回两个整数类型值的和，如下所示。

package io.mykit.spring.plugins.register.aop;
/**
 * @author binghe
 * @version 1.0.0
 * @description 定义一个数据处理器类，用于测试AOP
 */
public class MathHandler {

    public int add(int i, int j){
        System.out.println("目标方法执行");
        return i + j;
    }
}

3.定义切面类

在io.mykit.spring.plugins.register.aspect包下创建一个LogAspect切面类，在LogAspect类中定义了几个打印日志的方法，以这些方法来感知MathHandler类中的add()方法的运行情况。如果需要切面类来感知目标类方法的运行情况，则需要使用Spring AOP中的通知方法。

AOP中的通知方法及其注解与含义如下：

  • 前置通知（@Before）：在目标方法运行之前运行。
  • 后置通知（@After）：在目标方法运行结束之后运行，不管是正常结束还是异常结束都会执行。
  • 返回通知（@AfterReturning）：在目标方法正常返回之后运行。
  • 异常通知（@AfterThrowing）：在目标方法抛出异常后运行。
  • 环绕通知（@Around）：动态代理，手动推进目标方法运行。

综上，LogAspect类中的具体方法定义如下所示。

package io.mykit.spring.plugins.register.aspect;
import org.aspectj.lang.annotation.*;
/**
 * @author binghe
 * @version 1.0.0
 * @description 打印日志的切面类
 */
@Aspect
public class LogAspect {

    @Pointcut("execution(public int io.mykit.spring.plugins.register.aop.MathHandler.*(..))")
    public void pointCut(){

    }

    @Before("pointCut()")
    public void logStart(){
        System.out.println("加法运行开始，参数列表是：{}");
    }

    @After("pointCut()")
    public void logEnd(){
        System.out.println("加法运行结束");
    }

    @AfterReturning("pointCut()")
    public void logReturn(){
        System.out.println("加法正常返回，运行结果：{}");
    }

    @AfterThrowing("pointCut()")
    public void logException(){
        System.out.println("加法异常，异常信息：{}");
    }
}
  • logStart()方法：MathHandler类的add()方法运行之前运行。
  • logEnd()方法：MathHandler类的add()方法运行结束之后运行。
  • logReturn()方法：MathHandler类的add()方法正常返回之后运行。
  • logException()方法：MathHandler类的add()方法抛出异常后执行。

4.将目标类和切面类加入到IOC容器

在io.mykit.spring.plugins.register.config包中，新建AopConfig类，并使用@Configuration注解标注这是一个Spring的配置类，同时使用@EnableAspectJAutoProxy注解开启基于注解的AOP模式。在AopConfig类中，使用@Bean注解将MathHandler类和LogAspect类加入到IOC容器中，如下所示。

package io.mykit.spring.plugins.register.config;
import io.mykit.spring.plugins.register.aop.MathHandler;
import io.mykit.spring.plugins.register.aspect.LogAspect;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试AOP
 */
@Configuration
@EnableAspectJAutoProxy
public class AopConfig {
    
    @Bean
    public MathHandler mathHandler(){
        return new MathHandler();
    }

    @Bean
    public LogAspect logAspect(){
        return new LogAspect();
    }
}

5.创建测试类

在 io.mykit.spring.test包中创建AopTest测试类，并在AopTest类中创建testAop01()方法，如下所示。

package io.mykit.spring.test;
import io.mykit.spring.plugins.register.aop.MathHandler;
import io.mykit.spring.plugins.register.config.AopConfig;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试切面
 */
public class AopTest {

    @Test
    public void testAop01(){
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AopConfig.class);
        MathHandler mathHandler = context.getBean(MathHandler.class);
        mathHandler.add(1, 2);
        context.close();
    }
}

运行AopTest类中的testAop01()方法，输出的结果信息如下所示。

加法运行开始，参数列表是：{}
目标方法执行
加法运行结束
加法正常返回，运行结果：{}

可以看到，执行了切面类中的方法，并打印出了相关信息。但是没有打印参数列表和运行结果。

6.在切面类中打印参数列表和返回结果

那如果需要打印出参数列表和运行结果，该怎么办呢？别急，我们继续往下看。

要想打印出参数列表和运行结果，就需要对LogAspect类中的方法进行优化，优化后的结果如下所示。

package io.mykit.spring.plugins.register.aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import java.util.Arrays;
/**
 * @author binghe
 * @version 1.0.0
 * @description 打印日志的切面类
 */
@Aspect
public class LogAspect {

    @Pointcut("execution(public int io.mykit.spring.plugins.register.aop.MathHandler.*(..))")
    public void pointCut(){

    }

    @Before("pointCut()")
    public void logStart(JoinPoint joinPoint){
        System.out.println(joinPoint.getSignature().getName() + " 运行开始，参数列表是：{"+ Arrays.asList(joinPoint.getArgs()) +"}");
    }

    @After("pointCut()")
    public void logEnd(JoinPoint joinPoint){
        System.out.println(joinPoint.getSignature().getName() + " 运行结束");
    }

    @AfterReturning(value = "pointCut()", returning = "result")
    public void logReturn(JoinPoint joinPoint, Object result){
        System.out.println(joinPoint.getSignature().getName() + " 正常返回，运行结果：{"+result+"}");
    }

    @AfterThrowing(value = "pointCut()", throwing = "exception")
    public void logException(JoinPoint joinPoint, Exception exception){
        System.out.println(joinPoint.getSignature().getName() + " 异常，异常信息：{"+exception+"}");
    }
}

这里，需要注意的是：JoinPoint参数一定要放在参数的第一位。

此时，我们再次运行AopTest类中的testAop01()方法，输出的结果信息如下所示。

add 运行开始，参数列表是：{[1, 2]}
目标方法执行
add 运行结束
add 正常返回，运行结果：{3}

7.目标方法抛出异常

我们在MathHandler类的add()方法中抛出一个异常，来测试下异常情况，如下所示。

package io.mykit.spring.plugins.register.aop;

/**
 * @author binghe
 * @version 1.0.0
 * @description 定义一个数据处理器类，用于测试AOP
 */
public class MathHandler {

    public int add(int i, int j){
        System.out.println("目标方法执行");
        throw new RuntimeException();
       //return i + j;
    }
}

此时，我们再次运行AopTest类中的testAop01()方法，输出的结果信息如下所示。

add 运行开始，参数列表是：{[1, 2]}
目标方法执行
add 运行结束
add 异常，异常信息：{java.lang.RuntimeException}

可以看到，正确的输出了切面中打印的信息。

至此，我们的AOP测试环境就搭建成功了。

重磅福利

关注「 冰河技术 」微信公众号，后台回复 “设计模式” 关键字领取《深入浅出Java 23种设计模式》PDF文档。回复“Java8”关键字领取《Java8新特性教程》PDF文档。回复“限流”关键字获取《亿级流量下的分布式限流解决方案》PDF文档，三本PDF均是由冰河原创并整理的超硬核教程，面试必备！！

<font color="#FF0000">好了，今天就聊到这儿吧！别忘了点个赞，给个在看和转发，让更多的人看到，一起学习，一起进步！！</font>

星球服务

加入星球，你将获得：

1.项目学习：微服务入门必备的SpringCloud Alibaba实战项目、手写RPC项目—所有大厂都需要的项目【含上百个经典面试题】、深度解析Spring6核心技术—只要学习Java就必须深度掌握的框架【含数十个经典思考题】、Seckill秒杀系统项目—进大厂必备高并发、高性能和高可用技能。

2.框架源码：手写RPC项目—所有大厂都需要的项目【含上百个经典面试题】、深度解析Spring6核心技术—只要学习Java就必须深度掌握的框架【含数十个经典思考题】。

3.硬核技术：深入理解高并发系列（全册）、深入理解JVM系列（全册）、深入浅出Java设计模式（全册）、MySQL核心知识（全册）。

4.技术小册：深入理解高并发编程（第1版）、深入理解高并发编程（第2版）、从零开始手写RPC框架、SpringCloud Alibaba实战、冰河的渗透实战笔记、MySQL核心知识手册、Spring IOC核心技术、Nginx核心技术、面经手册等。

5.技术与就业指导：提供相关就业辅导和未来发展指引，冰河从初级程序员不断沉淀，成长，突破，一路成长为互联网资深技术专家，相信我的经历和经验对你有所帮助。

冰河的知识星球是一个简单、干净、纯粹交流技术的星球，不吹水，目前加入享5折优惠，价值远超门票。加入星球的用户，记得添加冰河微信：hacker_binghe，冰河拉你进星球专属VIP交流群。

星球重磅福利

跟冰河一起从根本上提升自己的技术能力，架构思维和设计思路，以及突破自身职场瓶颈，冰河特推出重大优惠活动，扫码领券进行星球，直接立减149元，相当于5折， 这已经是星球最大优惠力度！


领券加入星球，跟冰河一起学习《SpringCloud Alibaba实战》、《手撸RPC专栏》和《Spring6核心技术》，更有已经上新的《大规模分布式Seckill秒杀系统》，从零开始介绍原理、设计架构、手撸代码。后续更有硬核中间件项目和业务项目，而这些都是你升职加薪必备的基础技能。

100多元就能学这么多硬核技术、中间件项目和大厂秒杀系统，如果是我，我会买他个终身会员！

其他方式加入星球

  • 链接 ：打开链接 http://m6z.cn/6aeFbs 加入星球。
  • 回复 ：在公众号 冰河技术 回复 星球 领取优惠券加入星球。

特别提醒： 苹果用户进圈或续费，请加微信 hacker_binghe 扫二维码，或者去公众号 冰河技术 回复 星球 扫二维码加入星球。

星球规划

后续冰河还会在星球更新大规模中间件项目和深度剖析核心技术的专栏，目前已经规划的专栏如下所示。

中间件项目

  • 《大规模分布式定时调度中间件项目实战（非Demo）》：全程手撸代码。
  • 《大规模分布式IM（即时通讯）项目实战（非Demo）》：全程手撸代码。
  • 《大规模分布式网关项目实战（非Demo）》：全程手撸代码。
  • 《手写Redis》：全程手撸代码。
  • 《手写JVM》全程手撸代码。

超硬核项目

  • 《从零落地秒杀系统项目》：全程手撸代码，在阿里云实现压测（已上新）。
  • 《大规模电商系统商品详情页项目》：全程手撸代码，在阿里云实现压测。
  • 其他待规划的实战项目，小伙伴们也可以提一些自己想学的，想一起手撸的实战项目。。。

既然星球规划了这么多内容，那么肯定就会有小伙伴们提出疑问：这么多内容，能更新完吗？我的回答就是：一个个攻破呗，咱这星球干就干真实中间件项目，剖析硬核技术和项目，不做Demo。初衷就是能够让小伙伴们学到真正的核心技术，不再只是简单的做CRUD开发。所以，每个专栏都会是硬核内容，像《SpringCloud Alibaba实战》、《手撸RPC专栏》和《Spring6核心技术》就是很好的示例。后续的专栏只会比这些更加硬核，杜绝Demo开发。

小伙伴们跟着冰河认真学习，多动手，多思考，多分析，多总结，有问题及时在星球提问，相信在技术层面，都会有所提高。将学到的知识和技术及时运用到实际的工作当中，学以致用。星球中不少小伙伴都成为了公司的核心技术骨干，实现了升职加薪的目标。

联系冰河

加群交流

本群的宗旨是给大家提供一个良好的技术学习交流平台，所以杜绝一切广告！由于微信群人满 100 之后无法加入，请扫描下方二维码先添加作者 “冰河” 微信(hacker_binghe)，备注：星球编号。

冰河微信

公众号

分享各种编程语言、开发技术、分布式与微服务架构、分布式数据库、分布式事务、云原生、大数据与云计算技术和渗透技术。另外，还会分享各种面试题和面试技巧。内容在 冰河技术 微信公众号首发，强烈建议大家关注。

公众号：冰河技术

视频号

定期分享各种编程语言、开发技术、分布式与微服务架构、分布式数据库、分布式事务、云原生、大数据与云计算技术和渗透技术。另外，还会分享各种面试题和面试技巧。

视频号：冰河技术

星球

加入星球 冰河技术，可以获得本站点所有学习内容的指导与帮助。如果你遇到不能独立解决的问题，也可以添加冰河的微信：hacker_binghe， 我们一起沟通交流。另外，在星球中不只能学到实用的硬核技术，还能学习实战项目！

关注 冰河技术公众号，回复 星球 可以获取入场优惠券。

知识星球：冰河技术