在实际生产项目中，经常需要对如身份证信息、手机号、真实姓名等的敏感数据进行加密数据库存储，但在业务代码中对敏感信息进行手动加解密则十分不优雅，甚至会存在错加密、漏加密、业务人员需要知道实际的加密规则等的情况。

本文将介绍使用springboot+mybatis拦截器+自定义注解的形式对敏感数据进行存储前拦截加密的详细过程。

一、什么是Mybatis Plugin

在mybatis官方文档中，对于Mybatis plugin的的介绍是这样的：

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

//语句执行拦截
Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)// 参数获取、设置时进行拦截
ParameterHandler (getParameterObject, setParameters)// 对返回结果进行拦截
ResultSetHandler (handleResultSets, handleOutputParameters)//sql语句拦截
StatementHandler (prepare, parameterize, batch, update, query)

简而言之，即在执行sql的整个周期中，我们可以任意切入到某一点对sql的参数、sql执行结果集、sql语句本身等进行切面处理。基于这个特性，我们便可以使用其对我们需要进行加密的数据进行切面统一加密处理了（分页插件 pageHelper 就是这样实现数据库分页查询的）。

二、实现基于注解的敏感信息加解密拦截器

2.1 实现思路

对于数据的加密与解密，应当存在两个拦截器对数据进行拦截操作

参照官方文档，因此此处我们应当使用ParameterHandler拦截器对入参进行加密

使用ResultSetHandler拦截器对出参进行解密操作。目标需要加密、解密的字段可能需要灵活变更，此时我们定义一个注解，对需要加密的字段进行注解，那么便可以配合拦截器对需要的数据进行加密与解密操作了。

mybatis的interceptor接口有以下方法需要实现。

public interface Interceptor {//主要参数拦截方法Object intercept(Invocation invocation) throws Throwable;//mybatis插件链default Object plugin(Object target) {return Plugin.wrap(target, this);}//自定义插件配置文件方法default void setProperties(Properties properties) {}}

2.2 定义需要加密解密的敏感信息注解

定义注解敏感信息类（如实体类POJOPO）的注解

/*** 注解敏感信息类的注解*/
@Inherited
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface SensitiveData {
}

定义注解敏感信息类中敏感字段的注解

/*** 注解敏感信息类中敏感字段的注解*/
@Inherited
@Target({ ElementType.Field })
@Retention(RetentionPolicy.RUNTIME)
public @interface SensitiveField {
}

2.3 定义加密接口及其实现类

定义加密接口，方便以后拓展加密方法（如AES加密算法拓展支持PBE算法，只需要注入时指定一下便可）

public interface EncryptUtil {/*** 加密** @param declaredFields paramsObject所声明的字段* @param paramsObject   mapper中paramsType的实例* @return T* @throws IllegalAccessException 字段不可访问异常*/<T> T encrypt(Field[] declaredFields, T paramsObject) throws IllegalAccessException;
}

EncryptUtil 的AES加密实现类，此处AESUtil为自封装的AES加密工具，需要的小伙伴可以自行封装，本文不提供。（搜索公众号Java知音，回复“2021”，送你一份Java面试题宝典）

@Component
public class AESEncrypt implements EncryptUtil {@AutowiredAESUtil aesUtil;/*** 加密** @param declaredFields paramsObject所声明的字段* @param paramsObject   mapper中paramsType的实例* @return T* @throws IllegalAccessException 字段不可访问异常*/@Overridepublic <T> T encrypt(Field[] declaredFields, T paramsObject) throws IllegalAccessException {for (Field field : declaredFields) {//取出所有被EncryptDecryptField注解的字段SensitiveField sensitiveField = field.getAnnotation(SensitiveField.class);if (!Objects.isNull(sensitiveField)) {field.setAccessible(true);Object object = field.get(paramsObject);//暂时只实现String类型的加密if (object instanceof String) {String value = (String) object;//加密  这里我使用自定义的AES加密工具field.set(paramsObject, aesUtil.encrypt(value));}}}return paramsObject;}
}

2.4 实现入参加密拦截器

Myabtis包中的org.apache.ibatis.plugin.Interceptor拦截器接口要求我们实现以下三个方法

public interface Interceptor {//核心拦截逻辑Object intercept(Invocation invocation) throws Throwable;//拦截器链default Object plugin(Object target) {return Plugin.wrap(target, this);}//自定义配置文件操作default void setProperties(Properties properties) { }}

因此，参考官方文档的示例，我们自定义一个入参加密拦截器。

@Intercepts 注解开启拦截器，@Signature 注解定义拦截器的实际类型。

@Signature中

type 属性指定当前拦截器使用StatementHandler 、ResultSetHandler、ParameterHandler，Executor的一种 method 属性指定使用以上四种类型的具体方法（可进入class内部查看其方法）。args 属性指定预编译语句此处我们使用了 ParameterHandler.setParamters()方法，拦截mapper.xml中paramsType的实例（即在每个含有paramsType属性mapper语句中，都执行该拦截器，对paramsType的实例进行拦截处理）

/*** 加密拦截器* 注意@Component注解一定要加上** @author : tanzj* @date : 2020/1/19.*/
@Slf4j
@Component
@Intercepts({@Signature(type = ParameterHandler.class, method = "setParameters", args = PreparedStatement.class),
})
public class EncryptInterceptor implements Interceptor {private final EncryptDecryptUtil encryptUtil;@Autowiredpublic EncryptInterceptor(EncryptDecryptUtil encryptUtil) {this.encryptUtil = encryptUtil;}@Override@Overridepublic Object intercept(Invocation invocation) throws Throwable {//@Signature 指定了 type= parameterHandler 后，这里的 invocation.getTarget() 便是parameterHandler //若指定ResultSetHandler ，这里则能强转为ResultSetHandlerParameterHandler parameterHandler = (ParameterHandler) invocation.getTarget();// 获取参数对像，即 mapper 中 paramsType 的实例Field parameterField = parameterHandler.getClass().getDeclaredField("parameterObject");parameterField.setAccessible(true);//取出实例Object parameterObject = parameterField.get(parameterHandler);if (parameterObject != null) {Class<?> parameterObjectClass = parameterObject.getClass();//校验该实例的类是否被@SensitiveData所注解SensitiveData sensitiveData = AnnotationUtils.findAnnotation(parameterObjectClass, SensitiveData.class);if (Objects.nonNull(sensitiveData)) {//取出当前当前类所有字段，传入加密方法Field[] declaredFields = parameterObjectClass.getDeclaredFields();encryptUtil.encrypt(declaredFields, parameterObject);}}return invocation.proceed();}/*** 切记配置，否则当前拦截器不会加入拦截器链*/@Overridepublic Object plugin(Object o) {return Plugin.wrap(o, this);}//自定义配置写入，没有自定义配置的可以直接置空此方法@Overridepublic void setProperties(Properties properties) {}
}

至此完成自定义加密拦截加密。

2.5 定义解密接口及其实现类

解密接口，其中result为mapper.xml中resultType的实例。

public interface DecryptUtil {/*** 解密** @param result resultType的实例* @return T* @throws IllegalAccessException 字段不可访问异常*/<T> T decrypt(T result) throws IllegalAccessException;}

解密接口AES工具解密实现类

public class AESDecrypt implements DecryptUtil {@AutowiredAESUtil aesUtil;/*** 解密** @param result resultType的实例* @return T* @throws IllegalAccessException 字段不可访问异常*/@Overridepublic <T> T decrypt(T result) throws IllegalAccessException {//取出resultType的类Class<?> resultClass = result.getClass();Field[] declaredFields = resultClass.getDeclaredFields();for (Field field : declaredFields) {//取出所有被EncryptDecryptField注解的字段SensitiveField sensitiveField = field.getAnnotation(SensitiveField.class);if (!Objects.isNull(sensitiveField)) {field.setAccessible(true);Object object = field.get(result);//只支持String的解密if (object instanceof String) {String value = (String) object;//对注解的字段进行逐一解密field.set(result, aesUtil.decrypt(value));}}}return result;}
}

2.6 定义出参解密拦截器

@Slf4j
@Component
@Intercepts({@Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})
})
public class DecryptInterceptor implements Interceptor {@AutowiredDecryptUtil aesDecrypt;@Overridepublic Object intercept(Invocation invocation) throws Throwable {//取出查询的结果Object resultObject = invocation.proceed();if (Objects.isNull(resultObject)) {return null;}//基于selectListif (resultObject instanceof ArrayList) {ArrayList resultList = (ArrayList) resultObject;if (!CollectionUtils.isEmpty(resultList) && needToDecrypt(resultList.get(0))) {for (Object result : resultList) {//逐一解密aesDecrypt.decrypt(result);}}//基于selectOne} else {if (needToDecrypt(resultObject)) {aesDecrypt.decrypt(resultObject);}}return resultObject;}private boolean needToDecrypt(Object object) {Class<?> objectClass = object.getClass();SensitiveData sensitiveData = AnnotationUtils.findAnnotation(objectClass, SensitiveData.class);return Objects.nonNull(sensitiveData);}@Overridepublic Object plugin(Object target) {return Plugin.wrap(target, this);}@Overridepublic void setProperties(Properties properties) {}
}

至此完成解密拦截器的配置工作。

3、注解实体类中需要加解密的字段

此时在mapper中，指定paramType=User resultType=User 便可实现脱离业务层，基于mybatis拦截器的加解密操作。

END

往期推荐

未来，APP 就是一个人的全部

某位程序猿柬埔寨开发offer到手，薪资翻倍，去吗？网友：面向阎王编程...

利用“图文语音转文字”月赚一万+,一个正规易操作的小白轻松月入上万

在SpringBoot项目中，自定义注解+拦截器优雅的实现敏感数据的加解密！相关推荐

springboot项目中自定义注解的使用总结、java自定义注解实战（常用注解DEMO）
初学spring的时候使用注解总觉得使用注解很神奇,加一个注解就能实现想要的功能,很好奇,也想自己根据需要写一些自己实现的自定义注解.问题来了,自定义注解到底是什么?肯定会有人和我一样有这个疑惑,我根 ...
springboot 自定义注解拦截器
springboot 自定义注解拦截器最近在工作中,发现自定义注解拦截使用起来特别方便,现在来写出来给大家看看环境springboot 首先写一个自定义注解 package com.study.c ...
自定义注解+拦截器优化项目代码
自定义注解+拦截器的优势类似用户权限或者接口限流的需求,但并不是所有操作或者接口需要.可以使用过滤器或者拦截器,但这样就必须在配置文件里加上所有方法或者使用通配符. 所以可以采用一种比较简单灵活的方 ...
根据自动装配原理在Springboot项目中自定义starter，并实现热插拔技术，自定义@enable
根据自动装配原理在Springboot项目中自定义starter,并实现热插拔技术自定义starter 简单步骤使用测试优化(热插拔技术) 自定义starter 简单步骤创建项目,并引入aut ...
vue项目中 axios请求拦截器与取消pending请求功能 - 年少、 - 博客园
在开发vue项目中,请求是不可缺少的,在发送请求时常常需要统一处理一些请求头参数等设置与响应事件,这时利用请求拦截器再好不过. 这里以axios请求为例实现了设置统一请求头添加token, 其中to ...
springboot项目中的注解启动项目的方式解决spring的bean.xml配置不生效 spring的基础JDBC配置
依赖创建一个 Spring Boot 工程时,可以继承自一个 spring-boot-starter-parent ,也可以不继承先来看 parent 的基本功能有哪些? 定义了 Java 编译版 ...
springboot项目使用swagger时拦截器需要放开哪些URL
1.如果不设置会导致swagger主页无法访问 2.以下url不需要拦截 /swagger-resources/*, /swagger-ui.html,/v2/api-docs, /webjars/s ...
第六章：如何在SpringBoot项目中使用拦截器
拦截器对使用SpringMvc.Struts的开发人员来说特别熟悉,因为你只要想去做好一个项目必然会用到它.拦截器在我们平时的项目中用处有很多,如:日志记录(我们后续章节会讲到).用户登录状态拦截.安 ...
谈谈 Java 中自定义注解及使用场景
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章作者:快给我饭吃 www.jianshu.com/p/a7bedc ...

在SpringBoot项目中，自定义注解+拦截器优雅的实现敏感数据的加解密！