我用注解实现接口的操作流水日志

╰半夏微凉° 2022-12-21 15:59 49阅读 0赞

在项目中，我们会需要获取接口的操作日志。比如获取接口的接口名、操作人，接口运行时间、所属的服务、接口的类型（增删改查）等等。初级的做法是在接口方法执行完后将这些操作记录存入库中，这段代码写在接口中，但是这样违反了设计原则中的单一职责原则。常用的做法是使用AOP来做，在运行时动态的插入日志记录的代码。这里我是用注解来做。

## 创建日志记录表 ##

首先我们来创建日志记录表：

![7aa02eb2ae1f477fd245cc949ddefa14.png][]

operation表

当然后编写实体类：

![6f2473f0085d6c6b9a83a820cc2c8c11.png][]

## 编写日志记录注解 ##

我们先定义一个注解`OperationLog`

![517a5bc5bbe082072a0d783ecf33b646.png][]

这个注解里面定义了几个参数：

> “
> 
> opType：业务类型
> 
> opBusinessName：业务名称，例如会员服务、订单服务等等
> 
> opBusinessId：业务来源ID，一般为主键ID
> 
> ”

定义业务类型类`OperationType`

![ba93f57e4a4e849a72386a5d899dc380.png][]

这个业务类型类定义了接口的类型：增删改查。

接下来我们编写切面类`OperationLogAspect`

获取方法上面的注解：

Method method = ((MethodSignature) pjp.getSignature()).getMethod();
    //获取目标方法上面的注解
    OperationLog opLog = method.getAnnotation(OperationLog.class);

执行目标方法：

try {
        // 执行目标方法
        result = pjp.proceed();
    } catch (Throwable throwable) {
        throw new Exception(throwable);
    }

在执行目标方法前后记录执行时间：

TimeInterval timer = DateUtil.timer();
    ...
     // 执行目标方法
    ...
    long executeTime = timer.intervalRestart();

解析注解上的表达式，就是获取业务id：

// 解析表达式，获取结果
    String itemId = String.valueOf(expression.getValue(context));

将数据封装到对象中：

Operation operation = Operation.builder()
                        //.id(snowflake.nextId())
                        .opType(opLog.opType().name())
                        .opBusinessName(opLog.opBusinessName())
                        .opBusinessId(itemId)
                        .opTime(String.valueOf(executeTime))
                        //这里可以添加操作人
                        .build();

记录日志并入库：

private void handle(Operation operation) {
        // 通过日志打印输出
        log.info("opType = " + operation.getOpType() + ",opItem = " + operation.getOpBusinessName() + ",opItemId = " + operation.getOpBusinessId() + ",opTime = " + operation.getOpTime());
        // 持久化入库
        operationService.save(operation);
    }

整体代码如下：

![4522781800e4a504bc8580ba9dbc39e8.png][]

## 测试注解 ##

测试注解代码如下：

@RequestMapping("/getById")
    @ResponseBody
    @OperationLog(opType = OperationType.QUERY,opBusinessName = "会员服务",opBusinessId = "#id")
    public Member getById(@RequestParam String id) {
        return memberService.getById(id);
    }

我们在这个接口`getById`上添加了注解`@OperationLog`，表明我们想记录这个接口的操作记录。opType为查询类型，所属的业务为会员服务，业务id为接口的参数id。

启动代码运行接口：

![ec9465dfd26fc9610115bdbbb973c0df.png][]

控制台打印了日志：

![4d52c6b74a215ee489314e6b2dcdaf0b.png][]

并且数据库也有了记录：

![3e1c97b42a8f07f1e89bfb8c4f008d51.png][]

代码到这里就结束了，当然我们还可以在日志记录表中添加接口名的路径、以及接口的调用链等信息。

# **往期推荐** #

*  [我写出这样干净的代码，老板直夸我][Link 1]
 *  [云南丽江旅游攻略][Link 2]
 *  [使用ThreadLocal怕内存泄漏？][ThreadLocal]
 *  [Java进阶之路思维导图][Java]
 *  [程序员必看书籍推荐][Link 3]
 *  [3万字的Java后端面试总结（附PDF）][3_Java_PDF]

扫码二维码，获取更多精彩。或微信搜**Lvshen\_9**，可后台回复获取资料

> 1.  `回复"java" 获取java电子书；`
> 2.  `回复"python"获取python电子书；`
> 3.  `回复"算法"获取算法电子书；`
> 4.  `回复"大数据"获取大数据电子书；`
> 5.  `回复"spring"获取SpringBoot的学习视频。`
> 6.  `回复"面试"获取一线大厂面试资料`
> 7.  `回复"进阶之路"获取Java进阶之路的思维导图`
> 8.  `回复"手册"获取阿里巴巴Java开发手册(嵩山终极版)`
> 9.  `回复"总结"获取Java后端面试经验总结PDF版`
> 10. `回复"Redis"获取Redis命令手册，和Redis专项面试习题（PDF）`
> 11. `回复"并发导图"获取Java并发编程思维导图（xmind终极版）`

另：点击【**我的福利**】有更多惊喜哦。

![format_png][]

[7aa02eb2ae1f477fd245cc949ddefa14.png]: /images/20221120/474417da9e6547aa9df5276e4e5ec1b0.png
[6f2473f0085d6c6b9a83a820cc2c8c11.png]: https://img-blog.csdnimg.cn/img_convert/6f2473f0085d6c6b9a83a820cc2c8c11.png
[517a5bc5bbe082072a0d783ecf33b646.png]: https://img-blog.csdnimg.cn/img_convert/517a5bc5bbe082072a0d783ecf33b646.png
[ba93f57e4a4e849a72386a5d899dc380.png]: https://img-blog.csdnimg.cn/img_convert/ba93f57e4a4e849a72386a5d899dc380.png
[4522781800e4a504bc8580ba9dbc39e8.png]: https://img-blog.csdnimg.cn/img_convert/4522781800e4a504bc8580ba9dbc39e8.png
[ec9465dfd26fc9610115bdbbb973c0df.png]: https://img-blog.csdnimg.cn/img_convert/ec9465dfd26fc9610115bdbbb973c0df.png
[4d52c6b74a215ee489314e6b2dcdaf0b.png]: https://img-blog.csdnimg.cn/img_convert/4d52c6b74a215ee489314e6b2dcdaf0b.png
[3e1c97b42a8f07f1e89bfb8c4f008d51.png]: https://img-blog.csdnimg.cn/img_convert/3e1c97b42a8f07f1e89bfb8c4f008d51.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=Mzg4NDMyNTIwMw==&mid=2247487966&idx=1&sn=7810bd4f62f2b92bec831db2e1f35b97&chksm=cfb8bfe2f8cf36f4295a3560fc8fde094bf73e8e187ff589c6559ae7ed38584d8c67c1c20330&scene=21#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=Mzg4NDMyNTIwMw==&mid=2247487391&idx=1&sn=5847806bce7a105d6503eab52ea725be&chksm=cfb8a1a3f8cf28b517b36ded4dc1ec97334b0a685e5deb6f75d9a668c96d3fbc0c058e5432d8&scene=21#wechat_redirect
[ThreadLocal]: http://mp.weixin.qq.com/s?__biz=Mzg4NDMyNTIwMw==&mid=2247486830&idx=1&sn=3aa8095371b2e04dc0c954443a890ef4&chksm=cfb8a352f8cf2a444a4c54d19a5e74b03879c03e79209a1f7688fd9edd81edb35b43fea9578d&scene=21#wechat_redirect
[Java]: http://mp.weixin.qq.com/s?__biz=Mzg4NDMyNTIwMw==&mid=2247486701&idx=2&sn=8b6c8da8802d4fceb4ad06c229af5391&chksm=cfb8a2d1f8cf2bc71415098ecc807dfcb6bcfdde399ec92f79ead84f0f4352a5fdb7cf766593&scene=21#wechat_redirect
[Link 3]: http://mp.weixin.qq.com/s?__biz=Mzg4NDMyNTIwMw==&mid=2247486232&idx=1&sn=ac1ba6a9f543f7115098f820a7b41165&chksm=cfb8a524f8cf2c326861c7a0783a6ada2ba7a3e76c633cb9632af99f32de64a984fef5ba8a75&scene=21#wechat_redirect
[3_Java_PDF]: http://mp.weixin.qq.com/s?__biz=Mzg4NDMyNTIwMw==&mid=2247488123&idx=1&sn=9567232df10afbfede9688e4762c988c&chksm=cfb8bc47f8cf35512bced50381acb94713b51bb8691e895ba880a2b7863d7c882f4b54aec190&scene=21#wechat_redirect
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy84MjJ5d2djOWRDS3M4TnVYVW12SHN2QVBFODZOQnB2TUQ2OGliY1QwV2NKVnRpYWVPMFd0MENkWnhwcklSVDVVYjdXTzJWMmljQzRPOEYwUW5pYURDT2RKWkEvNjQw?x-oss-process=image/format,png