mybatis插件优雅实现字段加密的示例代码

 更新时间:2023年11月29日 15:06:06   作者:湫qiu  
在很多时候,我们都需要字段加密,比如邮箱,密码,电话号码等,本文主要介绍了mybatis插件优雅实现字段加密的示例代码,感兴趣的可以了解一下

在很多时候,我们都需要字段加密。比如邮箱,密码,电话号码等。通常的项目可能会在插入数据前手动加密,今天给大家带来一个更优雅的做法——通过注解实现。

mybatis的接入点

Mybatis本质上是对JDBC执行流程的封装。简要概括下Mybatis这几个可被代理类的职能。

  • 【**Executor**】: 真正执行SQL语句的对象,调用sqlSession的方法时,本质上都是调用executor的方法,还负责获取connection,创建StatementHandler。
  • 【**StatementHandler**】: 创建并持有ParameterHandler和ResultSetHandler对象,操作JDBC的statement与进行数据库操作。
  • 【**ParameterHandler**】: 处理入参,将Java方法上的参数设置到被执行语句中。
  • 【**ResultSetHandler**】: 处理SQL语句的执行结果,将返回值转换为Java对象。

如何接入自己写的插件

@Intercepts({@Signature(type = 代理的插件类, method = 类中的方法名, args = {方法参数})})
public class MyInterceptor implements Interceptor {
    Object intercept(Invocation invocation) throws Throwable{
        //invocation就是你要代理的方法。
        //在这里写主要的逻辑操作
        //todo
    }

    default Object plugin(Object target) {
        //是用来生成代理的
        //一般不重写
        return Plugin.wrap(target, this);
      }

      default void setProperties(Properties properties) {
        // NOP
      }
}

talk is cheap,show me the code

加密

@Intercepts({@Signature(type = ParameterHandler.class, method = "setParameters", args = {PreparedStatement.class})})
public class MybatisEncryptInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        return invocation;
    }
    @Override
    public Object plugin(Object target) {
        if (target instanceof ParameterHandler) {
            ParameterHandler parameterHandler = (ParameterHandler) target;
            Object parameterObject = parameterHandler.getParameterObject();
            // 进行加密操作
        }
        return target;
    }
    @Override
    public void setProperties(Properties properties) {
    }
}

选择了在ParameterHandler#setParameters方法进行加密。这时就有人会问了为什么不在intercept方法改变参数呢?

我们看一下Invocation类

public class Invocation {
  private final Object target;
  private final Method method;
  private final Object[] args;
  ...
}

我们注意到三个变量都是用fianl修饰的,我们不能改变他们的值。所以我们在plugin方法进行加密操作。

解密

有加密就有解密

@Intercepts({@Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})})
public class MybatisDecryptInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 获取执行mysql执行结果
        Object result = invocation.proceed();
        if (result == null) {
            return null;
        }
        //解密result
        return result;
    }
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

选择了在ResultSetHandler#handleResultSets方法进行加密,ibatis起名确实不错,一看方法名就知道干什么了。

取消加解密

有些特定的场合我们不希望加解密,但是大部分时候又需要加解密,这种情况的话我们就用不了了吗?难道只能手动编码吗qwq。
我以pagehelper为灵感写了一个EncryptHelper。

让我们看看核心逻辑

@Intercepts({@Signature(type = Executor.class,method = "flushStatements",args = {})})
public class MybatisClearInterceptor implements Interceptor {
    public Object intercept(Invocation invocation) throws Throwable {
        Object result = invocation.proceed();
        if(EncryptHelper.hasSituation()){
            log.info("EncryptClear!!!");
        }
        EncryptHelper.clearEncrypt();
        return result;
    }
    @Override
    public Object plugin(Object target) {
        // 包装目标对象,创建代理对象
        return Plugin.wrap(target, this);
    }
    @Override
    public void setProperties(Properties properties) {
    }
}

在这里我们每次执行sql后就调用 EncryptHelper.clearEncrypt();方法。在EncryptHelper中存放ThreadLocal<EncryptSituation>,加解密时可以根据EncryptHelper中的LOCAL_ENCRYPT判断是否加解密。在执行完一次sql后自动清除。当然你也可以手动管理不启用这个ClearInterceptor。

public class EncryptHelper implements AutoCloseable {
    private static final ThreadLocal<EncryptSituation> LOCAL_ENCRYPT=new ThreadLocal<>();
    //操作
}

总结

其中还有一些问题,比如MybatisClearInterceptor会和pagehelper不兼容因为分页查询前会查询总数据量这里会有两个sql,需要更加复杂的判断。
有些同学会问为什么不在MybatisEncryptInterceptor和MybatisDecryptInterceptor里管理EncryptHelper,而是多写一个MybatisClearInterceptor?有这种疑问的同学可以自己试一试,会发现神奇的事情,我也是试了好久。

到此这篇关于mybatis插件优雅实现字段加密的示例代码的文章就介绍到这了,更多相关mybatis 字段加密内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java heap space OOM 精准定位与体系化排查方案详解

    Java heap space OOM 精准定位与体系化排查方案详解

    精准定位Java堆内存溢出(OOM)需要结合监控、JVM参数、内存快照和可视化工具,本文介绍Java heap space OOM 精准定位与体系化排查方案,感兴趣的朋友一起看看吧
    2026-04-04
  • Java中关键字synchronized的使用方法详解

    Java中关键字synchronized的使用方法详解

    synchronized关键字可以作为函数的修饰符,也可作为函数内的语句,也就是平时说的同步方法和同步语句块,下面这篇文章主要给大家介绍了关于Java中synchronized使用的相关资料,需要的朋友可以参考下
    2021-08-08
  • java8列表中通过stream流根据对象属性去重的三种方式

    java8列表中通过stream流根据对象属性去重的三种方式

    这篇文章主要介绍了java8列表中通过stream流根据对象属性去重的三种方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Java中基于物理属性和内容校验比较两个文件是否一致

    Java中基于物理属性和内容校验比较两个文件是否一致

    这篇文章主要介绍了Java中基于物理属性和内容校验比较两个文件是否一致,当一个文件经过哈希函数处理后,会得到一个唯一代表其内容的哈希值,如果这个文件被篡改,哈希值也会发生改变,通过比较文件的哈希值,可以轻松地验证文件的完整性和一致性,需要的朋友可以参考下
    2025-10-10
  • SpringBoot高版本修改为低版本时测试类报错的解决方案

    SpringBoot高版本修改为低版本时测试类报错的解决方案

    这篇文章主要介绍了SpringBoot高版本修改为低版本时测试类报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • lombok @Accessors用法详解

    lombok @Accessors用法详解

    这篇文章主要介绍了lombok @Accessors用法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • java实现简单发送邮件功能

    java实现简单发送邮件功能

    这篇文章主要为大家详细介绍了java实现简单发送邮件功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-04-04
  • Springboot整合分页插件PageHelper步骤解析

    Springboot整合分页插件PageHelper步骤解析

    这篇文章主要介绍了Springboot整合分页插件PageHelper步骤解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • SpringBoot实现quartz定时任务可视化管理功能

    SpringBoot实现quartz定时任务可视化管理功能

    这篇文章主要介绍了SpringBoot实现quartz定时任务可视化管理功能,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • 在idea中显示springboot面板的方法

    在idea中显示springboot面板的方法

    这篇文章主要介绍了在idea中显示springboot面板的方法方便启动调试,本文通过代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11

最新评论