Spring AOP -- Spring入门（五）

---

前言

为了巩固所学的知识，作者尝试着开始发布一些学习笔记类的博客，方便日后回顾。当然，如果能帮到一些萌新进行新技术的学习那也是极好的。作者菜菜一枚，文章中如果有记录错误，欢迎读者朋友们批评指正。
（博客的参考源码可以在我主页的资源里找到，如果在学习的过程中有什么疑问欢迎大家在评论区向我提出）

---

发现宝藏

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。【宝藏入口】。

一、AOP概念

1. 认识AOP

• AOP(Aspect oriented Programming)面向切面编程，一种编程范式，指导开发者如何组织程序结构
• 00P(Object oriented Programming)面向对象编程
• 作用:在不惊动原始设计的基础上为其进行功能增强
• Spring理念:无入侵式/无侵入式

2. Aop术语

在我们开始使用 AOP 工作之前，让我们熟悉一下 AOP 概念和术语。这些术语并不特定于 Spring，而是与 AOP 有关的。

3. 通知类型

Spring 方面可以使用下面提到的五种通知工作：

二、AOP入门案例

1. 入门案例思路分析

（详细代码可在我个人主页的spring源码中的respr_Aop_quicklystart）

• 案例设定:测定接口执行效率
• 简化设定:在接口执行前输出当前系统时间
• 开发模式:XML or 注解
• 思路分析

1.导入坐标( pom.xml)
2. 制作连接点方法(原始操作，Dao接口与实现类
3. 制作共性功能( 通知类与通知 )
4. 定义切入点
5. 绑定切入点与通知关系 (切面

2. 导入坐标

<dependency>
  <groupId>org.aspectj</groupId>
  <artifactId>aspectjweaver</artifactId>
  <version>1.9.4</version>
</dependency>
1
2
3
4
5

说明: spring-context坐标依赖spring-aop坐标

3. 定义接口与实现类

public interface BookDao {
    public void save();
    public void update();
}
1
2
3
4

@Repositorypublic 
class BookDaoImpl implements BookDao {
   public void save(){
       System.out.println(System.currentTimeMillis());
       System.out.println("book dao save ...");
   }
   
   public void update(){
       System.out.println("book dao update ...");
   }
}
1
2
3
4
5
6
7
8
9
10
11

4. 定义通知类，编写通知

public class MyAdvice {
    public void before(){
        System.out.println(System.currentTimeMillis());
    }
}
1
2
3
4
5

5. 定义切入点

public class MyAdvice {
     @Pointcut("execution(void com.itheima.dao.BookDao.update())")
     private void pt(){}
1
2
3

说明:切入点定义依托一个不具有实际意义的方法进行，即无参数，无返回值，方法体无实际逻辑

6. 绑定切入点与通知的关系，并指定通知添加到原始连接到的具体执行位置

public class MyAdvice
    @Pointcut("execution(void com.itheima.dao.BookDao.update())")
    private void pt(){}
    @Before( "pt()")
    public void before(){
        System.out.println(System.currentTimeMillis());
    }
}
1
2
3
4
5
6
7
8

7. 定义通知类受spring容器管理(@Component)，并定义当前类为切面类(@Aspect)

@Component
@Aspect
public class MyAdvice {
    @pointcut("execution(void com.itheima.dao.BookDao.update())")
    private void pt(){}
    
    @Before("pt()")
    public void before(){
        System.out.println(System.currentTimeMillis());
    }
}
1
2
3
4
5
6
7
8
9
10
11

8. 开启Spring对AOP注解驱动支持(@EnableAspectJAutoProxy)

@Configuration
@ComponentScan("com.itheima")
@EnableAspectJAutoProxypublic class SpringConfig {
}
1
2
3
4

三、AOP工作流程

1. AOP工作流程

(Spring AOP 本质 ：代理模式)

1. Spring容器启动
2. 读取所有切面配置中的切入点
3. 初始化bean，判定bean对应的类中的方法是否匹配到任意切入点

1. 匹配失败，创建对象
2. 匹配成功，创建原始对象( 目标对象 )的代理对象

4. 获取bean执行方法

1. 获取bean，调用方法并执行，完成操作
2. 获取的bean是代理对象时，根据代理对象的运行模式运行原始方法与增强的内容，完成操作

2. AOP核心概念

• 目标对象( Target ): 原始功能去掉共性功能对应的类产生的对象，这种对象是无法直接完成最终工作的
• 代理( Proxy ):目标对象无法直接完成工作，需要对其进行功能回填，通过原始对象的代理对象实现

四、AOP切入点表达式

1. 常见书写格式

1. 切入点:要进行增强的方法
2. 切入点表达式:要进行增强的方法的描述方式

package com.itheima.dao;
public interface BookDao {
    public void update();
}
1
2
3
4

public class BookDaoImpl implements BookDao {
    public void update(){
        System.out.println("book dao update ...");
    }
}
1
2
3
4
5

1. 描述方式一: 执行com.itheima.dao包下的BookDao接口中的无参数update方法 ---- execution(void com.itheima.dao.BookDao.update())
2. 描述方式二:执行com.itheima.dao.impl包下的BookDaoImpl类中的无参数update方法 ---- execution(void com.itheima.dao.impl.BookDaoImpl.update())

2. 标准格式

1. 切入点表达式标准格式:动作关键字( 访问修饰符 返回值包名类/接名方法名(参数)异常名)

execution (public User com.itheima.service.UserService.findById (int))

• 动作关键字: 描述切入点的行为动作，例如execution表示执行到指定切入点
• 访问修饰符 : public，private等，可以省略
• 返回值
• 包名
• 类/接口名
• 方法名
• 参数
• 异常名:方法定义中抛出指定异常，可以省略

2. 可以使用通配符描述切入点，快速描述

• *：单个独立的任意符号，可以独立出现，也可以作为前缀或者后缀的匹配符出现

execution (public * com.itheima..UserService.find (*) )
匹配com.itheima包下的任意包中的UserService类或接口中所有find开头的带有一个参数的方法

• … ：多个连续的任意符号，可以独立出现，常用于简化包名与参数的书写

execution (public User com…UserService.findById (…)匹配com包下的任意包中的UserService类或接口中所有名称为findByld的方法

• +：专用于匹配子类类型

execution(* *…Service+.(…))

3. 表达式书写技巧

1. 所有代码按照标准规范开发，否则以下技巧全部失效
2. 描述切入点通常描述接口，而不描述实现类
3. 访问控制修饰符针对接口开发均采用public描述( 可省略访问控制修饰符描述)
4. 返回值类型对于增删改类使用精准类型加速匹配，对于查询类使用*通配快速描述
5. 包名书写尽量不使用…匹配，效率过低，常用做单个包描述匹配，或精准匹配
6. 接口名/类名书写名称与模块相关的采用*匹配，例如UserService书写成*Service，绑定业务层接口名
7. 方法名书写以动词进行精准匹配加粗样式，名词采用匹配，例如getByld书写成getBy,selectAll书写成selectAll
8. 参数规则较为复杂，根据业务方法灵活调整
9. 通常不使用异常作为匹配规则

五、AOP通知类型

（代码见respr_aop_advice_type）

1. 示例代码

@Component
@Aspect
public class MyAdvice {
    @Pointcut("execution(void com.itheima.dao.BookDao.update())")
    private void pt(){}
    @Pointcut("execution(int com.itheima.dao.BookDao.select())")
    private void pt2(){}

    //@Before：前置通知，在原始方法运行之前执行
//    @Before("pt()")
    public void before() {
        System.out.println("before advice ...");
    }

    //@After：后置通知，在原始方法运行之后执行
//    @After("pt2()")
    public void after() {
        System.out.println("after advice ...");
    }

    //@Around：环绕通知，在原始方法运行的前后执行
//    @Around("pt()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("around before advice ...");
        //表示对原始操作的调用
        Object ret = pjp.proceed();
        System.out.println("around after advice ...");
        return ret;
    }

//    @Around("pt2()")
    public Object aroundSelect(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("around before advice ...");
        //表示对原始操作的调用
        Integer ret = (Integer) pjp.proceed();
        System.out.println("around after advice ...");
        return ret;
    }

    //@AfterReturning：返回后通知，在原始方法执行完毕后运行，且原始方法执行过程中未出现异常现象
//    @AfterReturning("pt2()")
    public void afterReturning() {
        System.out.println("afterReturning advice ...");
    }

    //@AfterThrowing：抛出异常后通知，在原始方法执行过程中出现异常后运行
    @AfterThrowing("pt2()")
    public void afterThrowing() {
        System.out.println("afterThrowing advice ...");
    }
}

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

2. 前置通知

（在一个方法执行之前，执行通知）

1. @Before称
2. 类型: 方法注解
3. 位置: 通知方法定义上方
4. 作用:设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前运行
5. 相关属性: value(默认) : 切入点方法名,格式为类名.方法名()
6. 范例 :

@Before("pt()")
public void before() {
    System.out.println("before advice ...");
}
1
2
3
4

3. 后置通知

（在一个方法执行之后，不考虑其结果，执行通知）

1. 名称: @After
2. 类型: 方法注解
3. 位置:通知方法定义上方
4. 作用:设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法后运行
5. 相关属性 : value( 默认 ) :切入点方法名，格式为类名.方法名()
6. 范例:

@After("pt()")
public void after() {
    System.out.println("after advice ...");
}
1
2
3
4

4. 环绕通知

（在建议方法调用之前和之后，执行通知）

• 内容

1. 名称：@Around (重点，常用 )
2. 类型：方法注解
3. 位置：通知方法定义上方
4. 作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前后运行
5. 范例：

@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable {
    System.out.println("around before advice ...");
    Object ret = pjp.proceed();
    System.out.println("around after advice ...");
    return ret;
}
1
2
3
4
5
6
7

• 注意事项

（原始操作的调用 ：方法调用的位置）

1. 环绕通知必须依赖形参ProceedinjoinPoint才能实现对原始方法的调用，进而实现原始方法调用前后同时添加通知
2. 通知中如果未使用ProceedingJoinPoint对原始方法进行调用将跳过原始方法的执行
3. 对原始方法的调用可以不接收返回值，通知方法设置成void即可，如果接收返回值，必须设定为Obiect类型
4. 原始方法的返回值如果是void类型，通知方法的返回值类型可以设置成void，也可以设置成Obiect
5. 由于无法预知原始方法运行后是否会抛出异常，因此环绕通知方法必须抛出Throwable对象

• 获取签名

5. 返回后通知

（在一个方法执行之后，只有在方法成功完成时，才能执行通知）

1. 名称：@AfterReturning ( 了解 )
2. 类型：方法注解
3. 位置：通知方法定义上方
4. 作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法正常执行完毕后运行
5. 相关属性 : value( 默认 ) :切入点方法名，格式为类名方法名（）
6. 范例：

@AfterReturning("pt()")
public void afterReturning() {
    System.out.println("afterReturning advice ...");
}
1
2
3
4

6. 抛异常通知

（在一个方法执行之后，只有在方法退出抛出异常时，才能执行通知）

1. 名称 : @AfterThrowing ( 了解)
2. 类型：方法注解
3. 位置：通知方法定义上方
4. 作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法运行抛出异常后执行
5. 相关属性 : value( 默认 ) : 切入点方法名，格式为类名.方法名()
6. 范例

@AfterThrowing("pt()")
public void afterThrowing() {
    System.out.println("afterThrowing advice ...");
}
1
2
3
4

六、AOP通知获取数据

1. 获取数据的类型

1. 获取切入点方法的参数

• JoinPoint : 适用于前置、后置、返回后、抛出异常后通知
• ProceedJointPoint : 适用于环绕通知

2. 获取切入点方法返回值

• 返回后通知
• 环绕通知

3. 获取切入点方法运行异常信息

• 抛出异常后通知
• 环绕通知

2. 获取参数

3. 获取返回值

4. 获取异常

七、AOP案例-百度网盘密码数据兼容处理

1. 需求分析

(在验证提取码访问链接之前，对复制的提取码后面多余的空格进行预处理)

2. 基础代码简介

（具体代码见respr_case_handle_password模块）

• ResuorcesService接口：

模拟接收地址和提取码，打开一个资源

public interface ResourcesService {
    public boolean openURL(String url ,String password);
}

1
2
3
4

• ResourcesServiceImpl实现类

实现接口，返回数据层相关处理函数的结果return resourcesDao.readResources(url,password)

@Service
public class ResourcesServiceImpl implements ResourcesService {
    @Autowired
    private ResourcesDao resourcesDao;

    public boolean openURL(String url, String password) {
        return resourcesDao.readResources(url,password);
    }
}

1
2
3
4
5
6
7
8
9
10

• ResourcesDao数据层接口，接收地址和验证码参数

public interface ResourcesDao {

    boolean readResources(String url, String password);
}
1
2
3
4

• ResourcesDaoImpl实现类，对提取码进行模拟验证

@Repository
public class ResourcesDaoImpl implements ResourcesDao {
    public boolean readResources(String url, String password) {
        //打印输出预处理完后提取码的长度
        System.out.println(password.length());
        //模拟校验
        return password.equals("root");
    }
}
1
2
3
4
5
6
7
8
9

• 模拟测试类App进行测试，提取码验证通过输出打印true，否则输出打印false。由于传入的验证码“root ”带有空格，所以需要通过AOP编程思想对传入的参数进行预处理。

public class App {
    public static void main(String[] args) {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
        ResourcesService resourcesService = ctx.getBean(ResourcesService.class);
        boolean flag = resourcesService.openURL("http://pan.baidu.com/haha", "root ");
        System.out.println(flag);
    }
}
1
2
3
4
5
6
7
8

3. 在aop包下创建并编写通知类DataAdvice

@Component
@Aspect
public class DataAdvice {
    @Pointcut("execution(boolean com.itheima.service.*Service.*(*,*))")
    private void servicePt(){}

    @Around("DataAdvice.servicePt()")
    public Object trimStr(ProceedingJoinPoint pjp) throws Throwable {
        Object[] args = pjp.getArgs();
        for (int i = 0; i < args.length; i++) {
            //判断参数是不是字符串
            if(args[i].getClass().equals(String.class)){
                args[i] = args[i].toString().trim();
            }
        }
        Object ret = pjp.proceed(args);
        return ret;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

4. 在congfig包下的springConfig配置类中开启AOP注解支持

@Configuration
@ComponentScan("com.itheima")
@EnableAspectJAutoProxy
public class SpringConfig {
}

1
2
3
4
5
6

5. 模拟测试类的运行结果

总结

欢迎各位留言交流以及批评指正，如果文章对您有帮助或者觉得作者写的还不错可以点一下关注,点赞，收藏支持一下。
（博客的参考源码可以在我主页的资源里找到，如果在学习的过程中有什么疑问欢迎大家在评论区向我提出）