如何优雅地记录操作日志

一个系统来说不可或缺,对于问题的排查,问题的再现有着至关重要的作用。由于不想从日志文件一行行摸索,想追求简单、快捷、方便;只需根据条件就可以检索到相应接口日志,以及是否出现报错的情况。同时我不想用在业务代码中记录业务日志的方式。那还有什么方法呢?思考片刻,想到了用 AOP 的方式去记录接口日志。

于是秉着一劳永逸的思想。我打算将项目封装成 starter,在需要用到的地方,直接引入即可生效。无需做更多复杂、繁琐、重复的工作。

具体做法分三步走

定义日志级别枚举,因为不同日志级别,代表着接口方法不同的日志记录方式。包括:NONE 不记录日志,INFO 记录正常日志,ERROR 记录异常日志, ALL 记录全部日志行为。

定义 AOP 通过 @Logger 注解完成需要增强的切入点,使用 @Around 环绕增强完成接口方法 入参、出参等信息的填补。

使用 @PostConstruct 完成 日志表结构 的初始化,使得只需要引入依赖即可自动完成日志的生成与记录。

详细描述

由于在1点和 3点相对简单,接下来就不再赘述,以下主要针对 2 点 进行详细描述。

由于涉及到注解完成切点,于是我兼容了注解在 类 上 和 方法 上都可以完成操作,注意,此处方法上的注解优先级更高些,这也使得一个类下可以排除某些方法,使得运用更加灵活多变。

初始化日志实体数据,通过 ProceedingJoinPoint 参数以及 Hutool 工具类完成相关信息的提取。

通过开启新线程的方式完成日志的持久化,因为不想影响到主业务逻辑的执行。

@Around("@within(com.cpz.log.annotation.Logger) || @annotation(com.cpz.log.annotation.Logger)")publicObjectdoAround(ProceedingJoinPoint point)throwsThrowable

https://b23.tv/jEgX6mI

https://b23.tv/b4Mxv8H

https://b23.tv/eFiLW6y

https://b23.tv/dV6o44y

使用效果

通过 maven 将项目打包,并将依赖安装到本地仓库,方便其它项目使用,同时为了方便这一流程,实现了将 jar 打包为本地依赖的脚本文件,install.bat

mvn install:install-file -Dfile=../spring-boot-starter-logger/target/spring-boot-starter-logger-1.0.jar -DgroupId=com.cpz -DartifactId=spring-boot-starter-logger -Dversion=1.0 -Dpackaging=jar

2) 引入依赖

com.cpzspring-boot-starter-logger1.0

3) 开启记录接口日志

@Logger(level = LogLevel.ALL)@GetMapping("/test/query")publicListquery(User user){returnuserService.list();}

调用接口查看数据库日志表信息

(1,'/test/query','com.cpz.mybatisplus.controller.LoggerController','query','192.168.42.104','169.254.180.230',1,'{\"Accept\":\"*/*\",\"User-Agent\":\"PostmanRuntime/7.30.0\",\"Host\":\"192.168.42.104:8080\",\"Accept-Encoding\":\"gzip, deflate, br\",\"Postman-Token\":\"9c3015be-c5a4-4195-8c76-45a03203e201\",\"Content-Length\":\"40\",\"Content-Type\":\"application/json\"}','{\"user\":{\"name\":\"zhansan\"}}','[{\"name\":\"战三\",\"id\":1,\"age\":11,\"email\":\"cpzisme@qq.com\"},{\"name\":\"李四\",\"id\":2,\"age\":12,\"email\":\"lisi@qq.com\"},{\"name\":\"王五\",\"id\":3,\"age\":121,\"email\":\"das@qq.com\"}]','',153,'2022-12-31 15:55:47');

可以看到,已经完成日志记录。

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

推荐阅读更多精彩内容