Spring-AOP详解

image.png

前言

在日常开发中,会遇到一些对不同的功能进行相同的一些增强效果,可以在原有基础上进行相应的修改,但是会造成大量的代码重复,并且对于三方或者一些其他人写的不能更改的类,无法来实现。这就提出了新的方法AOP来实现。

AOP简介

1. 核心概念

AOP(Aspect Oriented Programming):面向切面编程,一种编程范式,指导开发者如何组织程序结构。

作用:在不惊动原始设计的基础上为其进行功能增强。

Spring理念:无入侵式/无侵入式。

1.1 连接点(JoinPoint)

程序执行过程中的任意位置,粒度为执行方法、抛出异常、设置变量等。

SpringAOP中,理解为方法的执行。

1.2 切入点(Pointcut)

匹配连接点的式子。

SpringAOP中,一个切入点可以只描述一个具体方法,也可以匹配多个方法。

一个具体方法:com.hao.dao包下的BookDao接口中的无形参无返回值的save()方法。
匹配多个方法:所有的save()方法,所有的以get开头的方法,所有以Dao结尾的接口中的任意方法,所有带有一个参数的方法。

1.3 通知(Advice)

在切入点处执行的操作,也就是共性功能。

SpringAOP中,功能最终以方法的形式呈现。

1.4 通知类

定义通知的类。

1.5 切面(Aspect)

描述通知与切入点的对应关系。

快速入门

1. 快速入门

使用注解开发模式模拟测定接口开始执行时间。这里直接在方法运行前打印当前时间即可。

1.1 导入AOP相关坐标

pom.xml中导入如下坐标。

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.9</version>
</dependency>

1.2 制作连接点方法(Dao接口与实现类)

定义一个模拟接口和实现类。

public interface BookDao {
    public void save();
    public void update();
}
@Repository
public class BookDaoImpl implements BookDao {
    @Override
    public void save() {
        System.out.println(System.currentTimeMillis());
        System.out.println("book dao save ...");
    }
    @Override
    public void update() {
        System.out.println("book dao update ...");
    }
}

1.3 制作共性功能(通知类与通知)

使用@Component@Aspect注解。

@Component
@Aspect
public class MyAdvice {
}

1.4 定义切入点

使用@Pointcut注解。

@Component
@Aspect
public class MyAdvice {

    @Pointcut("execution(void com.hao.dao.BookDao.update())")
    private void pt() {}
}

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

1.5 绑定切入点与通知的关系(切面)

由于是测定方法执行前的运行时间,这里使用@Before注解。

@Component
@Aspect
public class MyAdvice {

    @Pointcut("execution(void com.hao.dao.BookDao.update())")
    private void pt() {}

    @Before("pt()")
    public void method() {
        System.out.println(System.currentTimeMillis());
    }
}

将方法pt()加入@Before注解注解中即完成绑定。

1.6 开启Spring对AOP注解驱动支持

Spring配置类中添加@EnableAspectJAutoProxy注解即可。

@Configuration
@ComponentScan({"com.hao.dao", "com.hao.aop"})
@EnableAspectJAutoProxy
public class SpringConfig {
}

1.7 测试

public class App {
    public static void main(String[] args) throws IOException {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
        BookDao bookDao = ctx.getBean(BookDao.class);
        bookDao.update();
    }
}

测试调用BookDaoupdate()方法可以看到在方法内容前依然打印了当前时间毫秒值。

2. AOP工作流程

2.1 Spring容器启动

2.2 读取所有切面配置中的切入点

2.3 初始化bean

判断bean对应的类中的方法是否匹配到任意切入点。
匹配失败,创建对象。
匹配成功,创建原始对象(目标对象)的代理对象。

2.4 获取bean执行方法

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

2.5 涉及概念

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

AOP切入点表达式

1. 语法格式

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

1.1 示例

描述方式一:执行com.hao.dao包下的BookDao接口中的无参数update()方法

@Pointcut("execution(void com.hao.dao.BookDao.update())")

描述方式二:执行com.hao.dao.impl包下的BookDaoImpl类中的无参数update()方法

@Pointcut("execution(void com.hao.dao.impl.BookDaoImpl.update())")

1.2 标准格式

动作关键字(访问修饰符 返回值 包名.类/接口名.方法名(参数)异常名)

@Pointcut("execution(public User com.hao.service.UserService.findById(int))")
  1. 动作关键字:描述切入点的行为动作,例如execution表示执行到指定切入点。
  2. 访问修饰符:publicprivate等,可以省略。
  3. 返回值
  4. 包名
  5. 类/接口名
  6. 方法名
  7. 参数
  8. 异常名:方法定义中抛出指定异常,可以省略。

2. 通配符

可以使用通配符描述切入点,快速描述。

2.1 *

单个独立的任意符号,可以独立出现,也可以作为前缀或者后缀匹配符出现。

例:匹配com.hao包下的任意包中的UserService类或接口中所有find开头的带有一个参数的方法。

@Pointcut("execution(public * com.hao.*.UserService.find* (*))")

2.2 ..

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

例:匹配com包下的任意包中的UserService类或接口中所有名称为findById的方法

@Pointcut("execution(public User com..UserService.findById(..))")

2.3 +

专用于匹配子类类型

@Pointcut("execution(* *..*Service+.* (..))")

3. 书写技巧

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

AOP通知类型

1. 概述

AOP通知描述了抽取的共性功能,根据共性功能抽取的位置不同,最终运行代码时要将其加入到合理的位置。

AOP通知共分为5种类型:

  1. 前置通知
  2. 后置通知
  3. 环绕通知(重点)
  4. 返回后通知(了解)
  5. 抛出异常后通知(了解)

2. 类型详解

2.1 @Before

位置:通知方法定义上方。
作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法前运行。
相关属性:value(默认):切入点方法名,格式为类名.方法名()

例:

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

2.2 @After

位置:通知方法定义上方。
作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法后运行。
相关属性:value(默认):切入点方法名,格式为类名.方法名()

例:

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

2.3 @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;
    }

注意:

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

2.4 @AfterReturning(了解)

位置:通知方法定义上方。
作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法正常执行完毕后运行 。
相关属性:value(默认):切入点方法名,格式为类名.方法名()

例:

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

2.5 @AfterThrowing(了解)

位置:通知方法定义上方。
作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法运行抛出异常后执行 。
相关属性:value(默认):切入点方法名,格式为类名.方法名()

例:

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

AOP通知获取数据

1. AOP通知获取参数数据

1.1 JoinPoint

适用于前置、后置、返回后、抛出异常后通知。

JoinPoint对象描述了连接点方法的运行状态,可以获取到原始方法的调用参数。

@Before("pt()")
public void before(JoinPoint jp) {
    Object[] args = jp.getArgs();
    System.out.println(Arrays.toString(args));
}

1.2 ProceedJointPoint

适用于环绕通知。

ProceedJointPoint是JoinPoint的子类。

@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable {
    Object[] args = pjp.getArgs();
    System.out.println(Arrays.toString(args));
    // 表示对原始操作的调用
    Object ret = pjp.proceed();
    return ret;
}

2. AOP通知获取返回值数据

2.1 返回后通知

返回后通知可以获取切入点方法中的返回值信息,使用形参可以接收对应的返回值对象。

@AfterReturning(value = "pt()", returning = "ret")
public void afterReturning(Object ret) {
    System.out.println("afterReturning advice ..." + ret);
}

2.2 环绕通知

环绕通知中可以手工书写对原始方法的调用,得到的结果即为原始方法的返回值。

@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable {
    Object ret = pjp.proceed();
    return ret;
}

3. AOP通知获取异常数据(了解)

3.1 抛出异常后通知

抛出异常后通知可以获取切入点方法中出现的异常信息,使用形参可以接收对应的异常对象。

@AfterThrowing(value = "pt()", throwing = "t")
public void afterThrowing(Throwable t) {
    System.out.println("afterThrowing advice ..." + t);
}

3.2 环绕通知

环绕通知中可以手工书写对原始方法的调用,使用try-catch可以获取对应的异常。

@Around("pt()")
public Object around(ProceedingJoinPoint pjp) {
    Object ret = null;
    try {
        ret = pjp.proceed();
    } catch (Throwable e) {
        e.printStackTrace();
    }
    return ret;
}

总结

以上就是关于SpringAOP的全部内容。
通过上边的内容可以知道环绕型通知属于重点,在开发中会经常用到。

如果有什么问题,我们可以一起交流讨论解决。

最后,希望可以帮助到有需要的码友。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容