SpringBoot使用AOP记录请求日志和异常日志

  • 本文基础WEB环境使用SpringBoot及Spring-Data-Jpa构建
  • 关于SpringBoot及JPA用法本文不再过多讨论,下面是引入的jar:


    起步依赖

    web及aop依赖

    jpa依赖

    mysql驱动
  • 本文着重AOP的使用,你也可以使用自己构建的环境
  1. 由于本文中使用的JPA,因此首先创建保存日志及保存异常的实体类,如果你使用的是Mybatis,则需要首先创建表然后根据表来逆向生成实体类
  • 保存日志的实体类:


    日志实体
  • 保存异常的实体类:


    异常实体

  1. 接下来我们定义一个Operation注解,用于声明在方法上描述此方法执行了什么操作:


    操作注解
  • @Target 声明这是一个自定义注解类,ElementType.METHOD 表明此注解可声明在方法上
  • @Retention 声明注解保留期限,RetentionPolicy.RUNTIME 表明此注解可保留至运行时,可以通过反射获取注解信息

  1. 然后编写一个AOP切面类,由于使用的SpringBoot只要保证在Application子目录之下就被会自动扫描,所以只需要注解声明即可,并不需要额外配置


    请求切面
  • @Aspect 声明这是一个切面类
  • @Compoent 此类交由Spring容器管理

  1. 定义请求日志切入点:


    切入点
  • @PointCut 定义请求日志切入点,其切入点表达式有多种匹配方式,详细请自行参阅资料,此处切入点为所有声明@Operation注解的方法

  1. 编写方法的前置通知:


    前置通知
  • 前置通知在执行目标方法之前执行
  • 在前置通知中设置请求日志信息,如开始时间,请求参数,注解内容等

  1. 编写方法的返回通知:


    返回通知
  • 返回通知,在目标方法正常结束之后执行
  • 在返回通知中补充请求日志信息,如返回时间,方法耗时,返回值,并且保存日志信息

  1. 编写方法的异常通知:


    异常通知
  • 异常通知,在目标方法非正常结束,发生异常或者抛出异常时执行
  • 在异常通知中设置异常信息,并将其保存

  1. Spring AOP 共计五种通知,由于本文中只需要三种,其它两种只做简单介绍,如有兴趣请自行查阅资料
  • 后置通知:在目标方法执行之后执行,与返回通知不同的是此通知无法拿到返回值,并且不管是否发生异常都会执行
  • 环绕通知:围绕动态代理的全过程,需要携带ProceedingJoinPoint参数,并且必须有返回值,且ProceedingJoinPoint类型的参数可以决定是否执行目标方法

  1. 在前置通知中设置请求日志信息的工具类:
  • 获取请求IP


    获取请求IP
  • 获取请求方式


    获取请求方式
  • 获取切入点的参数信息


    获取切入点的参数信息

    获取切入点的参数信息

  1. 编写一个简易Controoler,用于测试请求日志记录:


    测试请求日志
  • 启动SpringBoot之后,访问测试请求日志的URL,查看请求日志表记录,可以看到日志已成功记录:


    请求成功

    请求日志表记录
  • 接下来把测试请求日志的Controoler修改为抛出一个异常,测试异常记录:

测试异常日志
  • 然后重新启动SpringBoot,再次访问刚才的URL,可以看到产生了异常:


    请求异常
  • 再次查看请求日志表,发现还是一条记录,说明异常通知执行后并不会执行返回通知,这正是我们期望的结果:


    请求日志记录
  • 然后我们再查看异常记录表,发现已经将异常记录:


    异常日志

至此,SpringBoot AOP记录请求日志和异常日志完成

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

推荐阅读更多精彩内容

  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,733评论 6 342
  • SpringBoot AOP 记录日志实例 散布于应用中多处的功能(日志、安全、事务管理等)被称为横切关注点。把横...
    光剑书架上的书阅读 7,328评论 2 35
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,596评论 18 139
  • 九折萦峦见日光, 四方峰仞竞沧茫。 莫觉身临绝顶处, 最高之地在前方。 喜欢请点赞哦。
    流萤点灯阅读 325评论 6 6
  • 付出与回报是合理的人性, 没有人不渴求回应。 所以营销学恰好可以利用。 第一个月热情, 第二个月关心, 第三个月冷...
    西服小图阅读 66评论 0 0