【mybatis 拦截器在实际开发中的运用】

149 阅读2分钟

实际开发中经常遇到数据更新了忘记修改更新时间,并且测试也很容易忽略测试更新时间。直到有一天排查生成环境数据问题,发现更新数据一直没有被更新。因此更新时间是非常重要也是容易被忽略的。我们可以在框架中添加拦截器,拦截update语句更新 UpdateTime字段

要实现拦截 update 语句并自动更新 UpdateTimeUpdateUser 字段,可以使用 MyBatis 的拦截器机制来实现。

首先,创建一个实现了 Interceptor 接口的拦截器类,例如 UpdateInterceptor。在该类中,你可以实现 intercept 方法来拦截 update 语句,并进行相应的处理。

下面是一个示例:

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;

import java.lang.reflect.Field;
import java.util.Date;
import java.util.Properties;

@Intercepts({
    @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})
public class UpdateInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object[] args = invocation.getArgs();
        MappedStatement ms = (MappedStatement) args[0];
        Object parameter = args[1];

        if (parameter != null) {
            Class<?> parameterClass = parameter.getClass();
            Field updateTimeField = null;
            Field updateUserField = null;

            try {
                updateTimeField = parameterClass.getDeclaredField("updateTime");
                updateUserField = parameterClass.getDeclaredField("updateUser");
            } catch (NoSuchFieldException ignored) {
                // 忽略字段不存在的情况
            }

            if (updateTimeField != null) {
                updateTimeField.setAccessible(true);
                updateTimeField.set(parameter, new Date());
            }

            if (updateUserField != null) {
                updateUserField.setAccessible(true);
                updateUserField.set(parameter, "admin");
            }
        }

        return invocation.proceed();
    }

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

    @Override
    public void setProperties(Properties properties) {
        // 可以在这里进行一些初始化操作,读取配置参数等
    }
}

在上述示例中,我们通过 @Intercepts 注解指定拦截的方法,这里拦截了 Executor 接口的 update 方法。在 intercept 方法中,我们获取到执行的 MappedStatement 和参数对象 parameter。然后,判断参数对象是否为 null,并尝试获取 updateTimeupdateUser 字段。如果字段存在,我们将其设置为当前时间和指定的更新用户(这里假设为 "admin")。最后,通过 invocation.proceed() 方法继续执行原始的 update 方法。

在 MyBatis 的配置文件中,需要注册这个拦截器。例如,在 mybatis-config.xml 文件中添加以下配置:

<configuration>
    <!-- 其他配置项 -->
    <plugins>
        <plugin interceptor="com.example.UpdateInterceptor" />
    </plugins>
</configuration>

注意,需要将 com.example.UpdateInterceptor 替换为实际的拦截器类的完整路径。

通过以上步骤,我们就可以实现拦截 update 语句并自动更新 UpdateTimeUpdateUser 字段。在执行 update 操作时,拦截器会自动设置这两个字段的值。