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