如何实现SpringBoot项目中的隐私数据脱敏呢

这两天在整改等保测出的问题，里面有一个“用户信息泄露”的风险项（就是后台系统里用户的一些隐私数据直接明文显示了），其实指的就是要做数据脱敏。

数据脱敏：把系统里的一些敏感数据进行加密处理后再返回，达到保护隐私作用，实现效果图如下：

其实要实现上面的效果，可能最先想到的方法是直接改每个controller接口，在返回数据前做一次加密处理，当然这个方法肯定是非常捞的。这里推荐用注解来实现，即高效又优雅，省时省力，支持扩展。

其实解决方案大体上分两种：

在拿到数据时就已经脱敏了（如在 mysql 查询时用 insert 函数进行隐藏）

拿到数据后在序列化的时候再进行脱敏（如用 fastjson、jackson）

这里我所选用的方案是第二种，即在接口返回数据前，在序列化的时候对敏感字段值进行处理，并且选用 jackson 的序列化来实现（推荐）

1. 创建隐私数据类型枚举：PrivacyTypeEnum

importlombok.Getter;

/**
*隐私数据类型枚举
*/
@Getter
publicenumPrivacyTypeEnum{

/**自定义（此项需设置脱敏的范围）*/
CUSTOMER,

/**姓名*/
NAME,

/**身份证号*/
ID_CARD,

/**手机号*/
PHONE,

/**邮箱*/
EMAIL,
}

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

2. 创建自定义隐私注解：PrivacyEncrypt

importcom.fasterxml.jackson.annotation.JacksonAnnotationsInside;
importcom.fasterxml.jackson.databind.annotation.JsonSerialize;

importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;

/**
*自定义数据脱敏注解
*/
@Target(ElementType.FIELD)//作用在字段上
@Retention(RetentionPolicy.RUNTIME)//class文件中保留，运行时也保留，能通过反射读取到
@JacksonAnnotationsInside//表示自定义自己的注解PrivacyEncrypt
@JsonSerialize(using=PrivacySerializer.class)//该注解使用序列化的方式
public@interfacePrivacyEncrypt{

/**
*脱敏数据类型（没给默认值，所以使用时必须指定type）
*/
PrivacyTypeEnumtype();

/**
*前置不需要打码的长度
*/
intprefixNoMaskLen()default1;

/**
*后置不需要打码的长度
*/
intsuffixNoMaskLen()default1;

/**
*用什么打码
*/
Stringsymbol()default"*";
}

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

3. 创建自定义序列化器：PrivacySerializer

importcom.fasterxml.jackson.core.JsonGenerator;
importcom.fasterxml.jackson.databind.BeanProperty;
importcom.fasterxml.jackson.databind.JsonMappingException;
importcom.fasterxml.jackson.databind.JsonSerializer;
importcom.fasterxml.jackson.databind.SerializerProvider;
importcom.fasterxml.jackson.databind.ser.ContextualSerializer;
importcom.zk.common.core.domain.enumerate.PrivacyTypeEnum;
importcom.zk.common.core.utils.PrivacyUtil;
importjava.io.IOException;
importjava.util.Objects;
importlombok.AllArgsConstructor;
importlombok.NoArgsConstructor;
importorg.apache.commons.lang3.StringUtils;

@NoArgsConstructor
@AllArgsConstructor
publicclassPrivacySerializerextendsJsonSerializerimplementsContextualSerializer{

//脱敏类型
privatePrivacyTypeEnumprivacyTypeEnum;
//前几位不脱敏
privateIntegerprefixNoMaskLen;
//最后几位不脱敏
privateIntegersuffixNoMaskLen;
//用什么打码
privateStringsymbol;

@Override
publicvoidserialize(finalStringorigin,finalJsonGeneratorjsonGenerator,
finalSerializerProviderserializerProvider)throwsIOException{
if(StringUtils.isNotBlank(origin)&&null!=privacyTypeEnum){
switch(privacyTypeEnum){
caseCUSTOMER:
jsonGenerator.writeString(PrivacyUtil.desValue(origin,prefixNoMaskLen,suffixNoMaskLen,symbol));
break;
caseNAME:
jsonGenerator.writeString(PrivacyUtil.hideChineseName(origin));
break;
caseID_CARD:
jsonGenerator.writeString(PrivacyUtil.hideIDCard(origin));
break;
casePHONE:
jsonGenerator.writeString(PrivacyUtil.hidePhone(origin));
break;
caseEMAIL:
jsonGenerator.writeString(PrivacyUtil.hideEmail(origin));
break;
default:
thrownewIllegalArgumentException("unknownprivacytypeenum"+privacyTypeEnum);
}
}
}

@Override
publicJsonSerializercreateContextual(finalSerializerProviderserializerProvider,
finalBeanPropertybeanProperty)throwsJsonMappingException{
if(beanProperty!=null){
if(Objects.equals(beanProperty.getType().getRawClass(),String.class)){
PrivacyEncryptprivacyEncrypt=beanProperty.getAnnotation(PrivacyEncrypt.class);
if(privacyEncrypt==null){
privacyEncrypt=beanProperty.getContextAnnotation(PrivacyEncrypt.class);
}
if(privacyEncrypt!=null){
returnnewPrivacySerializer(privacyEncrypt.type(),privacyEncrypt.prefixNoMaskLen(),
privacyEncrypt.suffixNoMaskLen(),privacyEncrypt.symbol());
}
}
returnserializerProvider.findValueSerializer(beanProperty.getType(),beanProperty);
}
returnserializerProvider.findNullValueSerializer(null);
}
}

这里是具体的实现过程，因为要脱敏的数据都是 String 类型的，所以继承 JsonSerializer 时的类型填 String

重写的 serialize 方法是实现脱敏的核心，根据类型 type 的不同去设置序列化后的值

重写的 createContextual 方法就是去读取我们自定义的 PrivacyEncrypt 注解，打造一个上下文的环境。

4. 隐私数据隐藏工具类：PrivacyUtil

publicclassPrivacyUtil{

/**
*隐藏手机号中间四位
*/
publicstaticStringhidePhone(Stringphone){
returnphone.replaceAll("(\d{3})\d{4}(\d{4})","$1****$2");
}

/**
*隐藏邮箱
*/
publicstaticStringhideEmail(Stringemail){
returnemail.replaceAll("(\w?)(\w+)(\w)(@\w+\.[a-z]+(\.[a-z]+)?)","$1****$3$4");
}

/**
*隐藏身份证
*/
publicstaticStringhideIDCard(StringidCard){
returnidCard.replaceAll("(\d{4})\d{10}(\w{4})","$1*****$2");
}

/**
*【中文姓名】只显示第一个汉字，其他隐藏为星号，比如：任**
*/
publicstaticStringhideChineseName(StringchineseName){
if(chineseName==null){
returnnull;
}
returndesValue(chineseName,1,0,"*");
}

///**
//*【身份证号】显示前4位,后2位
//*/
//publicstaticStringhideIdCard(StringidCard){
//returndesValue(idCard,4,2,"*");
//}

///**
//*【手机号码】前三位，后四位，其他隐藏。
//*/
//publicstaticStringhidePhone(Stringphone){
//returndesValue(phone,3,4,"*");
//}

/**
*对字符串进行脱敏操作
*@paramorigin原始字符串
*@paramprefixNoMaskLen左侧需要保留几位明文字段
*@paramsuffixNoMaskLen右侧需要保留几位明文字段
*@parammaskStr用于遮罩的字符串,如'*'
*@return脱敏后结果
*/
publicstaticStringdesValue(Stringorigin,intprefixNoMaskLen,intsuffixNoMaskLen,StringmaskStr){
if(origin==null){
returnnull;
}
StringBuildersb=newStringBuilder();
for(inti=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);
}
returnsb.toString();
}

publicstaticvoidmain(String[]args){
System.out.println(hideChineseName("张三三"));
}
}

这个工具类其实可以自己定，根据自己的业务去扩展，提一点：

在自定义注解 PrivacyEncrypt 里，只有 type 的值为 PrivacyTypeEnum.CUSTOMER（自定义）时，才需要指定脱敏范围，即 prefixNoMaskLen 和 suffixNoMaskLen 的值，像邮箱、手机号这种隐藏格式都采用固定的

5. 注解使用

直接在需要脱敏的字段上加上注解，指定 type 值即可，如下：

@Data
publicclassPeople{

privateIntegerid;

privateStringname;

privateIntegersex;

privateIntegerage;

@PrivacyEncrypt(type=PrivacyTypeEnum.PHONE)//隐藏手机号
privateStringphone;

@PrivacyEncrypt(type=PrivacyTypeEnum.EMAIL)//隐藏邮箱
privateStringemail;

privateStringsign;
}

到这里，脱敏工作就已经结束了，全局使用这一个注解即可，一劳永逸，测试效果图如下：

以上代码已经过测试，并已实际使用，所以可放心使用。

审核编辑：刘清