注解
组件共有 3 个注解:@EncryptApi
@DecryptApi
@DecryptParam
,如果配置了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 相同 |