# 數據脫敏注解 >[info] 用途說明：數據脫敏即將一些敏感信息通過加密、格式化等方式處理，展示給用戶一個新的或是格式化后的信息，避免了敏感信息的暴露。 ### 脫敏注解 | 注解 | 作用域 | 描述 | ---- | --- | --- | | @SensitiveEncode| service方法 | `脫敏加密注解`，表示該方法的返回值需要脫敏處理 | | @SensitiveDecode| service方法 | `脫敏解密注解`，表示該方法的返回值需要解密（僅支持對脫敏encode之后的解密）| | @SensitiveField | 實體字段 | 表示該字段需要脫敏處理 | >[warning] 重要提醒：數據脫敏是基于AOP實現的，所以不要在同一個類中調用帶有上述注解的方法，這樣會導致aop失效。 ### 脫敏注解具體用法 1. 給實體字段上添加注解：`@SensitiveField` 只給需要脫敏的字段加注解，不需要脫敏的字段，不用加注解 ~~~ public class LoginUser { /** * 登錄人密碼 */ @SensitiveField private String password; ~~~ 2. service方法上添加注解`@SensitiveEncode` ~~~ @Override @SensitiveEncode public LoginUser getEncodeUserInfo(String username){ if(oConvertUtils.isEmpty(username)) { return null; } LoginUser loginUser = new LoginUser(); SysUser sysUser = userMapper.getUserByName(username); if(sysUser==null) { return null; } BeanUtils.copyProperties(sysUser, loginUser); return loginUser; } ~~~ >[info] 注意：在方法上添加注解`@SensitiveEncode`后表示該方法的返回值會進行脫敏處理。 > 脫敏邏輯： > - 攔截器會針對實體LoginUser中的加注解`@SensitiveField`字段進行脫敏處理。 > - 方法返回值類型支持`LoginUser` 也支持` List<LoginUser>` 3. 脫敏數據類型 數據處理規則支持：`加密處理、用戶名稱格式化、身份證號碼格式化、郵件電話格式化等` 語法：字段注解@SensitiveField屬性type，默認是encode(加密處理)，如： ~~~ /** * 登錄人密碼 */ @SensitiveField(type = SensitiveEnum.ENCODE) private String password; /** * 電子郵件 */ @SensitiveField(type = SensitiveEnum.EMAIL) private String email; /** * 電話 */ @SensitiveField(type = SensitiveEnum.MOBILE_PHONE) private String phone; ~~~ 更多參考枚舉類：org.jeecg.common.desensitization.enums.SensitiveEnum ### 解密處理 @SensitiveDecode >[info] 說明：針對數據進行脫敏加密后，jeecgboot也提供了解密注解，即還原真實數據。 語法：在方法上添加注解@SensitiveDecode，即表示該方法的返回值會做一次解密處理。 ``` @SensitiveDecode public LoginUser getUserByName(String username) { LoginUser user = sysUserService.getEncodeUserInfo(username); return user; } ```