【RuoYi-Vue-Plus】学习笔记 48 - 数据加密功能 Encrypt 源码分析

最新推荐文章于 2025-04-02 14:39:00 发布
最新推荐文章于 2025-04-02 14:39:00 发布
阅读量4.5k 收藏 9
点赞数 2
分类专栏： 框架学习 - 若依 / RuoYi-Vue-Plus 文章标签： mybatis RuoYi-Vue-Plus
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Michelle_Zhong/article/details/129037874
版权
文章介绍了Mybatis数据加密和解密功能的实现，包括自定义插件如何实现Mybatis拦截器，拦截点的选择，以及加密和解密的具体流程。重点分析了加密过程中的参数拦截、字段加密调用，和解密过程中的结果集处理、字段解密调用。文章还提到了加密解密的配置、实体类和Mapper的使用，以及加密解密管理类的角色。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

文章目录

前言

前段时间，在群里大佬们讨论了关于数据存储加密的相关需求，后面就有了关于这个功能的 PR，在 框架 5.X 版本 中，这个功能被抽取成了独立的组件，所以本文来分析一下这个功能的实现。

值得一提的是，基于这个功能，并且借助最近大火的 ChatGPT，对于 Mybatis 的自定义插件的实现过程，我有了更进一步的了解，并且最近也在结合书籍进行 Mybatis 源码的阅读，受益匪浅，有空的话会单独再对书中的笔记进行整理分享。

参考目录

功能实现的准备知识

1、目录结构说明

在这里插入图片描述

类说明功能
EncryptField字段加密注解标注需要加密的字段，用于实体类字段上
AlgorithmType算法枚举加密注解的加密算法 algorithm()
EncodeType编码类型枚举加密注解的编码类型 encode()
EncryptorAutoConfiguration加解密模块配置类配置初始化，注册加密解密拦截器以及加密管理类
EncryptorProperties加解密属性配置类Yaml 配置
EncryptorManager加密管理类加解密功能的缓存管理以及方法调用
EncryptContext加密上下文对象用于 encryptor 传递必要的参数
IEncryptor加解密接口提供加解密接口用于自定义扩展
*Encryptor加解密现类根据 AlgorithmType 以及 EncodeType 提供不同的加解密实现
MybatisEncryptInterceptor入参加密拦截器加密功能核心实现类
MybatisDecryptInterceptor出参解密拦截器解密功能核心实现类

2、一些准备知识

通过上面的目录结构，其实可以知道的是，要实现加解密功能，需要重点关注的是两个 Mybatis 拦截器。

关于这一部分，我看了源码以及书，也请教了一下 ChatGPT，下面是整理后的一些内容，了解了之后可以对这个功能先有一个大致的了解。

2.1、自定义插件如何实现？

Mybatis的自定义插件是通过实现Mybatis提供的拦截器接口实现的。

这里的拦截器接口就是指 org.apache.ibatis.plugin.Interceptor，框架中 MybatisEncryptInterceptor 以及 MybatisDecryptInterceptor 也分别实现了这个接口。

2.2、Mybatis 拦截器的拦截点？

在这里插入图片描述

加密操作：对 ParameterHandler 进行拦截处理，拦截参数设置。
在这里插入图片描述

解密操作：对 ResultSetHandler 进行拦截处理，拦截结果集处理过程。
在这里插入图片描述

2.3、关于 @Intercepts 注解？

在这里插入图片描述

2.4、关于拦截器中的 Interceptor() 方法和 plugin() 方法？

在这里插入图片描述
在这里插入图片描述

MybatisEncryptInterceptor#plugin
在这里插入图片描述

MybatisDecryptInterceptor#intercept
在这里插入图片描述
下面通过 Debug 结合框架中的代码来分析一下这个功能。

功能调用流程分析

1、说明

1.1、数据加密配置

application.yml
在这里插入图片描述
本文使用默认配置进行说明，其他配置可以参考框架 wiki。

1.2、加密实体类

com.ruoyi.demo.domain.TestDemoEncrypt
在这里插入图片描述

1.3、Mapper（非必须）

com.ruoyi.demo.mapper.TestDemoEncryptMapper
在这里插入图片描述

由于我使用的是开发中的分支，加入了多租户插件，这里为了避免报错所以使用了插件忽略注解。

1.4、测试方法

com.ruoyi.demo.controller.TestEncryptController
在这里插入图片描述

这是框架内置的测试方法，如果想要更好地了解执行过程，也可以对此方法拆分再进行 Debug 分析。如下：

在这里插入图片描述

加密解密操作可以理解成是一个相互的过程，有加密就有解密。理解了其中一个之后，另一个其实也是类似的过程。下面分别会对这两个过程进行分析。

2、加密过程的实现分析

2.1、拦截加密实现方法

MybatisEncryptInterceptor#plugin
在这里插入图片描述

2.2、自定义加密处理器

MybatisEncryptInterceptor#encryptHandler
在这里插入图片描述

2.2.1、获取类加密字段缓存

EncryptorManager#getFieldCache
在这里插入图片描述

由于第一次调用缓存中没有，所以对所有标注 @EncryptField 注解的字段设置属性获取权限，并返回结果集。

2.2.2、属性值替换

在这里插入图片描述

2.2.3、字段加密调用过程

MybatisEncryptInterceptor#encryptField
在这里插入图片描述

根据注解以及配置创建加解密上下文对象，调用加密方法。

EncryptorManager#encrypt在这里插入图片描述

根据加密算法创建对应的加密器，并且存入缓存。
EncryptorManager#registAndGetEncryptor
在这里插入图片描述

调用加密器的加密方法进行加密。
Base64Encryptor#encrypt
在这里插入图片描述

2.3、字段加密完成

加密完成后，返回步骤 #2.2 进行属性值替换。
在这里插入图片描述

循环替换完成后的结果：
在这里插入图片描述

所有字段加密完成后，回到拦截方法并返回目标对象。
在这里插入图片描述

3、解密过程的实现分析

3.1、拦截解密实现方法

MybatisDecryptInterceptor#intercept
在这里插入图片描述

3.2、自定义解密处理器

MybatisDecryptInterceptor#decryptHandler
在这里插入图片描述

在这里插入图片描述

3.2.1、获取类加密字段缓存

这一步和加密类似，由于加密过程中已经将字段存入缓存中，因此可以直接获取到。验证方法：
在这里插入图片描述

3.2.2、属性值替换

上一步获取到类加密字段缓存后，循环进行字段解密。
在这里插入图片描述

3.2.3、字段解密调用过程

MybatisDecryptInterceptor#decryptField
在这里插入图片描述

根据注解以及配置创建加解密上下文对象，调用解密方法。
在这里插入图片描述

如果是第一次调用，同样会根据加密算法创建对应的加密器，并且存入缓存。
在这里插入图片描述

调用加密器的解密方法进行解密。
Base64Encryptor#decrypt
在这里插入图片描述

3.3、字段解密完成

解密完成后，返回步骤 #3.2 进行属性值替换。
在这里插入图片描述

循环替换完成后的结果：
在这里插入图片描述

所有字段解密完成后，回到拦截方法并返回执行结果。
在这里插入图片描述

以上是加解密调用流程的分析。

（完）

RuoYi-Vue-Plus（基础知识点jackson、mybatisplus、redis以及Redisson 工具类）
javaxueba的博客
03-19 5844
时区#日期格式#默认转json的属性，这里设置为非空才转json#设置属性命名策略,对应jackson下PropertyNamingStrategy中的常量值，SNAKE_CASE-返回的json驼峰式转下划线，json body下划线传到后端自动转驼峰式#对象为空时是否报错，默认true#返回的java.util.date转换成timestamp#json中含pojo不存在属性时是否失败报错,默认true#是否允许出现单引号,默认false。
RuoYi-Vue-Plus 是重写 RuoYi-Vue
03-07
《RuoYi-Vue-Plus：分布式集群与多租户场景下的全面升级》 RuoYi-Vue-Plus 是一款基于 Vue.js 框架的后台管理系统，它是 RuoYi-Vue 的全新升级版，专为分布式集群和多租户环境进行了深度优化。在原有框架的基础上，...
Ruoyi-Vue-Plus 数据加密-加密拦截器
qq_43975645的博客
06-15 893
Ruoyi-Vue-Plus版本：4.7.0
Ruoyi-Vue-Plus：数据加解密
qq_43975645的博客
06-15 862
Ruoyi-Vue-Plus版本：4.7.0。
Vue中JSEncrypt 数据加密和解密处理
最新发布
神奇侠MAKER
04-02 438
RSA 加密需要一对密钥：公钥和私钥。公钥用于加密数据，私钥用于解密数据。通常，密钥对由后端生成，然后将公钥提供给前端。在 Vue.js 项目中集成 JSEncrypt 实现数据的加密和解密是一种常见的需求，尤其是在处理敏感信息（如密码、用户数据等）。4、编写encrypt.js。
Ruoyi-Vue-Plus 数据加密-解密拦截器
qq_43975645的博客
06-15 922
Ruoyi-Vue-Plus版本：4.7.0
【RuoYi-Vue-Plus】学习笔记 05 - 日志框架 TLog
MichelleChung的星球
11-17 3704
本文章主要记录框架中相关 TLog 配置。
RuoYi对数据库密码加密功能使用
m0_59598029的博客
04-19 1692
在我们日常配置文件中会输入数据库的ip，端口，数据库名称，数据库账号和数据库密码，如果是明文就会出现这个安全隐患的问题，在cnas测试中安全测试可能会直接将这漏洞归类为中级漏洞，所以为了解决这个问题我们可以通过集成RuoYi框架的druid加密功能。
gmailc2：一款基于Google SMTP的完全无法检测的C2服务器
qq_53058639的博客
07-24 1223
1、持久化；2、支持Shell访问；3、查看系统信息；4、…
RuoYi-Vue-Plus 是重写 RuoYi-Vue 针对 分布式集群与多租户 场景全方位升级(不兼容原框架)
03-09
RuoYi-Vue-Plus引入了动态数据源管理功能，使得系统可以根据业务需求灵活切换数据源。这在多租户场景下尤为重要，因为每个租户可能有自己的数据库。系统支持配置多个数据源，并能实现在运行时动态切换，无需重启服务...
传输加解密 RuoYi-Vue-PLus 4.x
10-17
在IT行业中，传输加解密是确保数据安全的重要环节，特别是在Web应用开发中...了解并正确使用这些安全功能，对于任何使用RuoYi-Vue-Plus 4.x的开发者来说都至关重要，因为它们直接关系到应用的安全性和用户数据的保护。
使用RuoYi-Vue-Plus_作为博客的后端框架__项目代码、文档_均开源免费遵循
09-09
本篇文章将介绍以RuoYi-Vue-Plus作为后端框架来构建博客系统的过程，以及开源项目代码和文档的相关细节。 首先，RuoYi-Vue-Plus是一个基于Vue.js和Spring Boot开发的全栈解决方案。它结合了前端框架Vue.js的灵活性...
【RuoYi-Vue-Plus】学习笔记 35 - OSS 模块（六）V4.2.0+ 版本三种方式配置使用
MichelleChung的星球
08-23 9563
本文主要介绍 V4.2.0+ 版本 OSS 模块三种方式配置使用。
RuoYi-Vue前后端分离版学习笔记
xj0_0xj的博客
09-11 174
https://gitee.com/y_project/RuoYi-Vue 从gitee中拉取项目，使用git clone可以保持项目的更新。导入sql脚本修改yml配置文件的mysql和redis配置即可成功启动后端。在终端安装依赖就可以配置npm的启动项了。至此完成了前后端的启动工作。
【RuoYi-Vue-Plus】学习笔记 50 - 集成 JSEncrypt 实现请求加密传输（源码）
竹林幽深
03-18 475
在开始本文内容前，首先说一声：大家节日快乐！本文来简单分析一下框架中请求加密的实现方式。该功能来源于框架pr!377，后续进行了优化并手动合并到了框架 5.X 分支，并在版本v5.1.0正式发布。PR 详情：下面来看下具体的实现方式。
掌握加密技术：算法库源码深入解析
weixin_42418754的博客
10-04 1107
本文还有配套的精品资源，点击获取 简介：加密技术是数据安全的核心，本文深入探讨包括PKI、RSA、AES和DES在内的关键加密算法库及其源码。PKI体系基于公钥加密技术验证数字证书，RSA算法用于数字签名和密钥交换，AES和DES分别代表先进的块加密技术。这些算法库源码对于理解加密工作原理、提升安全编程能力以及保障项目安全具有重要意义。 1. PKI体系结构和应用...
vue项目使用jsencrypt加密
u010227042的博客
02-20 4435
3.在忘记密码页面使用，给接口传的参数加密后传给后端。一.使用jsencrypt进行RSA加密-非全局。二.使用jsencrypt进行RSA加密-全局。
vue部署代码加密
QiGary的博客
08-26 3102
解决方案源于网上资料搜索得到，接下来附上方式及出处。 1、代码混淆加密压缩(terser) cnpm i --save terser-webpack-plugin GitHub：https://github.com/webpack-contrib/terser-webpack-plugin 原文出处：http://events.jianshu.io/p/be5fcffcb3ac 2、高级加密（亲测可用） 算法原理：jjencode 原理地址：https://www.sojson..
@EncryptField
01-11
@EncryptField是一个自定义的加密字段注解。它可以标记在需要加密的字段上，以指示该字段需要进行加密处理。在上面的代码示例中，@EncryptField被标记在Person类的phoneNumber、IDCard和houseNumber字段上，表示这些字段需要进行加密处理。 使用@EncryptField注解后，可以在相应的业务逻辑中对被标记的字段进行加密操作。具体的加密算法和实现方式可以根据需求进行自定义。 以下是一个示例代码，演示了如何使用@EncryptField注解对字段进行加密处理： ```java @Slf4j @Data public class Person { private Integer id; private String userName; private String loginNo; @EncryptField private String phoneNumber; private String sex; @EncryptField private String IDCard; private String address; @EncryptField private String houseNumber; } // 在业务逻辑中对加密字段进行加密操作 public void encryptPerson(Person person) { // 获取加密字段的值 String phoneNumber = person.getPhoneNumber(); String IDCard = person.getIDCard(); String houseNumber = person.getHouseNumber(); // 进行加密操作，例如使用AES加密算法 String encryptedPhoneNumber = AESUtil.encrypt(phoneNumber); String encryptedIDCard = AESUtil.encrypt(IDCard); String encryptedHouseNumber = AESUtil.encrypt(houseNumber); // 将加密后的值设置回对象 person.setPhoneNumber(encryptedPhoneNumber); person.setIDCard(encryptedIDCard); person.setHouseNumber(encryptedHouseNumber); } ``` 请注意，以上代码只是一个示例，实际的加密操作需要根据具体的需求和加密算法进行实现。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

MichelleChung

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值