在项目中,我们会需要获取接口的操作日志。比如获取接口的接口名、操作人,接口运行时间、所属的服务、接口的类型(增删改查)等等。初级的做法是在接口方法执行完后将这些操作记录存入库中,这段代码写在接口中,但是这样违反了设计原则中的单一职责原则。常用的做法是使用AOP来做,在运行时动态的插入日志记录的代码。这里我是用注解来做。
创建日志记录表首先我们来创建日志记录表:
operation表
当然后编写实体类:
编写日志记录注解我们先定义一个注解OperationLog
这个注解里面定义了几个参数:
“opType:业务类型
opBusinessName:业务名称,例如会员服务、订单服务等等
opBusinessId:业务来源ID,一般为主键ID
”定义业务类型类OperationType
这个业务类型类定义了接口的类型:增删改查。
接下来我们编写切面类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);}整体代码如下:
测试注解测试注解代码如下:
@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。
启动代码运行接口:
控制台打印了日志:
并且数据库也有了记录:
代码到这里就结束了,当然我们还可以在日志记录表中添加接口名的路径、以及接口的调用链等信息。
往期推荐我写出这样干净的代码,老板直夸我
云南丽江旅游攻略
使用ThreadLocal怕内存泄漏?
Java进阶之路思维导图
程序员必看书籍推荐
3万字的Java后端面试总结(附PDF)
扫码二维码,获取更多精彩。或微信搜Lvshen_9,可后台回复获取资料
回复"java" 获取java电子书;
回复"python"获取python电子书;
回复"算法"获取算法电子书;
回复"大数据"获取大数据电子书;
回复"spring"获取SpringBoot的学习视频。
回复"面试"获取一线大厂面试资料
回复"进阶之路"获取Java进阶之路的思维导图
回复"手册"获取阿里巴巴Java开发手册(嵩山终极版)
回复"总结"获取Java后端面试经验总结PDF版
回复"Redis"获取Redis命令手册,和Redis专项面试习题(PDF)
回复"并发导图"获取Java并发编程思维导图(xmind终极版)
另:点击【我的福利】有更多惊喜哦。