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 SpringBoot+vue+实战项目详解

    Java SpringBoot+vue+实战项目详解

    这篇文章主要介绍了SpringBoot+VUE实现前后端分离的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-09-09
  • 23种设计模式(12)java模版方法模式

    23种设计模式(12)java模版方法模式

    这篇文章主要为大家详细介绍了23种设计模式之java模版方法模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • MyBatis-Plus自动填充字段的详细教程

    MyBatis-Plus自动填充字段的详细教程

    今天编写一个详细的教程来介绍如何在 Spring Boot 项目中使用 MyBatis-Plus 实现自动填充时间字段(如创建时间 createTime 和更新时间 updateTime),可以分为以下几个部分,这个教程将涵盖从项目配置到自动填充的完整过程,需要的朋友可以参考下
    2024-08-08
  • 基于idea把springboot项目部署到docker

    基于idea把springboot项目部署到docker

    这篇文章主要介绍了基于idea把springboot项目部署到docker,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • 详解Java后端优雅验证参数合法性

    详解Java后端优雅验证参数合法性

    这篇文章主要介绍了详解Java后端优雅验证参数合法性,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-02-02
  • Arrays.asList方法总结

    Arrays.asList方法总结

    本文主要对Arrays.asList方法进行总结。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-02-02
  • Java中MapStruct使用方法解析

    Java中MapStruct使用方法解析

    这篇文章主要介绍了Java中MapStruct使用方法解析,接受请求参数都会使用一个vo类,这个vo类里封装了所有需要接受的参数,然后对参数进行业务逻辑处理,处理完后会持久化处理, 使用MapStruct可以快速帮你解决转换工作,需要的朋友可以参考下
    2023-10-10
  • Jlabel实现内容自动换行简单实例

    Jlabel实现内容自动换行简单实例

    这篇文章主要介绍了Jlabel实现内容自动换行简单实例,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • Java代理模式实例详解【静态代理与动态代理】

    Java代理模式实例详解【静态代理与动态代理】

    这篇文章主要介绍了Java代理模式,结合实例形式详细分析了java静态代理与动态代理模式相关概念、原理、操作技巧与注意事项,需要的朋友可以参考下
    2019-09-09
  • SpringBoot多表联查(测试可用)

    SpringBoot多表联查(测试可用)

    这篇文章主要介绍了SpringBoot多表联查(测试可用)的相关资料,需要的朋友可以参考下
    2017-09-09

最新评论