Spring AOP 实现函数执行时间打印

AOP 概念

AOP:Aspect Orient Programming
中文翻译:面向切面编程
作为面向对象编程的一种补充,采用非侵入式技术手段处理系统中分布于各个模块的横切关注点,比如事务管理,安全审计,日志、缓存等等。

AOP 优缺点

优点:原有代码无需更改,不影响原有业务逻辑;
缺点:通过代理方式,会有一定的性能损失;

AOP 代理

AOP 的底层实现是通过代理和反射技术,拦截正常的方法调用,在正常方法调用完成前和完成后插入切面相关的代码。具体实现有如下两种:

  • 静态代理:
    代表:AspectJ,直接通过修改字节码实现,编译期完成,但是需要额外的编译器支持;
  • 动态代理:
    代表:Spring AOP,运行时动态创建代理类;
    Spring AOP 代理又分为两种,JDK Proxy 和 CGLIB,分别针对接口代理和类代理。

AOP 关键点:

  • Aspect:切面
    对应一个类,用于实现横跨多个企业应用类的业务处理,比如事务,日志等。
    通俗的话来说,其他应用类实现业务的主要逻辑(纵向),切面关注次要方面(横向插入日志,事务处理,安全审计等动作)。
  • Join Point:连接点
    方法执行,异常处理,改变对象的值等特定情况;
  • Advice:动作
    与连接点和切点相关的一系列动作
    对应一个方法
  • Pointcut:切点
    与连接点相关的表达式,匹配则执行相关动作(Advice);
  • Target Object:目标对象
    加入相关的动作处理(Advice)的目标对象;
  • AOP Proxy:代理
    Spring AOP 通过 JDK Proxy 或者 CGLIB 创建代理;
  • Weaving:织入
    关联切面和目标对象的过程。可以在编译期,加载期或运行期完成;
    Spring AOP 在运行期完成这个过程,AspectJ在编译期完成这个过程;

AOP 实现举例:(函数执行时间打印)

基于常用的 Spring AOP 为例,基于注解实现打印函数执行时间的切面功能。

增加依赖包

创建 Spring 项目,在 pom.xml 加入 Spring AOP 相关的类。

#pom.xml

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-aop</artifactId>
  <version>${spring.version}</version>
</dependency>

<dependency>
  <groupId>org.aspectj</groupId>
  <artifactId>aspectjrt</artifactId>
  <version>1.8.14</version>
</dependency>
<dependency>
  <groupId>org.aspectj</groupId>
  <artifactId>aspectjweaver</artifactId>
  <version>1.8.14</version>
</dependency>
开启切面能力

proxyTargetClass = true,强制使用 CGLIB 代理,如果不设置针对于接口方法织入,默认使用 JDK Proxy 代理。

@Configuration
@EnableAspectJAutoProxy(proxyTargetClass = true)
 public class AspectJConfiguration {
 }
定义注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CallTime {

}
创建切面
@Aspect
@Component
public class CallTimeAspect {
 
}
增加切点
@Aspect
@Component
public class CallTimeAspect {
  @Pointcut("@annotation(CallTime) && execution(public org.test.service.*(..))") 
  public void pointCutMethod();
}

"@annotation(CallTime) && execution(public org.test.service.*(..))"
这个表达式表示只拦截加有CallTime注解的,并且是public方法,并且是 org.test.service这个包下面的类的方法,只有匹配这个表达式的方法才会被拦截,当然这个表达式可以更复杂,比如针对参数做匹配等等。

增加连接点和动作

Spring 只支持方法连接点,主要有3种方式对方法进行增强:
@Before 方法执行前;
@After 方法执行后;
@Around 方法执行过程中;

@Aspect
@Component
public class CallTimeAspect {
  @Pointcut("@annotation(CallTime) && execution(public org.test.service.*(..))") 
  public void pointCutMethod();

  @Around("pointCutMethod()")
  public Object callTime(ProceedingJoinPoint joinPoint) throws Throwable {
    long start = System.currentTimeMillis();
    Object proceed = joinPoint.proceed();
    long end = System.currentTimeMillis();
    String className = proceed.getSignature().getDeclaringType().getSimpleName();
    String functionName = proceed.getSignature().getName();
    System.out.println(String.format("%s.%s takes %dms", className, functionName, end - start));
    return proceed;
  }
}
增加拦截代码
# org.test.service

public class BusinessService {

   @CallTime
   void doBusiness() {
      ...
   }
}

当doBusiness在外部被调用时,就会打印执行时间了:

BusinessService.doBusiness takes XXXms
潜在的问题
  • 被final修饰的类无法被改写,因此也就没法使用 AOP 进行拦截;
  • 在外部调用被拦截的方法中再调用该类其他的方法,无法使用 AOP 进行拦截;
class Test {
  @CallTime
  public void funcA() {
     this.funcB();
  }
  
  @CallTime
  public void funcB() {
  }

在外部调用:

new Test().funcA()

只有 funcA 会被拦截,funcB 并不会。

  • 私有方法不能被外部调用,因此也就没法使用 AOP 进行拦截;

Spring AOP 参考

https://www.journaldev.com/2583/spring-aop-example-tutorial-aspect-advice-pointcut-joinpoint-annotations

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

推荐阅读更多精彩内容