SpringAOP学习·第二站
起始站:【Spring】AOP入门(一)
本文已收录至专栏:Spring家族学习之旅
希望您能有所收获
在上一篇的案例中我们发现切面表达式负责描述我们需要增强的方法有着重要的作用,接下来便让我们来认识并学习一下切入点表达式~
首先我们先要明确两个概念:
切入点
:要进行增强的方法切入点表达式
:描述切入点方法的一种表达式切入点表达式有众多书写形式,我们学习如下两种常见的形式~
对于切入点方法签名的描述,我们其实也是有两种方式的,先来看下前面的例子
描述方式一:执行com.guanzhi.dao包下的BookDao接口中的无参数update方法
execution(void com.guanzhi.dao.BookDao.update())
描述方式二:执行com.guanzhi.dao.impl包下的BookDaoImpl类中的无参数update方法
execution(void com.guanzhi.dao.impl.BookDaoImpl.update())
因为调用接口方法的时候最终运行的还是其实现类的方法,所以上面两种描述方式都是可以的,但是为了减少耦合,我们通常都是描述接口类。
由此我们可发现切入点表达式为方法的具体描述,其语法为:
动作关键字(访问修饰符 返回值 包名.类/接口名.方法名(参数) throw 异常名)
对于这个格式,我们不需要硬记,通过一个例子,理解它:
execution(public User com.guanzhi.service.UserService.findById(int))
execution
:动作关键字,描述切入点的行为动作,例如execution表示执行到指定切入点public
:访问修饰符,还可以是public,private等,public可以省略User
:返回值,写返回值类型com.guanzhi.service
:包名,多级包使用点连接UserService
:类/接口名称findById
:方法名int
:参数,直接写参数的类型,多个类型用逗号隔开异常名
:注意是方法声明上抛出的指定异常,不是实际运行时抛出的异常!!!可以省略概述:执行com.guanzhi.service包下的UserService接口中的参数类型为int返回值为User的findById方法。也就是说我们要能通过给定的描述找到对应的方法~
我们除了可以通过描述具体的方法来编写切入点表达式外,还可以通过匹配标识有特定注解的方法的形式来描述切入点。这通常可用于自定义注解进行方法的权限管理。
语法:@annotation(注解的全类名)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Admin {
}
@Admin
public void update(){
System.out.println("book dao update ...");
}
// 描述我们使用的注解
@Pointcut("@annotation(com.guanzhi.annotation.Admin)")
private void admin() {
}
// 绑定
@Before("admin()")
public void control() {
System.out.println("管理员权限操作");
}
我们发现上述都是将切入点表达式写在一个空方法上,再进行使用,其实这样做是为了更好的维护与复用切入点表达式。但在我们平时使用时,如果用法极其简单,我们也可以选择不写空方法而是直接写在通知上。
// 通过特定标签进行匹配
@Before("@annotation(com.guanzhi.annotation.Admin)")
public void control() {
System.out.println("管理员权限操作");
}
// 通过方法签名进行匹配
@Before("execution(void com.guanzhi.dao.BookDao.update())")
public void method() {
System.out.println(System.currentTimeMillis());
}
总结一下:切入点表达式就是要找到需要增强的方法,所以它就是对一个具体方法的描述,但是在我们的项目中定义的方法通常会有很多,如果每一个方法对应写一个切入点表达式,想想这块就会觉得将来编写起来会比较麻烦,有没有更简单的方式呢?
这时就需要用到下面所学习的通配符。
当我们的方法有很多时,我们可以使用通配符描述切入点,主要的目的就是简化大量切入点表达式的书写,例如:
*
:单个独立的任意符号,可以独立出现,也可以作为前缀或者后缀的匹配符出现
execution(public * com.guanzhi.*.UserService.find*(*))
匹配com.guanzhi包下的任意包中的UserService类中所有find开头的带有一个参数的任意返回值的方法
..
:多个连续的任意符号,可以独立出现,常用于简化包名与参数的书写
execution(public User com..UserService.findById(..))
匹配com包下的任意包中的UserService类中所有名称为findById返回值为User的方法
+
:专用于匹配子类类型
execution(* *..*Service+.*(..))
这个使用率较低,描述子类的,咱们做JavaEE开发,继承机会就一次,使用都很慎重,所以很少用它。*Service+,表示所有以Service结尾的接口的子类。
execution(void com.guanzhi.dao.BookDao.update())
√ 匹配接口,能匹配到
execution(void com.guanzhi.dao.impl.BookDaoImpl.update())
√ 匹配实现类,能匹配到
execution(* com.guanzhi.dao.impl.BookDaoImpl.update())
√ 返回值任意,能匹配到
execution(* com.guanzhi.dao.impl.BookDaoImpl.update(*))
× 返回值任意,但是update方法必须要有一个参数,无法匹配,要想匹配需要在update接口和实现类添加参数
execution(void com.*.*.*.*.update())
√ 返回值为void,com包下的任意包三层包下的任意类的update方法,匹配到的是实现类,能匹配
execution(void com.*.*.*.update())
√ 返回值为void,com包下的任意两层包下的任意类的update方法,匹配到的是接口,能匹配
execution(void *..update())
√ 返回值为void,方法名是update的任意包下的任意类,能匹配
execution(* *..*(..))
√ 匹配项目中任意类的任意方法,能匹配,但是不建议使用这种方式,影响范围广
execution(* *..u*(..))
√ 匹配项目中任意包任意类下只要以u开头的方法,update方法能满足,能匹配
execution(* *..*e(..))
√ 匹配项目中任意包任意类下只要以e结尾的方法,update和save方法能满足,能匹配
execution(void com..*())
√ 返回值为void,com包下的任意包任意类任意方法,能匹配,*代表的是方法
execution(* com.guanzhi.*.*Service.find*(..))
√ 将项目中所有业务层方法的以find开头的方法匹配
execution(* com.guanzhi.*.*Service.save*(..))
√ 将项目中所有业务层方法的以save开头的方法匹配
后面两种更符合我们平常切入点表达式的编写规则
对于切入点表达式的编写其实是很灵活的,如果所有代码按照标准规范开发命名,我们将获得非常愉快的体验,否则以下技巧全部失效:
描述切入点通常描述接口,而不描述实现类,如果描述到实现类,就出现紧耦合了
访问控制修饰符针对接口开发均采用public描述(可省略访问控制修饰符描述)
返回值类型对于增删改类使用精准类型加速匹配,对于查询类使用*
通配快速描述
包名书写尽量不使用..
匹配,效率过低,常用*做单个包描述匹配,或精准匹配
接口名/类名书写名称与模块相关的采用*匹配,例如UserService书写成*Service
,绑定业务层接口名
方法名书写以动词进行精准匹配,名词采用*
匹配,例如getById书写成getBy*,selectAll书写成selectAll
参数规则较为复杂,根据业务方法灵活调整
通常不使用异常作为匹配规则
前面的案例中,有涉及到如下内容:
它所代表的含义是将通知
添加到切入点
方法执行的前面。Spring不可能就提供这么一个功能单一的注解给我们吧?当然,他给我们提供了五种不同类型足以供我们以对几乎所有情况。
我们先来回顾下AOP通知:
根据通知具体要添加到切入点哪个位置,Spring给我们提供了5种通知类型:
前置通知
,追加功能到方法执行前,类似于在代码1或者代码2添加内容后置通知
,追加功能到方法执行后,不管方法执行的过程中有没有抛出异常都会执行,类似于在代码5添加内容返回后通知
,追加功能到方法执行后,只有方法正常执行结束后才进行,类似于在代码3添加内容,如果方法执行抛出异常,返回后通知将不会被添加抛出异常后通知
,追加功能到方法抛出异常后,只有方法执行出异常才进行,类似于在代码4添加内容,只有方法抛出异常后才会被添加环绕通知
,环绕通知功能比较强大,它可以追加功能到方法执行的前后,这也是比较常用的方式,它可以实现其他四种通知类型的功能。在学习通知类型之前,我们先来搭建一下环境以便测试使用它们。
创建一个Maven项目,在pom.xml添加Spring相关依赖
<dependencies>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-contextartifactId>
<version>5.2.10.RELEASEversion>
dependency>
<dependency>
<groupId>org.aspectjgroupId>
<artifactId>aspectjweaverartifactId>
<version>1.9.4version>
dependency>
dependencies>
添加BookDao和BookDaoImpl类
public interface BookDao {
public void update();
public int select();
}
@Repository
public class BookDaoImpl implements BookDao {
public void update(){
System.out.println("book dao update ...");
}
public int select() {
System.out.println("book dao select is running ...");
return 100;
}
}
创建Spring的配置类
@Configuration
@ComponentScan("com.guanzhi")
@EnableAspectJAutoProxy
public class SpringConfig {
}
创建通知类
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.guanzhi.dao.BookDao.update())")
private void pt(){}
public void beforeTest() {
System.out.println("before advice ...");
}
public void afterTest() {
System.out.println("after advice ...");
}
public void aroundTest(){
System.out.println("around before advice ...");
System.out.println("around after advice ...");
}
public void afterReturningTest() {
System.out.println("afterReturning advice ...");
}
public void afterThrowingTest() {
System.out.println("afterThrowing advice ...");
}
}
编写App运行类
public class App {
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
BookDao bookDao = ctx.getBean(BookDao.class);
bookDao.update();
}
}
语法:@Before()
,在原始功能执行前执行
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.guanzhi.dao.BookDao.update())")
private void pt(){}
@Before("pt()")
public void beforeTest() {
System.out.println("before advice ...");
}
}
语法:@After()
,在原始功能执行后执行
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.guanzhi.dao.BookDao.update())")
private void pt(){}
@Before("pt()")
public void beforeTest() {
System.out.println("before advice ...");
}
// 后置通知
@After("pt()")
public void afterTest() {
System.out.println("after advice ...");
}
}
语法: @AfterReturning()
,原始方法正常执行完返回值后执行
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(int com.guanzhi.dao.BookDao.select())")
private void pt(){}
@AfterReturning("pt()")
public void afterReturningTest() {
System.out.println("afterReturning advice ...");
}
}
注意:返回后通知是需要在原始方法select
正常执行后才会被执行,如果select()
方法执行的过程中出现了异常,那么返回后通知是不会被执行。而后置通知是不管原始方法有没有抛出异常都会被执行。
语法: @AfterThrowing()
,原始方法抛出异常后执行
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(int com.guanzhi.dao.BookDao.select())")
private void pt(){}
@AfterThrowing("pt()")
public void afterThrowingTest() {
System.out.println("afterThrowing advice ...");
}
}
注意:异常后通知是需要原始方法抛出异常,可以在select()
方法中添加一行代码int i = 1/0
进行测试。如果没有抛异常,异常后通知将不会被执行。
语法: @Around()
,可环绕原始方法执行,也模拟上述四种用法,非常灵活,不过在用法稍微复杂需要多多注意,如下:
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.guanzhi.dao.BookDao.update())")
private void pt(){}
@Around("pt()")
public void aroundTest(){
System.out.println("around before advice ...");
System.out.println("around after advice ...");
}
}
运行结果中,通知的内容打印出来,但是原始方法的内容却没有被执行。
注意:因为环绕通知需要在原始方法的前后进行增强,所以就必须使用ProceedingJoinPoint
对原始操作进行调用,不然程序不知道从哪里开始哪里结束便会覆盖原始方法。
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.guanzhi.dao.BookDao.update())")
private void pt(){}
@Around("pt()")
public void around(ProceedingJoinPoint pjp) throws Throwable{
System.out.println("around before advice ...");
//表示对原始操作的调用
pjp.proceed();
System.out.println("around after advice ...");
}
}
说明:有没有发现为什么我们在调用proceed()方法后就要在方法上抛出异常?
假设原始方法有返回值的处理
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(int com.guanzhi.dao.BookDao.select())")
private void pt(){}
@Around("pt()")
public void aroundSelect(ProceedingJoinPoint pjp) throws Throwable {
System.out.println("around before advice ...");
//表示对原始操作的调用
pjp.proceed();
System.out.println("around after advice ...");
}
}
public class App {
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
BookDao bookDao = ctx.getBean(BookDao.class);
int num = bookDao.select();
System.out.println(num);
}
}
运行后会报错,错误内容为:
Exception in thread "main" org.springframework.aop.AopInvocationException: ==Null return value from advice does not match primitive return type for: public abstract int com.itheima.dao.BookDao.select()==
at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:226)
at com.sun.proxy.$Proxy19.select(Unknown Source)
at com.itheima.App.main(App.java:12)
错误大概的意思是:空的返回不匹配原始方法的int返回
所以如果我们使用环绕通知的话,要根据原始方法的返回值来设置环绕通知的返回值,具体解决方案为:
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(int com.guanzhi.dao.BookDao.select())")
private void pt(){}
@Around("pt()")
public Object aroundSelect(ProceedingJoinPoint pjp) throws Throwable {
System.out.println("around before advice ...");
//表示对原始操作的调用
Object ret = pjp.proceed();
System.out.println("around after advice ...");
return ret;
}
}
说明:为了方便我们可以直接设置为Object,主要原因是Object类型更通用并且在环绕通知中是可以对原始方法返回值进行修的。
学习完这5种通知类型,我们来思考下环绕通知是如何实现其他通知类型的功能的?
因为环绕通知是可以控制原始方法执行的,所以我们把增强的代码写在调用原始方法的不同位置就可以实现不同的通知类型的功能,如:
名称 | @After |
@AfterReturning |
@AfterThrowing |
@Around |
@Before |
---|---|---|---|---|---|
类型 | 方法注解 | 方法注解 | 方法注解 | 方法注解 | 方法注解 |
位置 | 通知方法定义上方 | 通知方法定义上方 | 通知方法定义上方 | 通知方法定义上方 | 通知方法定义上方 |
作用 | 当前通知方法在原始切入点方法后运行 | 当前通知方法在原始切入点方法正常执行完毕后执行 | 当前通知方法在原始切入点方法运行抛出异常后执行 | 当前通知方法在原始切入点方法前后运行 | 当前通知方法在原始切入点方法前运行 |
环绕通知使用注意事项
ProceedingJoinPoint
才能实现对原始方法的调用,进而实现原始方法调用前后同时添加通知目前我们写的AOP仅仅是在原始方法前后追加一些操作,它当然没这么简单,不然也不能叫做核心概念,它还能获取所绑定切入点的相关信息,例如获取参数
、获取返回值
和获取异常
,方法名称,类型等众多信息。
接下来我们讲解其中三种,前面我们介绍通知类型的时候总共讲了五种,那么对于这五种类型都会有参数,返回值和异常吗?
获取切入点方法的参数
,所有的通知类型都可以获取参数
JoinPoint
:用于在前置、后置、返回后、抛出异常后通知中获取参数ProceedingJoinPoint
:用于环绕通知中获取参数获取切入点方法返回值
,前置和抛出异常后通知是没有返回值,后置通知可有可无,所以不做研究
获取切入点方法运行异常信息
,前置和返回后通知是不会有,后置通知可有可无,所以不做研究
接下来我们仍然使用上述案例环境进行测试,只不过需要进行稍微修改~
添加一个带参数的findName方法
public interface BookDao {
public String findName(int id);
}
@Repository
public class BookDaoImpl implements BookDao {
public String findName(int id) {
System.out.println("id:"+id);
return "itcast";
}
}
编写切入点表达式
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.guanzhi.dao.BookDao.findName(..))")
private void pt(){}
}
调用方法
public class App {
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
BookDao bookDao = ctx.getBean(BookDao.class);
String name = bookDao.findName(100);
System.out.println(name);
}
}
在方法参数上添加JoinPoint
,通过JoinPoint
中的getArgs()
来获取参数。
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.guanzhi.dao.BookDao.findName(..))")
private void pt(){}
@Before("pt()")
public void before(JoinPoint jp)
// 获取参数列表
Object[] args = jp.getArgs();
System.out.println(Arrays.toString(args));
System.out.println("before advice ..." );
}
//...其他的略
}
思考:方法的参数只有一个,为什么获取的返回值是一个数组?
这是因为参数的个数是不固定的,所以使用数组更通配些。
如果将参数改成两个会是什么效果呢?
(1) 我们为findName方法多增加一个参数
public interface BookDao {
public String findName(int id,String password);
}
@Repository
public class BookDaoImpl implements BookDao {
public String findName(int id,String password) {
System.out.println("id:"+id);
return "itcast";
}
}
(2) 调用方法传入多个参数,运行App,查看结果,说明两个参数都已经被获取到
说明:使用JoinPoint
的方式获取参数适用于前置
、后置
、返回后
、抛出异常后
通知,用法都是一致的。
环绕通知使用的是ProceedingJoinPoint
,因为ProceedingJoinPoint是JoinPoint类的子类,所以对于ProceedingJoinPoint类中应该也会有对应的getArgs()
方法,我们去验证下:
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.guanzhi.dao.BookDao.findName(..))")
private void pt(){}
@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;
}
//其他的略
}
运行App后查看运行结果,说明ProceedingJoinPoint也是可以通过getArgs()获取参数
注意:
调用无参数的proceed,当原始方法有参数,会在调用的过程中自动传入参数
所以调用这两个方法的任意一个都可以完成功能
但是当需要修改原始方法的参数时,就只能采用带有参数的方法,如下:
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.itheima.dao.BookDao.findName(..))")
private void pt(){}
@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable{
Object[] args = pjp.getArgs();
System.out.println(Arrays.toString(args));
args[0] = 666;
Object ret = pjp.proceed(args);
return ret;
}
//其他的略
}
有了这个特性后,我们就可以在环绕通知中对原始方法的参数进行拦截过滤,避免由于参数的问题导致程序无法正确运行,保证代码的健壮性。
对于返回值,只有返回后AfterReturing
和环绕Around
这两个通知类型可以获取,具体如何获取?
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.guanzhi.dao.BookDao.findName(..))")
private void pt(){}
@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable{
// 返回值获取
Object ret = pjp.proceed();
return ret;
}
//其他的略
}
上述代码中,ret
就是方法的返回值,我们是可以直接获取,不但可以获取,如果需要还可以进行修改。
返回后通知获取返回值便稍稍麻烦许多
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.guanzhi.dao.BookDao.findName(..))")
private void pt(){}
@AfterReturning(value = "pt()",returning = "ret")
public void afterReturning(Object ret) {
System.out.println("afterReturning advice ..."+ret);
}
//其他的略
}
注意:
参数类型可以写成String,但是为了能匹配更多的参数类型,建议写成Object类型
对于获取抛出的异常,只有抛出异常后AfterThrowing
和环绕Around
这两个通知类型可以获取,具体如何获取?
这块比较简单,以前我们是抛出异常,现在只需要将异常捕获,就可以获取到原始方法的异常信息了
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.gaunzhi.dao.BookDao.findName(..))")
private void pt(){}
@Around("pt()")
public Object around(ProceedingJoinPoint pjp){
Object ret = null;
try{
ret = pjp.proceed();
}catch(Throwable throwable){
t.printStackTrace();
}
return ret;
}
//其他的略
}
在catch方法中就可以获取到异常,至于获取到异常以后该如何处理,这个就和你的业务需求有关了。
@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(* com.guanzhi.dao.BookDao.findName(..))")
private void pt(){}
@AfterThrowing(value = "pt()",throwing = "t")
public void afterThrowing(Throwable t) {
System.out.println("afterThrowing advice ..."+t);
}
//其他的略
}
制作异常,运行App后,查看控制台,就能看的异常信息被打印到控制台
切入点表达式标准格式:动作关键字(访问修饰符 返回值 包名.类/接口名.方法名(参数)异常名)
execution(* com.guanzhi.service.*Service.*(..))
切入点表达式描述通配符:
*
:匹配任意符号(常用)..
:匹配多个连续的任意符号(常用)+
:匹配子类类型切入点表达式书写技巧
1.按标准规范开发
2.查询操作的返回值建议使用*匹配
3.减少使用…的形式描述包
4.对接口进行描述,使用*表示模块名,例如UserService的匹配描述为*Service
5.方法名书写保留动词,例如get,使用*表示名词,例如getById匹配描述为getBy*
6.参数根据实际情况灵活调整