如何对数据进行脱敏处理?

一、背景

实际的业务开发过程中,我们经常需要对用户的隐私数据进行脱敏处理,所谓脱敏处理其实就是将数据进行混淆隐藏,例如下图,将用户的手机号、地址等数据信息,采用*进行隐藏,以免泄露个人隐私信息。

如果需要脱敏的数据范围很小很小,甚至就是指定的字段,一般的处理方式也很简单,就是写一个隐藏方法即可实现数据脱敏。

如果是需求很少的情况下,采用这种方式实现没太大问题,好维护!

但如果是类似上面那种很多位置的数据,需要分门别类的进行脱敏处理,通过这种简单粗暴的处理,代码似乎就显得不太优雅了。

思考一下,我们可不可以在数据输出的阶段,进行统一数据脱敏处理,这样就可以省下不少体力活。

说到数据输出,很多同学可能会想到 JSON 序列化。是的没错,我们所熟悉的 web 系统,就是将数据通过 json 序列化之后展示给前端。

那么问题来了,如何在序列化的时候,进行数据脱敏处理呢?

废话不多说,代码直接撸上!

二、程序实践 2.1、首先添加依赖包

默认的情况下,如果当前项目已经添加了spring-web包或者spring-boot-starter-web包,因为这些jar包已经集成了jackson相关包,因此无需重复依赖。

如果当前项目没有jackson包,可以通过如下方式进行添加相关依赖包。

<!--jackson依赖--> <dependency>     <groupId>com.fasterxml.jackson.core</groupId>     <artifactId>jackson-core</artifactId>     <version>2.9.8</version> </dependency> <dependency>     <groupId>com.fasterxml.jackson.core</groupId>     <artifactId>jackson-annotations</artifactId>     <version>2.9.8</version> </dependency> <dependency>     <groupId>com.fasterxml.jackson.core</groupId>     <artifactId>jackson-databind</artifactId>     <version>2.9.8</version> </dependency
2.2、编写脱敏类型枚举类,满足不同场景的处理
public enum SensitiveEnum {      /**      * 中文名      */     CHINESE_NAME,      /**      * 身份证号      */     ID_CARD,      /**      * 座机号      */     FIXED_PHONE,      /**      * 手机号      */     MOBILE_PHONE,      /**      * 地址      */     ADDRESS,      /**      * 电子邮件      */     EMAIL,      /**      * 银行卡      */     BANK_CARD,      /**      * 公司开户银行联号      */     CNAPS_CODE } 
2.3、编写脱敏注解类
import com.fasterxml.jackson.annotation.JacksonAnnotationsInside; import com.fasterxml.jackson.databind.annotation.JsonSerialize; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy;  @Retention(RetentionPolicy.RUNTIME) @JacksonAnnotationsInside @JsonSerialize(using = SensitiveSerialize.class) public @interface SensitiveWrapped {      /**      * 脱敏类型      * @return      */     SensitiveEnum value(); } 
2.4、编写脱敏序列化类
import com.fasterxml.jackson.core.JsonGenerator; import com.fasterxml.jackson.databind.BeanProperty; import com.fasterxml.jackson.databind.JsonMappingException; import com.fasterxml.jackson.databind.JsonSerializer; import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.ser.ContextualSerializer; import java.io.IOException; import java.util.Objects;  public class SensitiveSerialize extends JsonSerializer<String> implements ContextualSerializer {      /**      * 脱敏类型      */     private SensitiveEnum type;           @Override     public void serialize(String s, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {         switch (this.type) {             case CHINESE_NAME: {                 jsonGenerator.writeString(SensitiveInfoUtils.chineseName(s));                 break;             }             case ID_CARD: {                 jsonGenerator.writeString(SensitiveInfoUtils.idCardNum(s));                 break;             }             case FIXED_PHONE: {                 jsonGenerator.writeString(SensitiveInfoUtils.fixedPhone(s));                 break;             }             case MOBILE_PHONE: {                 jsonGenerator.writeString(SensitiveInfoUtils.mobilePhone(s));                 break;             }             case ADDRESS: {                 jsonGenerator.writeString(SensitiveInfoUtils.address(s, 4));                 break;             }             case EMAIL: {                 jsonGenerator.writeString(SensitiveInfoUtils.email(s));                 break;             }             case BANK_CARD: {                 jsonGenerator.writeString(SensitiveInfoUtils.bankCard(s));                 break;             }             case CNAPS_CODE: {                 jsonGenerator.writeString(SensitiveInfoUtils.cnapsCode(s));                 break;             }         }     }      @Override     public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty) throws JsonMappingException {         // 为空直接跳过         if (beanProperty != null) {             // 非 String 类直接跳过             if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {                 SensitiveWrapped sensitiveWrapped = beanProperty.getAnnotation(SensitiveWrapped.class);                 if (sensitiveWrapped == null) {                     sensitiveWrapped = beanProperty.getContextAnnotation(SensitiveWrapped.class);                 }                 if (sensitiveWrapped != null) {                     // 如果能得到注解,就将注解的 value 传入 SensitiveSerialize                     return new SensitiveSerialize(sensitiveWrapped.value());                 }             }             return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);         }         return serializerProvider.findNullValueSerializer(beanProperty);     }      public SensitiveSerialize() {}      public SensitiveSerialize(final SensitiveEnum type) {         this.type = type;     } } 

其中createContextual的作用是通过字段已知的上下文信息定制JsonSerializer对象。

2.5、编写脱敏工具类
import org.apache.commons.lang3.StringUtils;  public class SensitiveInfoUtils {      /**      * [中文姓名] 只显示第一个汉字,其他隐藏为2个星号<例子:李**>      */     public static String chineseName(final String fullName) {         if (StringUtils.isBlank(fullName)) {             return "";         }         final String name = StringUtils.left(fullName, 1);         return StringUtils.rightPad(name, StringUtils.length(fullName), "*");     }      /**      * [中文姓名] 只显示第一个汉字,其他隐藏为2个星号<例子:李**>      */     public static String chineseName(final String familyName, final String givenName) {         if (StringUtils.isBlank(familyName)