API 加解密
核心说明
API 加密主要用于防止传输过程被拦截(如代理劫持)。
前端必须解密后展示,因此无论公钥/私钥最终都可被用于解密。
由于 JS 环境缺少“公钥解密”的通用实现,因此前端使用私钥进行解密。
如有更优方案,欢迎反馈与共建。
1. 使用注解 @ApiEncrypt
- 标注该注解的接口,请求参数必须加密
response参数控制响应是否加密,默认false- 加解密逻辑由过滤器处理:
org.dromara.common.encrypt.filter.CryptoFilter
补充说明:
- Cloud 版本中认证中心和部分系统接口同样已经使用了该能力。
- 使用方式与 Vue 版本一致,可直接参考 Vue 版本 API 加解密说明。
2. 配置方式
后端配置:application-common.yml

前端配置:.env.development / .env.production

注意事项:
- 修改配置请同步更新 Nacos
- 公私钥需前后端配对一致
- 后端公钥对应前端私钥;后端私钥对应前端公钥
补充说明:
- Cloud 版本的后端配置通常维护在 Nacos 公共配置
application-common.yml中。 - 如果前后端密钥不一致,最常见表现就是登录、注册等接口直接解密失败。
3. 前端开启加密
在请求头中加入 isEncrypt: true:
js
headers: {
isEncrypt: true
}
补充说明:
- 前端全局开关仍然是
VITE_APP_ENCRYPT,关闭时应和后端保持一致。 - 当前实现只处理
POST、PUT请求体加密。
4. 请求/响应加解密说明
详见:关于请求响应参数解密
密钥生成说明
