AOP+MybatisPlus 优化特殊的日志模块

最新推荐文章于 2025-03-04 19:24:35 发布

2401_85262617

最新推荐文章于 2025-03-04 19:24:35 发布

阅读量1k

点赞数 16

文章标签： java oracle 开发语言

本文链接：https://blog.youkuaiyun.com/2401_85262617/article/details/140608887

版权

简单思考

我们可以发现这些这些东西和业务无关，可以直接用 AOP 来实现，老项目中也是用了 AOP。（听君一席话，听君一席话哈哈哈 🤣）

先简单思考下会遇到什么问题 👇

比如：

新增数据到相应的 log 表，意味着有很多简单的插入语句要写？还要考虑批量操作 🐖
操作id 是怎么生成的？是直接用 uuid ，还是数据库自增id？
怎么获取删除前的数据信息、更新后的数据、插入后的数据等

这里就不卖关子啦直接来看这个日志模块的设计。

操作ID

先来看这个 操作 ID 的生成，这里就没啥特别的直接定义一个注解如 @GenerateRequestID ，加在需要被拦截的方法上，然后我们在 AOP 中拦截它即可。功能如下 👇

image

可以看到这个操作ID 是直接使用 Oracle 的 Sequence 去生成的，是有序的，能直接看出这批数据操作的先后顺序。

在增强这部分功能时，我发现之前 旧版本居然没用 AOP 去设置这个操作ID，而是手动在需要的地方加，而且还定义了很多的 Key 来存储生成的这个操作ID，可以发现对这个 ThreadLocal 也很不熟悉呀！🙃

伪代码如下 😱 （坏代码 …… ）

public void a() {

BigDecimal transactionId = sysLogMapper.generateTransactionId();

ThreadLocalUtil.setValue(SysLogConstants.xxx_LOG_TRANSACTION_ID, transactionId);

ThreadLocalUtil.setValue(SysLogConstants.aaa_LOG_TRANSACTION_ID, transactionId);

// 业务方法

ThreadLocalUtil.remove(SysLogConstants.xxx_LOG_TRANSACTION_ID);

ThreadLocalUtil.remove(SysLogConstants.aaa_LOG_TRANSACTION_ID);

}

心细的小伙伴会不会有个小疑问，为什么我是在 请求结束 时才去清除这个操作ID，而不是在 AOP 的 After 操作中去做的😄

其实这里是有个小插曲的，一开始我是在 AOP 的 @After 操作中去删除这个操作ID 的，但是呢 🙄 ，有同事将我改好的日志模块中的部分功能添加到之前的老项目中，而且他直接将这个注解加在 service上，结果系统出现了bug 🙄，还把我拉过去讨论 😒 ，这就很无语了……

image

不过这个 bug 是不难发现的，毕竟这个注解如果加在 service 层面，会存在 service 调用 service 的情况，这样不仅会出现第一个 service 中生成的 操作ID 被第二个 service 覆盖，而且在第二个 service 结束后，操作ID 会被清除掉，但是这个字段是不允许为 null 的，所以就报错了。

按理说，直接加在这个 controller 层面就没问题了，但是讨论过后，在同事的建议下，我也同意对它进行小小的升级下，将这个 清除操作ID 的行为移动到这个 拦截器 中 👇

@Component

public class ThreadLocalInterceptor implements HandlerInterceptor {

@Override

public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

ThreadLocalUtil.clear();

}

感觉这种方式也挺简洁的，在请求结束后直接清掉这个 ThreadLocal 中的内容。🐖

整体设计

接着，我们来看看这个 datalog 的生成。新版的整体思路如下。😋 （画出来清晰多了）

2021-11-12_140557

删除操作

思路如上图~

在删除成功时，要将被删除的数据写到 Log 表 …… 😑

这里有两种情况：（一）根据主键删除，这种最简单，我们直接根据主键查出之前的数据即可。（二）根据其他条件删除，这里我们自定义获取主键的方法以便复用上面的方法。

这里就不得不提下这个 MybatisPlus 的好处了~ ，借用 BaseMapper 的 selectBatchIds 方法，我们可以很轻松的

查询出这些数据出来。

image-20211112142253855

因为在使用 MybatisPlus 时，我们会生成相应的 Mapper 方法，而这里就很好地体现了 Java 多态 的特点，我们只需要调用 (BaseMapper) SpringUtil.getBean(XXXMapper.class).selectBatchIds(result) ；即可实现。😄

所以将这个参数挂在 @MethodLog 注解上即可。

@Mapper

public interface XXXMapper extends BaseMapper {

}

而在旧版本中，由于没有用到 MybatisPlus ，自然写了很多的删除语句 😱

而且由于对这个 Spring 的理解不够，出现了把实现了同一个接口的不同子类注入到一个Map中，使用时再从其中获取的行为，最要命的是，这个 map 的key 不是那些子类的名称，还写了很多 switch case …… 😶 来获取