SecureApi使用文档SecureApi使用文档
主页
开始使用
版本历史
  • 中国大陆
  • 国际
  • 简体中文
  • English
主页
开始使用
版本历史
  • 中国大陆
  • 国际
  • 简体中文
  • English
  • 快速开始

    • 开始使用
    • 安装
    • 配置
    • 试一下
  • 指南

    • 注解
    • URL匹配
    • 异常处理
    • 加密算法
    • CipherUtils
    • 两种模式
    • DH密钥协商
    • 数字签名校验
  • JS示例
  • 最佳实践
  • 微服务调用
  • 黑金刚

注解

组件共有 5 个注解:@EncryptApi @DecryptApi @DecryptParam @DecryptIgnore @DecryptIgnore ,如果配置了url匹配,那么匹配到的接口无需使用下列注解就可以进行对应加解密。

WARNING

请非常注意!!!,不要对需要解密的参数使用 @RequestParam,会导致解密功能失效(即使在配置了url匹配的情况下也会失效),@DecryptParam 提供了和 @RequestParam 相同的能力,使用 @DecryptParam 即可。

下面所说的 “接口” 均为 @RestController 标记的方法,不是 interface 方法,明确一下避免歧义

@EncryptApi

注解作用添加位置注解字段注意事项
加密接口返回值接口或接口所在类上无优先级高于url匹配,即使接口没有匹配到,添加了此注解也会进行返回值加密

@DecryptApi

注解作用添加位置注解字段注意事项
解密接口json参数值(也就是@RequestBody标记的参数)接口或接口所在类上无优先级高于url匹配,即使接口没有匹配到,添加了此注解也会进行参数解密

@DecryptParam

WARNING

再次提醒!!!请非常注意!!!,不要对需要解密的参数使用 @RequestParam,会导致解密功能失效(即使在配置了url匹配的情况下也会失效),@DecryptParam 提供了和 @RequestParam 相同的能力,使用 @DecryptParam 即可。

WARNING

暂不支持 MultipartFile 的解密,后续会进行开发

注解作用添加位置注解字段注意事项
解密接口param和form-data参数值接口非实体类参数或接口实体类参数字段上同@RequestParam优先级高于url匹配,即使接口没有匹配到,添加了此注解也会进行参数解密;此外,此注解不可与@RequestParam同时使用,会导致解密功能失效,此注解已经代替了@RequestParam功能,内部字段功能和@RequestParam相同

@DecryptIgnore

注解作用添加位置注解字段注意事项
忽略解密类、方法、参数、字段无无

@EncryptIgnore

注解作用添加位置注解字段注意事项
忽略加密类、方法、参数、字段无无
在 Github 上编辑
最近更新:
编著者: XuYijie
Next
URL匹配