SpringAOP的应用:统计接口执行时间

什么是AOP

Spring是java面向对象编程的主流框架,其主要思想有两个:反转控制(IOC)和面向切面(AOP)。

AOP(Aspect Oriented Programming)称为面向切面编程,是对面向对象(OOP)的补充和完善。

普通的面向对象基于封装、继承、多态等概念来建立一种对象层次结构,但仅限于纵向层次,无法做到横向关联。而日志、异常处理等功能涉及各个类,代码横向地散布在所有层次中,传统OOP难以复用这些代码。

而AOP利用一种称为"横切"的技术,剖解开封装的对象内部,并将那些影响了多个类的公共行为封装到一个可重用模块,并将其命名为"Aspect",即切面。

所谓"切面",简单说就是那些与业务无关,却为业务模块所共同调用的逻辑或责任封装起来,便于减少系统的重复代码,降低模块之间的耦合度,并有利于未来的可操作性和可维护性。

日志中统计执行时间

对应代码中的关键方法,在日志中通过计时统计执行时间,可以监控功能执行是否正常,也可以观察程序的性能,作为优化效果的判断依据。

统计执行时间可以使用Stopwatch工具类,引入

import com.google.common.base.Stopwatch;

使用createStarted()开始计时,结束时用elapsed统计耗时。

代码示例如下:

import com.google.common.base.Stopwatch;

Stopwatch stopwatch = Stopwatch.createStarted();
/**
 * 功能代码
 */
log.info("xxxxx,elapsed:{} ms", stopwatch.elapsed(TimeUnit.MILLISECONDS));

不过这种方式只能统计一个功能的耗时,若现在有100个接口都需要统计耗时的话,显然是没办法每个都去这么写的。

这时就需要配合AOP技术来实现了。

使用AOP构建通用计时类

先放完整的实现:

@Component
@Aspect
@Log4j
public class TimingUtil {
 
    @Pointcut("execution(* com.xxx.xx.controller..*.*(..))")
    private void pointCut(){}
 
    @Around("pointCut()")
    public Object timing(ProceedingJoinPoint joinPoint){
        Object object;
        Stopwatch stopwatch = Stopwatch.createStarted();
        try{
            object = joinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
            return null;
        }
        log.info("API request completed, takes " + stopwatch.elapsed(TimeUnit.MILLISECONDS) + " ms.");
        return object;
    }
}

来看这里面的关键点:

1 Aspect和Component注解
Component注解对于Springboot来说相当于声明bean并添加至xml配置中,加了Component的类编译时就被视为Springboot项目的bean,进行拼装。

Aspect注解则声明了该类是一个切面。

2 PointCut注解
该注解用来声明AOP切面的切入点,或者说,告诉程序什么时候要使用切面介入。

execution表示在执行某些方法时介入,是PointCut最常用的介入方式。

表达式格式为:(返回类型,方法路径.方法名(参数类型))

在本例中,要介入的是接口类以获取时间,第一个* 代表不限制返回类型,接口类存放的路径在com.xxx.xx.controller中,后面..* 表示controller包下的所有类。

再往后.*表示这个类下的所有方法,(..)代表不限制传入的参数类型。

3 Around注解
在捕获切入点后,AOP类就可以进行切面上的操作了。

根据需要处理的行为方式不同,可以使用不同的注解标记,例如前置处理@Before、后置处理@AfterRunning、异常处理@AfterThrowing、环绕处理@Around等等。

这里我们要记录接口执行的时间,因此需要在接口调用前开始计时,在接口返回后停止计时,所以需要环绕处理。

需要在Around注解后标记切入方法名,因为可能不止一个切入。

使用Around注解时,切面方法必须使用入参ProceedingJoinPoint,代表切入点,切面方法返回类型默认选object(当然,如果可以确保所有返回类型一致,也可以直接定义)。

joinPoint.proceed()这个方法表示执行切入点的方法,在此之前的代码部分为前置处理,在此之后的代码部分为后置处理。

所以在执行proceed之前启动秒表,在执行后记录时间,这样对所有接口进行计时的功能就完成了。

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

推荐阅读更多精彩内容

  • IoC 容器 Bean 的作用域 自定义作用域实现 org.springframework.beans.facto...
    Hsinwong阅读 2,450评论 0 7
  • 概述 Spring是什么? Spring是一个开源框架,为了解决企业应用开发的复杂性而创建的,但是现在已经不止于企...
    琅筑阅读 1,149评论 2 8
  • Spring的AOPAOP的基本概念基于注解的“零配置”方式定义切面Bean定义Before增强处理定义After...
    渐丶忘阅读 1,598评论 0 0
  • 因为工作需求,自己去了解一下aop并做下的记录,当然大部分都是参考他人博客以及官方文档。 目录 [关于 AOP](...
    forip阅读 2,267评论 1 20
  • 雷雁雄10月12日总结:今天白天做标书,晚上接待客户。
    雷雁雄阅读 103评论 0 0