一、背景
用戶的一些敏感數(shù)據(jù)，例如手機號、郵箱、身份證等信息，在數(shù)據(jù)庫以明文存儲時會存在數(shù)據(jù)泄露的風(fēng)險，因此需要進行加密， 但存儲數(shù)據(jù)再被取出時，需要進行解密，因此加密算法需要使用對稱加密算法。
常用的對稱加密算法有AES、DES、RC、BASE64等等，各算法的區(qū)別與優(yōu)劣請自行百度。
本案例采用AES算法對數(shù)據(jù)進行加密。
![mybatisplus 加密,[拓維]云架構(gòu),Java基礎(chǔ),數(shù)據(jù)加密,Mybatis-Plus攔截器,對稱加密](https://imgs.yssmx.com/Uploads/2023/07/600957-1.png)
?
???????
二、MybatisPlus攔截器介紹
本文基于SpringBoot+MybatisPlus（3.5.X）+MySQL8架構(gòu)，Dao層與DB中間使用MP的攔截器機制，對數(shù)據(jù)存取過程進行攔截，實現(xiàn)數(shù)據(jù)的加解密操作。
三、使用方法
該加解密攔截器功能在wutong-base-dao包（公司內(nèi)部包）已經(jīng)實現(xiàn)，如果您的項目已經(jīng)依賴了base-dao，就可以直接使用。
另外，在碼云上有Demo案例，見:?mybatis-plus加解密Demo
基于wutong-base-dao包的使用步驟如下。
1、添加wutong-base-dao依賴
<dependency>
<groupId>com.talkweb</groupId>
<artifactId>wutong-base-dao</artifactId>
<version>請使用最新版本</version>
</dependency>
2、在yaml配置開關(guān)，啟用加解密
mybatis-plus:
wutong:
encrypt:
# 是否開啟敏感數(shù)據(jù)加解密，默認false
enable: true
# AES加密秘鑰，可以使用hutool的SecureUtil工具類生成
secretKey: yourSecretKey
3、定義PO類
實體類上使用自定義注解，來標(biāo)記需要進行加解密
// 必須使用@EncryptedTable注解
@EncryptedTable
@TableName(value = "wsp_user")
public class UserEntity implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Long id;
private String name;
// 使用@EncryptedColumn注解
@EncryptedColumn
private String mobile;
// 使用@EncryptedColumn注解
@EncryptedColumn
private String email;
}
4、定義API接口
通過MP自帶API、Lambda、自定義mapper接口三種方式進行測試
/**
* 用戶表控制器
*
* @author wangshaopeng@talkweb.com.cn
* @Date 2023-01-11
*/
@RestController
@RequestMapping("/user")
public class UserController {
@Resource(name = "userServiceImpl")
private IUserService userService;
@Resource(name = "userXmlServiceImpl")
private IUserService userXmlService;
/**
* 測試解密
*/
@GetMapping(name = "測試解密", value = "/detail")
public UserEntity detail(Long id) {
// 測試MP API
// UserEntity entity = userService.getById(id);
// 測試自定義Mapper接口
UserEntity entity = userXmlService.getById(id);
if (null == entity) {
return new UserEntity();
}
return entity;
}
/**
* 新增用戶表，測試加密
*/
@GetMapping(name = "新增用戶表，測試加密", value = "/add")
public UserEntity add(UserEntity entity) {
// 測試MP API
// userService.save(entity);
// 測試自定義Mapper接口
userXmlService.save(entity);
return entity;
}
/**
* 修改用戶表
*/
@GetMapping(name = "修改用戶表", value = "/update")
public UserEntity update(UserEntity entity) {
// 測試MP API
// userService.updateById(entity);
// 測試Lambda
// LambdaUpdateWrapper<UserEntity> wrapper = new LambdaUpdateWrapper<>();
// wrapper.eq(UserEntity::getId, entity.getId());
// wrapper.set(UserEntity::getMobile, entity.getMobile());
// wrapper.set(UserEntity::getName, entity.getName());
// wrapper.set(UserEntity::getEmail, entity.getEmail());
// userService.update(wrapper);
// 測試自定義Mapper接口
userXmlService.updateById(entity);
return entity;
}
}
四、實現(xiàn)原理
1、自定義注解
根據(jù)注解進行數(shù)據(jù)攔截
/**
* 需要加解密的實體類用這個注解
* @author wangshaopeng@talkweb.com.cn
* @Date 2023-05-31
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface EncryptedTable {
}
/**
* 需要加解密的字段用這個注解
* @author wangshaopeng@talkweb.com.cn
* @Date 2023-05-31
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface EncryptedColumn {
}
2、定義攔截器
加密攔截器EncryptInterceptor
/**
* 加密攔截器
*
* @author wangshaopeng@talkweb.com.cn
* @Date 2023-05-31
*/
public class EncryptInterceptor extends JsqlParserSupport implements InnerInterceptor {
/**
* 變量占位符正則
*/
private static final Pattern PARAM_PAIRS_RE = Pattern.compile("#\\{ew\\.paramNameValuePairs\\.(" + Constants.WRAPPER_PARAM + "\\d+)\\}");
/**
* 如果查詢條件是加密數(shù)據(jù)列，那么要將查詢條件進行數(shù)據(jù)加密。
* 例如，手機號加密存儲后，按手機號查詢時，先把要查詢的手機號進行加密，再和數(shù)據(jù)庫存儲的加密數(shù)據(jù)進行匹配
*/
@Override
public void beforeQuery(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
if (Objects.isNull(parameterObject)) {
return;
}
if (!(parameterObject instanceof Map)) {
return;
}
Map paramMap = (Map) parameterObject;
// 參數(shù)去重，否則多次加密會導(dǎo)致查詢失敗
Set set = (Set) paramMap.values().stream().collect(Collectors.toSet());
for (Object param : set) {
/**
* 僅支持類型是自定義Entity的參數(shù)，不支持mapper的參數(shù)是QueryWrapper、String等，例如：
*
* 支持：findList(@Param(value = "query") UserEntity query);
* 支持：findPage(@Param(value = "query") UserEntity query, Page<UserEntity> page);
*
* 不支持：findOne(@Param(value = "mobile") String mobile);
* 不支持：findList(QueryWrapper wrapper);
*/
if (param instanceof AbstractWrapper || param instanceof String) {
// Wrapper、String類型查詢參數(shù)，無法獲取參數(shù)變量上的注解，無法確認是否需要加密，因此不做判斷
continue;
}
if (annotateWithEncrypt(param.getClass())) {
encryptEntity(param);
}
}
}
/**
* 新增、更新數(shù)據(jù)時，如果包含隱私數(shù)據(jù)，則進行加密
*/
@Override
public void beforeUpdate(Executor executor, MappedStatement mappedStatement, Object parameterObject) throws SQLException {
if (Objects.isNull(parameterObject)) {
return;
}
// 通過MybatisPlus自帶API（save、insert等）新增數(shù)據(jù)庫時
if (!(parameterObject instanceof Map)) {
if (annotateWithEncrypt(parameterObject.getClass())) {
encryptEntity(parameterObject);
}
return;
}
Map paramMap = (Map) parameterObject;
Object param;
// 通過MybatisPlus自帶API（update、updateById等）修改數(shù)據(jù)庫時
if (paramMap.containsKey(Constants.ENTITY) && null != (param = paramMap.get(Constants.ENTITY))) {
if (annotateWithEncrypt(param.getClass())) {
encryptEntity(param);
}
return;
}
// 通過在mapper.xml中自定義API修改數(shù)據(jù)庫時
if (paramMap.containsKey("entity") && null != (param = paramMap.get("entity"))) {
if (annotateWithEncrypt(param.getClass())) {
encryptEntity(param);
}
return;
}
// 通過UpdateWrapper、LambdaUpdateWrapper修改數(shù)據(jù)庫時
if (paramMap.containsKey(Constants.WRAPPER) && null != (param = paramMap.get(Constants.WRAPPER))) {
if (param instanceof Update && param instanceof AbstractWrapper) {
Class<?> entityClass = mappedStatement.getParameterMap().getType();
if (annotateWithEncrypt(entityClass)) {
encryptWrapper(entityClass, param);
}
}
return;
}
}
/**
* 校驗該實例的類是否被@EncryptedTable所注解
*/
private boolean annotateWithEncrypt(Class<?> objectClass) {
EncryptedTable sensitiveData = AnnotationUtils.findAnnotation(objectClass, EncryptedTable.class);
return Objects.nonNull(sensitiveData);
}
/**
* 通過API（save、updateById等）修改數(shù)據(jù)庫時
*
* @param parameter
*/
private void encryptEntity(Object parameter) {
//取出parameterType的類
Class<?> resultClass = parameter.getClass();
Field[] declaredFields = resultClass.getDeclaredFields();
for (Field field : declaredFields) {
//取出所有被EncryptedColumn注解的字段
EncryptedColumn sensitiveField = field.getAnnotation(EncryptedColumn.class);
if (!Objects.isNull(sensitiveField)) {
field.setAccessible(true);
Object object = null;
try {
object = field.get(parameter);
} catch (IllegalAccessException e) {
continue;
}
//只支持String的解密
if (object instanceof String) {
String value = (String) object;
//對注解的字段進行逐一加密
try {
field.set(parameter, AESUtils.encrypt(value));
} catch (IllegalAccessException e) {
continue;
}
}
}
}
}
/**
* 通過UpdateWrapper、LambdaUpdateWrapper修改數(shù)據(jù)庫時
*
* @param entityClass
* @param ewParam
*/
private void encryptWrapper(Class<?> entityClass, Object ewParam) {
AbstractWrapper updateWrapper = (AbstractWrapper) ewParam;
String sqlSet = updateWrapper.getSqlSet();
String[] elArr = sqlSet.split(",");
Map<String, String> propMap = new HashMap<>(elArr.length);
Arrays.stream(elArr).forEach(el -> {
String[] elPart = el.split("=");
propMap.put(elPart[0], elPart[1]);
});
//取出parameterType的類
Field[] declaredFields = entityClass.getDeclaredFields();
for (Field field : declaredFields) {
//取出所有被EncryptedColumn注解的字段
EncryptedColumn sensitiveField = field.getAnnotation(EncryptedColumn.class);
if (Objects.isNull(sensitiveField)) {
continue;
}
String el = propMap.get(field.getName());
Matcher matcher = PARAM_PAIRS_RE.matcher(el);
if (matcher.matches()) {
String valueKey = matcher.group(1);
Object value = updateWrapper.getParamNameValuePairs().get(valueKey);
updateWrapper.getParamNameValuePairs().put(valueKey, AESUtils.encrypt(value.toString()));
}
}
Method[] declaredMethods = entityClass.getDeclaredMethods();
for (Method method : declaredMethods) {
//取出所有被EncryptedColumn注解的字段
EncryptedColumn sensitiveField = method.getAnnotation(EncryptedColumn.class);
if (Objects.isNull(sensitiveField)) {
continue;
}
String el = propMap.get(method.getName());
Matcher matcher = PARAM_PAIRS_RE.matcher(el);
if (matcher.matches()) {
String valueKey = matcher.group(1);
Object value = updateWrapper.getParamNameValuePairs().get(valueKey);
updateWrapper.getParamNameValuePairs().put(valueKey, AESUtils.encrypt(value.toString()));
}
}
}
}解密攔截器
/**
* 解密攔截器
*
* @author wangshaopeng@talkweb.com.cn
* @Date 2023-05-31
*/
@Intercepts({
@Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})
})
@Component
public class DecryptInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object resultObject = invocation.proceed();
if (Objects.isNull(resultObject)) {
return null;
}
if (resultObject instanceof ArrayList) {
//基于selectList
ArrayList resultList = (ArrayList) resultObject;
if (!resultList.isEmpty() && needToDecrypt(resultList.get(0))) {
for (Object result : resultList) {
//逐一解密
decrypt(result);
}
}
} else if (needToDecrypt(resultObject)) {
//基于selectOne
decrypt(resultObject);
}
return resultObject;
}
/**
* 校驗該實例的類是否被@EncryptedTable所注解
*/
private boolean needToDecrypt(Object object) {
Class<?> objectClass = object.getClass();
EncryptedTable sensitiveData = AnnotationUtils.findAnnotation(objectClass, EncryptedTable.class);
return Objects.nonNull(sensitiveData);
}
@Override
public Object plugin(Object o) {
return Plugin.wrap(o, this);
}
private <T> T decrypt(T result) throws Exception {
//取出resultType的類
Class<?> resultClass = result.getClass();
Field[] declaredFields = resultClass.getDeclaredFields();
for (Field field : declaredFields) {
//取出所有被EncryptedColumn注解的字段
EncryptedColumn sensitiveField = field.getAnnotation(EncryptedColumn.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, AESUtils.decrypt(value));
}
}
}
return result;
}
}
四、其他實現(xiàn)方案
在技術(shù)調(diào)研過程中，還測試了另外兩種便宜實現(xiàn)方案，由于無法覆蓋MP自帶API、Lambda、自定義API等多種場景，因此未采用。
1、使用字段類型處理器
字段類型處理器的[官方文檔點這里]，不能處理LambdaUpdateWrapper更新數(shù)據(jù)時加密的場景。
自定義類型處理器，實現(xiàn)加解密：文章來源：http://www.zghlxwxcb.cn/news/detail-600957.html
/**
* @author wangshaopeng@talkweb.com.cn
* @desccription 加密類型字段處理器
* @date 2023/5/31
*/
public class EncryptTypeHandler extends BaseTypeHandler<String> {
@Override
public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
ps.setString(i, AESUtils.encrypt(parameter));
}
@Override
public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
final String value = rs.getString(columnName);
return AESUtils.decrypt(value);
}
@Override
public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
final String value = rs.getString(columnIndex);
return AESUtils.decrypt(value);
}
@Override
public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
final String value = cs.getString(columnIndex);
return AESUtils.decrypt(value);
}
}
在實體屬性上進行指定
// @TableName注解必須指定autoResultMap = true
@EncryptedTable
@TableName(value = "wsp_user", autoResultMap = true)
public class UserEntity implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Long id;
private String name;
@TableField(typeHandler = EncryptTypeHandler.class)
private String mobile;
@TableField(typeHandler = EncryptTypeHandler.class)
private String email;
}
2、自動填充功能
自動填充功能的[官方文檔點這里]，不能處理LambdaUpdateWrapper、自定義mapper接口更新數(shù)據(jù)時加密的場景，不支持解密的需求。
自定義類型處理器，實現(xiàn)加解密：
/**
* Mybatis元數(shù)據(jù)填充處理類，僅能處理MP的函數(shù)，不能處理mapper.xml中自定義的insert、update
*
* @author wangshaopeng@talkweb.com.cn
* @Date 2023-01-11
*/
public class DBMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
String mobile = (String) metaObject.getValue("mobile");
this.strictInsertFill(metaObject, "mobile", String.class, AESUtils.encrypt(mobile));
String email = (String) metaObject.getValue("email");
this.strictInsertFill(metaObject, "email", String.class, AESUtils.encrypt(email));
}
@Override
public void updateFill(MetaObject metaObject) {
String mobile = (String) metaObject.getValue("mobile");
this.strictUpdateFill(metaObject, "mobile", String.class, AESUtils.encrypt(mobile));
String email = (String) metaObject.getValue("email");
this.strictUpdateFill(metaObject, "email", String.class, AESUtils.encrypt(email));
}
}
在實體類上指定自動填充策略文章來源地址http://www.zghlxwxcb.cn/news/detail-600957.html
@EncryptedTable
@TableName(value = "wsp_user")
public class UserEntity implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Long id;
private String name;
@TableField(fill = FieldFill.INSERT_UPDATE)
private String mobile;
@TableField(fill = FieldFill.INSERT_UPDATE)
private String email;
}到了這里，關(guān)于基于Mybatis-Plus攔截器實現(xiàn)MySQL數(shù)據(jù)加解密的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
