记录项目日志,一个注解搞定

网站建设4年前发布
18 0 0

前段时间做了一个支线任务,现在还是回到我们的主线上面来,继续完成 TienChin 项目。,小伙伴们知道松哥最近在录制 TienChin 项目视频教程,这是一个基于 RuoYi-Vue 脚手架的项目,用过这个脚手架的小伙伴可能知道,这个脚手架有一个功能,就是如果你需要记录下来一个接口的操作信息,那么只需要在 Controller 接口中加上一个 @Log 注解即可,非常方便,最终记录到数据库中的日志类似下面这样:,可能有小伙伴要吐槽了,这不该记录到 Elasticsearch 中吗?上 ELK 啊!怎么说呢,如果你会将日志存入数据库,那么将来存 Elasticsearch 其实非常 Easy,结合松哥之前录制的 Es 视频(公号后台回复 es),我相信这个问题你能自己搞定。,今天我们主要来分析一下这个脚手架中 @Log 注解的玩法。,先来看看日志表的设计。,这里各个字段的含义我来解释下:,这里给出来的就这些字段,基本上满足项目需求了,如果不够的话,也可以自定添加即可。,再来看看 @Log 注解的定义,该注解位于 org.javaboy.tienchin.common.annotation.Log:,这个注解一共有五个属性,结合上面表的定义,五个属性含义很好理解,不多说。,经典搭配:自定义注解+ AOP 切面。解析该注解的 AOP 切面是 LogAspect,位于 org.javaboy.tienchin.framework.aspectj.LogAspect:,大概跟小伙伴们捋一下这个切面的逻辑。,如果请求类型是 PUT 或者 POST,就直接从接口的参数中获取想要的数据,但是接口的参数中可能会存在一些并不需要记录的内容,例如 HttpServletRequest、HttpServletResponse 或者文件上传对象 MultipartFile 等,这些类型的内容是不需要记录到日志中的,这里通过一个 isFilterObject 方法完成了数据过滤操作;,如果请求类型是 GET 或者 DELETE,则请求参数就直接从请求对象提取了。为什么设计成这样呢?很明显,直接从请求对象中提取参数是最为方便的,一行代码就搞定,但是如果请求类型是 PUT 或者 POST,就意味着请求参数是在请求体中,请求参数有可能是二进制数据(例如上传的文件),二进制数据就不好保存了,所以对于 POST 和 PUT 还是从接口参数中提取,然后过滤掉二进制数据即可。,弄好之后,日志注解具体用法如下:,好啦,这就是整体操作,实际上看起来并不难,后面要是有空的话,松哥把这个日志整成一个 ELK 的,和小伙伴们一起探讨。

© 版权声明

相关文章