輕松實現 SpringBoot 中的隱私數據脫敏處理
作者：一安
其實要實現上面的效果，可能最先想到的方法是直接改每個接口，在返回數據前做一次加密處理，當然這個方法肯定是非常撈的。這里推薦用注解來實現，即高效又優雅，省時省力，支持擴展。
前言
這兩天在整改等保測出的問題，里面有一個用戶信息泄露的風險項（就是后臺系統里用戶的一些隱私數據直接明文顯示了），其實指的就是要做數據脫敏。
數據脫敏：把系統里的一些敏感數據進行加密處理后再返回，達到保護隱私作用，實現效果圖如下：
圖片
其實要實現上面的效果，可能最先想到的方法是直接改每個接口，在返回數據前做一次加密處理，當然這個方法肯定是非常撈的。這里推薦用注解來實現，即高效又優雅，省時省力，支持擴展。
其實解決方案大體上分兩種：
- 在拿到數據時就已經脫敏了（如在 mysql 查詢時用 insert 函數進行隱藏）
- 拿到數據后在序列化的時候再進行脫敏（如用 fastjson、jackson）
這里我所選用的方案是第二種，即在接口返回數據前，在序列化的時候對敏感字段值進行處理，并且選用 jackson 的序列化來實現（推薦）
實現
創建隱私數據類型枚舉
/**
* 隱私數據類型枚舉
*/
@Getter
public enum PrivacyTypeEnum {
/** 自定義（此項需設置脫敏的范圍）*/
CUSTOMER,
/** 姓名 */
NAME,
/** 身份證號 */
ID_CARD,
/** 手機號 */
PHONE,
/** 郵箱 */
EMAIL,
}創建自定義隱私注解
/**
* 自定義數據脫敏注解
*/
@Target(ElementType.FIELD) // 作用在字段上
@Retention(RetentionPolicy.RUNTIME) // class文件中保留，運行時也保留，能通過反射讀取到
@JacksonAnnotationsInside // 表示自定義自己的注解PrivacyEncrypt
@JsonSerialize(using = PrivacySerializer.class) // 該注解使用序列化的方式
public @interface PrivacyEncrypt {
/**
* 脫敏數據類型（沒給默認值，所以使用時必須指定type）
*/
PrivacyTypeEnum type();
/**
* 前置不需要打碼的長度
*/
int prefixNoMaskLen() default 1;
/**
* 后置不需要打碼的長度
*/
int suffixNoMaskLen() default 1;
/**
* 用什么打碼
*/
String symbol() default "*";
}創建自定義序列化器
@NoArgsConstructor
@AllArgsConstructor
public class PrivacySerializer extends JsonSerializer<String> implements ContextualSerializer {
// 脫敏類型
private PrivacyTypeEnum privacyTypeEnum;
// 前幾位不脫敏
private Integer prefixNoMaskLen;
// 最后幾位不脫敏
private Integer suffixNoMaskLen;
// 用什么打碼
private String symbol;
@Override
public void serialize(String origin, final JsonGenerator jsonGenerator,
final SerializerProvider serializerProvider) throws IOException {
if (StrUtil.isEmpty(origin)) {
origin = null;
}
if (null != privacyTypeEnum) {
switch (privacyTypeEnum) {
case CUSTOMER:
jsonGenerator.writeString(PrivacyUtil.desValue(origin, prefixNoMaskLen, suffixNoMaskLen, symbol));
break;
case NAME:
jsonGenerator.writeString(PrivacyUtil.hideChineseName(origin));
break;
case ID_CARD:
jsonGenerator.writeString(PrivacyUtil.hideIDCard(origin));
break;
case PHONE:
jsonGenerator.writeString(PrivacyUtil.hidePhone(origin));
break;
case EMAIL:
jsonGenerator.writeString(PrivacyUtil.hideEmail(origin));
break;
default:
throw new IllegalArgumentException("unknown privacy type enum " + privacyTypeEnum);
}
}
}
@Override
public JsonSerializer<?> createContextual(final SerializerProvider serializerProvider,
final BeanProperty beanProperty) throws JsonMappingException {
if (null != beanProperty) {
if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {
PrivacyEncrypt privacyEncrypt = beanProperty.getAnnotation(PrivacyEncrypt.class);
if (null == privacyEncrypt) {
privacyEncrypt = beanProperty.getContextAnnotation(PrivacyEncrypt.class);
}
if (null != privacyEncrypt) {
return new PrivacySerializer(privacyEncrypt.type(), privacyEncrypt.prefixNoMaskLen(),
privacyEncrypt.suffixNoMaskLen(), privacyEncrypt.symbol());
}
}
return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
}
return serializerProvider.findNullValueSerializer(null);
}
}這里是具體的實現過程，因為要脫敏的數據都是 String 類型的，所以繼承 JsonSerializer 時的類型填 String
- 重寫的 serialize 方法是實現脫敏的核心，根據類型 type 的不同去設置序列化后的值
- 重寫的 createContextual 方法，就是去讀取我們自定義的 PrivacyEncrypt 注解，打造一個上下文的環境
隱私數據隱藏工具類
public class PrivacyUtil {
/**
* 中文名脫敏
*/
public static String hideChineseName(String chineseName) {
if (StrUtil.isEmpty(chineseName)) {
return null;
}
if (chineseName.length() <= 2) {
return desValue(chineseName, 1, 0, "*");
}
return desValue(chineseName, 1, 1, "*");
}
/**
* 手機號脫敏
*/
public static String hidePhone(String phone) {
if (StrUtil.isEmpty(phone)) {
return null;
}
return phone.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"); // 隱藏中間4位
// return desValue(phone, 3, 4, "*"); // 隱藏中間4位
// return desValue(phone, 7, 0, "*"); // 隱藏末尾4位
}
/**
* 郵箱脫敏
*/
public static String hideEmail(String email) {
if (StrUtil.isEmpty(email)) {
return null;
}
return email.replaceAll("(\\w?)(\\w+)(\\w)(@\\w+\\.[a-z]+(\\.[a-z]+)?)", "$1****$3$4");
}
/**
* 身份證號脫敏
*/
public static String hideIDCard(String idCard) {
if (StrUtil.isEmpty(idCard)) {
return null;
}
return idCard.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1*****$2");
}
/**
* 對字符串進行脫敏操作
* @param origin 原始字符串
* @param prefixNoMaskLen 左側需要保留幾位明文字段
* @param suffixNoMaskLen 右側需要保留幾位明文字段
* @param maskStr 用于遮罩的字符串, 如'*'
* @return 脫敏后結果
*/
public static String desValue(String origin, int prefixNoMaskLen, int suffixNoMaskLen, String maskStr) {
if (StrUtil.isEmpty(origin)) {
return null;
}
StringBuilder sb = new StringBuilder();
for (int i = 0, n = origin.length(); i < n; i++) {
if (i < prefixNoMaskLen) {
sb.append(origin.charAt(i));
continue;
}
if (i > (n - suffixNoMaskLen - 1)) {
sb.append(origin.charAt(i));
continue;
}
sb.append(maskStr);
}
return sb.toString();
}
}這個工具類其實可以自己定，根據自己的業務去擴展
注解使用
@Data
public class People {
private Integer id;
private String name;
private Integer sex;
private Integer age;
@PrivacyEncrypt(type = PrivacyTypeEnum.PHONE) // 隱藏手機號
private String phone;
@PrivacyEncrypt(type = PrivacyTypeEnum.EMAIL) // 隱藏郵箱
private String email;
private String sign;
}到這里，脫敏工作就已經結束了，全局使用這一個注解即可，一勞永逸，支持擴展，測試效果圖如下：
責任編輯：武曉燕
來源：
一安未來
