【Spring AOP】@Aspect结合案例详解（二）: @Pointcut使用@within和within（已附源码）
文章目录
- 前言
- @within
-
- 完善打印日志案例
- @within深入说明
- within
-
- 匹配指定类
- 匹配指定包(package)
- 源码下载
- 总结
前言
在微服务流行的当下，在使用Spring Cloud / Spring Boot框架开发中，AOP使用的非常广泛，尤其是@Aspect注解方式当属最流行的，不止功能强大，性能也很优秀，还很舒心！所以本系列就结合案例详细介绍@Aspect方式的切面的各种用法，力求覆盖日常开发中的各种场景。
本文主要介绍@Pointcut切点表达式的 @within和within 这两种切点指示符，结合案例，十分钟让你彻底搞懂！
@within匹配指定类注解, 上文的@annotation是匹配指定方法注解within匹配指定类或包
上文回顾：【Spring AOP】@Aspect结合案例详解（一）: @Pointcut使用@annotation + 五种通知Advice注解（已附源码）
@within
@within 匹配的是类上的注解，匹配后 类中实现的方法都会被Advice增强。还是结合打印日志案例实际演练一下基本用法。
完善打印日志案例
上文实现的打印日志使用 @annotation 方式，由于是匹配方法注解, 所以我们就需要在各个方法上定义，代码如下：
@Service
public class DemoService {
@MethodLog
public Integer divide(Integer a, Integer b) {
System.out.printf("divide方法内打印: a=%d b=%d 返回:%d %n", a, b, a / b);
return a / b;
}
@MethodLog
public Integer add(Integer a, Integer b) {
System.out.printf("add方法内打印: a=%d b=%d 返回:%d %n", a, b, a + b);
return a + b;
}
}
这样一来 ，当类中越来越多的方法需要打印日志时，就需要对每个方法加@MethodLog注解，所以我们做一下完善优化，替换成在 类上加注解，不管有多少方法我只需要在类上加一个 @ClassLog注解 即可，代码如下：
@Service
@ClassLog
public class DemoService {
public Integer divide(Integer a, Integer b) {
System.out.printf("divide方法内打印: a=%d b=%d 返回:%d %n", a, b, a / b);
return a / b;
}
public Integer add(Integer a, Integer b) {
System.out.printf("add方法内打印: a=%d b=%d 返回:%d %n", a, b, a + b);
return a + b;
}
}
业务逻辑代码无侵入，所以divide 和 add 方法 都不需要改变，只是将方法上@MethodLog注解去掉，在类上增加@ClassLog注解，这里用到的 @ClassLog注解 代码如下：
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ClassLog {
}
另外，切点 @Pointcut 我们修改成：使用@within方式，让切点匹配ClassLog注解，代码如下：
@Pointcut(value = "@within(com.tiangang.aop.ClassLog)")
public void pointCut() {
}
语法：@Pointcut(value = "@within(注解类名)")
和上文的@annotation语法如出一辙，完整的切面类LogAspec 代码如下：
@Component
@Aspect
public class LogAspect {
@Pointcut(value = "@within(com.tiangang.aop.ClassLog)")
public void pointCut() {
}
@Before("pointCut()")
public void before(JoinPoint joinPoint) throws NoSuchMethodException {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Class<?> clazz = joinPoint.getTarget().getClass();
Method method = clazz.getMethod(signature.getName(), signature.getParameterTypes());
System.out.printf("[前置通知]: [目标类]:%s , [方法]:%s , [入参值]:%s%n"
, clazz.getName(), method.getName(), Arrays.toString(joinPoint.getArgs()));
}
@AfterReturning(value = "pointCut()", returning = "result")
public void afterReturning(JoinPoint joinPoint, Object result) {
Class<?> clazz = joinPoint.getTarget().getClass();
System.out.printf("[返回通知]: [目标类]:%s , [方法]:%s , [返回值]:%s%n"
, clazz.getName(), joinPoint.getSignature().getName(), result);
}
}
Advice通知只保留了 @Before 和 @AfterReturning ，用于记录 方法签名、入参和返回值。
调用试试看：
[前置通知]: [目标类]:com.tiangang.service.DemoService , [方法]:divide , [入参值]:[10, 2]
divide方法内打印: a=10 b=2 返回:5
[返回通知]: [目标类]:com.tiangang.service.DemoService , [方法]:divide , [返回值]:5
至此，基于类的打印日志就基本完善了，所有加了@ClassLog注解的类都会被Advice增加打印日志。
如果需要增加 自定义逻辑，可以在ClassLog注解中增加变量，并在Advice中实现逻辑。
演示一下，加一个控制是否打印result的逻辑，先在ClassLog中加isLogResult() 变量, 默认true，控制是否打印结果，代码如下：
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ClassLog {
boolean isLogResult() default true;
}
然后在@AfterReturning中，通过ClassLog annotation = clazz.getAnnotation(ClassLog.class);获取到ClassLog注解，这样就可以自由发挥了，代码如下：
@AfterReturning(value = "pointCut()", returning = "result")
public void afterReturning(JoinPoint joinPoint, Object result) {
Class<?> clazz = joinPoint.getTarget().getClass();
ClassLog annotation = clazz.getAnnotation(ClassLog.class);
if (annotation != null && annotation.isLogResult()) {
System.out.printf("[返回通知]: [目标类]:%s , [方法]:%s , [返回值]:%s%n"
, clazz.getName(), joinPoint.getSignature().getName(), result);
}
}
对需要切面增强的类加 @ClassLog 注解
-
需要打印结果，配置成：@ClassLog(isLogResult = true) 或 @ClassLog，因为写的默认default true
@ClassLog(isLogResult = true) public class DemoService { } -
不需要打印结果，配置成：@ClassLog(isLogResult = false)
@ClassLog(isLogResult = false) public class DemoService { }
@within深入说明
因为@ClassLog注解是加在类上，就会涉及到类继承，那么子类继承父类后，调用子类的方法是否会被 @within 匹配？
先说原则：主要看调用子类方法时应该走父类方法还是子类方法，再看对应父类/子类上 是否有 被@within匹配的注解(这里是@ClassLog注解)，有就是匹配，没有就是不匹配！
这些在写代码时就可以确定，也就是静态匹配。懂继承的话就非常好理解，没理解的可以看看以下的详细说明：
- 父类加上@ClassLog注解，调用父类方法肯定匹配，子类的具体情况如下：
| 子类不加@ClassLog注解 | 子类加@ClassLog注解 | |
|---|---|---|
| 调用子类的新增方法(父类没有) | 不匹配 | 匹配 |
| 调用子类的@Override方法 | 不匹配 | 匹配 |
| 调用子类的未@Override方法 | 匹配(因为走的父类方法) | 匹配 |
- 父类不加@ClassLog注解，调用父类方法肯定不匹配，子类的具体情况如下：
| 子类加@ClassLog注解 | |
|---|---|
| 调用子类的新增方法(父类没有) | 匹配 |
| 调用子类的@Override方法 | 匹配 |
| 调用子类的未@Override方法 | 不匹配（因为走的父类方法，父类上没加@ClassLog注解） |
看起来复杂，实际非常容易验证，新建一个子类DemoServiceExt继承DemoService：
@Service
public class DemoServiceExt extends DemoService {
// 子类重写的方法
@Override
public Integer divide(Integer a, Integer b) {
System.out.printf("ext.divide方法内打印: a=%d b=%d 返回:%d %n", a, b, Math.floorDiv(a, b));
return Math.floorDiv(a, b);
}
// 子类新增的方法
public Integer max(Integer a, Integer b) {
System.out.printf("ext.max方法内打印: a=%d b=%d 返回:%d %n", a, b, Math.max(a,b));
return Math.max(a, b);
}
}
在DemoController中新增一个API分别来调2个父类方法和3个子类方法，代码如下：
@RestController
@RequestMapping("/demo")
public class DemoController {
@Autowired
private DemoService demoService;
@Autowired
private DemoServiceExt demoServiceExt;
// http://localhost:8080/demo/test?a=10&b=2
@GetMapping("/test")
public void combine(Integer a, Integer b) {
demoService.divide(a, b);
demoService.add(a, b);
demoServiceExt.divide(a, b);
demoServiceExt.add(a, b);
demoServiceExt.max(a, b);
}
}
下面输出：父类DemoService 加@ClassLog，子类DemoServiceExt 不加@ClassLog的情况：
-
demoService.divide 调父类方法 - 匹配
[前置通知]: [目标类]:com.tiangang.service.DemoService , [方法]:divide , [入参值]:[10, 2]
divide方法内打印: a=10 b=2 返回:5
[返回通知]: [目标类]:com.tiangang.service.DemoService , [方法]:divide , [返回值]:5 -
demoService.add 调父类方法 - 匹配
[前置通知]: [目标类]:com.tiangang.service.DemoService , [方法]:add , [入参值]:[10, 2]
add方法内打印: a=10 b=2 返回:12
[返回通知]: [目标类]:com.tiangang.service.DemoService , [方法]:add , [返回值]:12 -
demoServiceExt.divide 调子类方法 - 重写方法 - 不匹配（因为被子类重写，走的不是父类方法）
ext.divide方法内打印: a=10 b=2 返回:5
-
demoServiceExt.add 调子类方法 - 未重写方法 - 匹配（因为子类未重写，走的还是父类方法）
[前置通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:add , [入参值]:[10, 2]
add方法内打印: a=10 b=2 返回:12注意：这里由于DemoServiceExt上没有注解，所以没打出来result。
-
demoServiceExt.max 调子类方法 - 新增方法(父类没有) - 不匹配（因为是新增方法，走的不是父类方法）
ext.max方法内打印: a=10 b=2 返回:10
下面输出：父类DemoService 不加@ClassLog，子类DemoServiceExt 加@ClassLog的情况：
-
demoService.divide 调父类方法 - 不匹配，因为没走子类方法
divide方法内打印: a=10 b=2 返回:5
-
demoService.add 调父类方法 - 不匹配，因为没走子类方法
add方法内打印: a=10 b=2 返回:12
-
demoServiceExt.divide 调子类方法 - 重写方法 - 匹配（因为方法被子类重写，走的是子类方法）
[前置通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:divide , [入参值]:[10, 2]
ext.divide方法内打印: a=10 b=2 返回:5
[返回通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:divide , [返回值]:5 -
demoServiceExt.add 调子类方法 - 未重写方法 - 不匹配（因为方法未被子类重写，走的不是子类方法）
add方法内打印: a=10 b=2 返回:12
-
demoServiceExt.max 调子类方法 - 新增方法(父类没有) - 匹配（因为是子类新增方法，走的是子类方法）
[前置通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:max , [入参值]:[10, 2]
ext.max方法内打印: a=10 b=2 返回:10
[返回通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:max , [返回值]:10
另外还有一个点：如果期望匹配父类及其子类所有方法，除了对父类和子类都加ClassLog注解的方式外，还可以对ClassLog注解增加 @Inherited，这样父类加上ClassLog注解会被子类继承，代码如下：
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ClassLog {
boolean isLogResult() default true;
}
对于@within，至此就说透了~~
within
within前面没有@，所以不是匹配注解，而是匹配 类 ，另外还可以匹配 包 ，咱们一个一个说。
匹配指定类
将切点表达式改为within的方式：
@Pointcut(value = "within(com.tiangang.service.DemoService)")
public void pointCut() {
}
语法：@Pointcut(value = "within(类全路径名)")
匹配原则(以下2个必须需要同时满足)：
- 必须1：调用的类 必须是
within内指定的类。 - 必须2：调用的方法 必须走
within内指定类的方法，如果走的是父类方法，即使满足必须1，也不会被匹配。
所以上面这个切点表达式，只有DemoService类的方法会被Advice增强，执行结果如下：
-
demoService.divide 调父类方法 - 匹配
[前置通知]: [目标类]:com.tiangang.service.DemoService , [方法]:divide , [入参值]:[10, 2]
divide方法内打印: a=10 b=2 返回:5
[返回通知]: [目标类]:com.tiangang.service.DemoService , [方法]:divide , [返回值]:5 -
demoService.add 调父类方法 - 匹配
[前置通知]: [目标类]:com.tiangang.service.DemoService , [方法]:add , [入参值]:[10, 2]
add方法内打印: a=10 b=2 返回:12
[返回通知]: [目标类]:com.tiangang.service.DemoService , [方法]:add , [返回值]:12 -
demoServiceExt.divide 调子类方法 - 重写方法 - 不匹配，因为 调用的类 不是DemoService
ext.divide方法内打印: a=10 b=2 返回:5
-
demoServiceExt.add 调子类方法 - 未重写方法 - 不匹配，因为 调用的类 不是DemoService
add方法内打印: a=10 b=2 返回:12
-
demoServiceExt.max 调子类方法 - 新增方法(父类没有) - 不匹配，因为 调用的类 不是DemoService
ext.max方法内打印: a=10 b=2 返回:10
那么请思考，换成 @Pointcut(value = “within(com.tiangang.service.DemoServiceExt)”) 结果是？
答案：只有DemoServiceExt的重写方法和新增方法会被Advice增强，执行结果如下：
-
demoService.divide 调父类方法 - 不匹配，因为 调用的类 不是DemoServiceExt
divide方法内打印: a=10 b=2 返回:5
-
demoService.add 调父类方法 - 不匹配，因为 调用的类 不是DemoServiceExt
add方法内打印: a=10 b=2 返回:12
-
demoServiceExt.divide 调子类方法 - 重写方法 - 匹配
[前置通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:divide , [入参值]:[10, 2]
ext.divide方法内打印: a=10 b=2 返回:5
[返回通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:divide , [返回值]:5 -
demoServiceExt.add 调子类方法 - 未重写方法 - 不匹配，因为走的还是父类方法
add方法内打印: a=10 b=2 返回:12
-
demoServiceExt.max 调子类方法 - 新增方法(父类没有) - 匹配
[前置通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:max , [入参值]:[10, 2]
ext.max方法内打印: a=10 b=2 返回:10
[返回通知]: [目标类]:com.tiangang.service.DemoServiceExt , [方法]:max , [返回值]:10
另外还有一个点：如果期望匹配 父类及其子类所有方法，可以在父类后面加个+，代码如下：
@Pointcut(value = "within(com.tiangang.service.DemoService+)")
public void pointCut() {
}
这样，父类和子类的方法就会都被匹配了~~
匹配指定包(package)
使用.*匹配包，但不匹配子包。
如下代码代表：com.tiangang.service 包下面的所有类的方法都会被匹配，但不包括子包下面的类的方法。
@Pointcut(value = "within(com.tiangang.service.*)")
public void pointCut() {
}
使用..*匹配包及子包。
如下代码代表：com.tiangang 包以及子包下面的所有类的方法都会被匹配。
@Pointcut(value = "within(com.tiangang..*)")
public void pointCut() {
}
源码下载
百看不如一练，下载源码实际运行一遍效果更佳！
源码零积分下载地址：https://download.csdn.net/download/scm_2008/87381444
总结
本文介绍了@Pointcut切点表达式中的@within、within这两种切点指示符的基本用法，并结合打印日志案例从匹配 类(Class) 级别和匹配 包(package) 级别，并在有子类继承的场景下，对各种情况做了详细说明。
@within匹配指定 类(Class) 注解within前面没有@，所以不是匹配注解，而是匹配指定类 或 包(package)
❤️ 博客主页：https://blog.csdn.net/scm_2008
❤️ 欢迎点赞 收藏 ⭐留言✏️ 如有错误敬请指正！
❤️ 本文由 天罡gg 原创，首发于 CSDN博客
❤️ 停下休息的时候不要忘了别人还在奔跑，希望大家抓紧时间学习，全力奔赴更美好的生活