mybatis-使用拦截器实现审计功能

最新推荐文章于 2024-11-25 17:36:25 发布

原创最新推荐文章于 2024-11-25 17:36:25 发布 · 2.6k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis

服务器专栏收录该内容

57 篇文章

订阅专栏

本文介绍了如何利用MyBatis拦截器自动赋值业务表中的创建人、创建时间、修改人和修改时间等审计字段，避免在主业务逻辑中手动设置，简化代码。通过使用SpringData的审计注解和自定义拦截器，可以在插入和更新操作时自动填充这些信息，减少编码工作量。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

后台开发中，一般的业务表都有创建人，创建时间，修改人，修改时间等业务字段，这些业务字段的值没有特别的逻辑，只是对当时的操作人和操作时间的一个记录。如果每个表格的增删改查，都去修改的这些值的话，难免会影响主业务逻辑的阅读。那么有没有一个统计的方法，自动地去赋予这些值，而不用在业务代码上进行干预呢？

JPA也提供了类似的审计功能。

拦截器

思路就是使用mybatis拦截器，每次和数据库通信前，在拦截器中自动赋予这些值。

使用注解标记字段

spring data中定义几个注解，来表明一个字段是需要审计的，它们是：

@CreatedDate：创建时间
@LastModifiedDate：最后更新时间
@CreatedBy：创建人信息
@LastModifiedBy：最后更新人信息

拦截器的逻辑

@Slf4j
@Component
@Intercepts({@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})})
public class AuditingInterceptor implements Interceptor {
    private final String param1 = "param1";	//参数为map时，有param1这个键，具体原因不知道。

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();

		//找到数据表对应的PO
        Object parameter = invocation.getArgs()[1];
        Object po = null;
        if (parameter instanceof Map) {
            Map map = (Map) parameter;
            if (map.containsKey(param1)) {
                po = map.get(param1);
            }
        } else {
            po = parameter;
        }

        if (po == null) {
            return invocation.proceed();
        }

		//当前时间和操作人
        LocalDateTime currentDate = LocalDateTime.now();
        String currentUser = Optional.ofNullable(ShiroUtils.getSecurityUser()).map(SecurityUserPo::getUserName).orElse(null);

		//遍历PO的字段，查找并修改其中被审计字段的值
        Field[] fields = po.getClass().getDeclaredFields();
        if (SqlCommandType.INSERT == sqlCommandType || SqlCommandType.UPDATE == sqlCommandType) {
            for (Field field : fields) {
                boolean accessible = field.isAccessible();
                field.setAccessible(true);
                if (AnnotationUtils.getAnnotation(field, CreatedBy.class) != null && SqlCommandType.INSERT == sqlCommandType && currentUser != null) {
                    field.set(po, currentUser);
                }
                if (AnnotationUtils.getAnnotation(field, CreatedDate.class) != null && SqlCommandType.INSERT == sqlCommandType) {
                    field.set(po, currentDate);
                }
                if (AnnotationUtils.getAnnotation(field, LastModifiedBy.class) != null && currentUser != null) {
                    field.set(po, currentUser);
                }
                if (AnnotationUtils.getAnnotation(field, LastModifiedDate.class) != null) {
                    field.set(po, currentDate);
                }
                field.setAccessible(accessible);
            }
        }

        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        if (target instanceof Executor) {
            return Plugin.wrap(target, this);
        } else {
            return target;
        }
    }

}