【深度思考】如何优雅的实现脱敏？

最近做了个脱敏的需求，要对系统中的敏感信息，如手机号、车牌号、身份证号、银行卡号等进行脱敏显示。
效果类似下面这样：

简单来说，就是对敏感信息中的某几位进行掩码显示，常见的一般是使用*。
本篇文章就来讲解下在项目中该如何优雅的实现脱敏。
1. 工具类

首先，需要明确下脱敏规则：

• 手机号
  

  显示前3位和后4位，中间4位脱敏，如182****6791。
  

  
  
• 车牌号
  

  显示前3位和后1位，其余位脱敏，如沪B0***8。
  

  
  
• 身份证号
  

  显示前3位和后4位，其余位脱敏，如410***********0007。
  

  
  
• 银行卡号
  

  显示前4位和后4位，其余位脱敏，并且每4位分隔，如6214 **** **** 8533。
  

  
  

然后，需要一个实现了以上脱敏规则的工具类，这个工具类可以使用公司统一提供的，也可以使用第三方类库的，
或者使用自己实现的。
本篇文章使用第三方类库Hutool中自带的脱敏工具类DesensitizedUtil。
如果项目中之前没有使用过Hutool，需要添加以下依赖：

1. <dependency>
2.     <groupId>cn.hutool</groupId>
3.     <artifactId>hutool-core</artifactId>
4.     <version>5.8.4</version>
5. </dependency>

复制代码

使用示例：

1. System.out.println(DesensitizedUtil.mobilePhone("18216556791"));
2. System.out.println(DesensitizedUtil.carLicense("沪B08U28"));
3. System.out.println(DesensitizedUtil.idCardNum("410328200001010007", 3, 4));
4. System.out.println(DesensitizedUtil.bankCard("6214856213978533"));

复制代码

输出结果：

2. 硬编码方案

所谓硬编码方案，就是在所有需要脱敏的地方都调用下上面工具类提供的方法。
这种方案的优点是简单，容易理解，能很好的评估改动影响的范围，缺点是代码耦合度高，如果涉及脱敏的接口很多，
那改动起来简直是灾难。
因此，这种方案推荐在涉及脱敏的接口很少的情况下使用，如果涉及脱敏的接口很多，推荐使用下文讲解的使用注解的方案。
3. 使用注解方案

使用注解方案，指的是接口数据在返回之前，通过执行自定义序列化器的逻辑达到脱敏的效果，
这种方案需要在字段上添加自定义注解来标识这个字段需要进行脱敏以及脱敏的规则，
优点是代码耦合度低，脱敏代码和业务代码不耦合，缺点是有一定的理解成本，不能很好的评估改动影响的范围。
那如何使用注解来实现脱敏呢？
首先，定义一个脱敏类型的枚举：

1. /**
2. * 脱敏类型
3. */
4. public enum DesensitizeType {
5.     /**
6.      * 手机号
7.      */
8.     MOBILE_PHONE,
10.     /**
11.      * 车牌号
12.      */
13.     LICENSE_NUMBER,
15.     /**
16.      * 身份证号
17.      */
18.     ID_CARD,
20.     /**
21.      * 银行卡
22.      */
23.     BANK_CARD,
25.     /**
26.      * 自定义
27.      */
28.     CUSTOM
29. }

复制代码

然后，定义一个脱敏的注解：

1. @Target(ElementType.FIELD)
2. @Retention(RetentionPolicy.RUNTIME)
3. @JacksonAnnotationsInside
4. @JsonSerialize(using = DesensitizeSerializer.class)
5. public @interface Desensitize {
6.     /**
7.      * 脱敏类型
8.      */
9.     DesensitizeType type() default DesensitizeType.CUSTOM;
11.     /**
12.      * 开始位置(包含)
13.      */
14.     int startIndex() default 0;
16.     /**
17.      * 结束位置(不包含)
18.      */
19.     int endIndex() default 0;
20. }

复制代码

上面代码中的@Target和@Retention是JDK自带的元注解，@JacksonAnnotationsInside和@JsonSerialize属于
jackson-databind下的注解，而spring-boot-starter-web下包含了jackson-databind，因此大部分项目不需要单独添加依赖：

重点看下@JsonSerialize(using = DesensitizeSerializer.class)，该行代码指定json序列化时使用自定义的
脱敏序列化类DesensitizeSerializer，其代码如下所示：

1. /**
2. * 脱敏序列化类
3. */
4. public class DesensitizeSerializer extends JsonSerializer<String> implements ContextualSerializer {
5.     private DesensitizeType type;
7.     private Integer startIndex;
9.     private Integer endIndex;
11.     public DesensitizeSerializer() {
12.     }
14.     public DesensitizeSerializer(DesensitizeType type, Integer startIndex, Integer endIndex) {
15.         this.type = type;
16.         this.startIndex = startIndex;
17.         this.endIndex = endIndex;
18.     }
20.     @Override
21.     public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
22.         switch (type) {
23.             // 手机号脱敏
24.             case MOBILE_PHONE:
25.                 jsonGenerator.writeString(DesensitizedUtil.mobilePhone(String.valueOf(value)));
26.                 break;
27.             // 车牌号脱敏
28.             case LICENSE_NUMBER:
29.                 jsonGenerator.writeString(DesensitizedUtil.carLicense(String.valueOf(value)));
30.                 break;
31.             // 身份证号脱敏
32.             case ID_CARD:
33.                 jsonGenerator.writeString(DesensitizedUtil.idCardNum(String.valueOf(value), 3, 4));
34.                 break;
35.             // 银行卡脱敏
36.             case BANK_CARD:
37.                 jsonGenerator.writeString(DesensitizedUtil.bankCard(String.valueOf(value)));
38.                 break;
39.             // 自定义脱敏
40.             case CUSTOM:
41.                 jsonGenerator.writeString(CharSequenceUtil.hide(value, startIndex, endIndex));
42.                 break;
43.             default:
44.                 break;
45.         }
46.     }
48.     @Override
49.     public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty) throws JsonMappingException {
50.         if (beanProperty != null) {
51.             // 判断数据类型是否为String类型
52.             if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {
53.                 // 获取定义的注解
54.                 Desensitize desensitize = beanProperty.getAnnotation(Desensitize.class);
55.                 // 为null
56.                 if (desensitize == null) {
57.                     desensitize = beanProperty.getContextAnnotation(Desensitize.class);
58.                 }
59.                 // 不为null
60.                 if (desensitize != null) {
61.                     // 创建定义的序列化类的实例并且返回，入参为注解定义的type,开始位置，结束位置。
62.                     return new DesensitizeSerializer(desensitize.type(), desensitize.startIndex(),
63.                             desensitize.endIndex());
64.                 }
65.             }
67.             return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
68.         }
70.         return serializerProvider.findNullValueSerializer(null);
71.     }
72. }

复制代码

该类实现了com.fasterxml.jackson.databind.ser.ContextualSerializer接口并重写了createContextual方法，
该方法会解析字段的类型是不是String以及字段上有没有之前自定义的注解Desensitize，如果有的话，
就返回自定义的序列化类的实例，创建实例时用到了注解中的参数。
该类还继承了com.fasterxml.jackson.databind.JsonSerializer类并重写了serialize方法，
该方法会判断脱敏的类型，执行具体的脱敏逻辑，这里用到了之前提到的脱敏工具类。
最后，新建接口进行验证：

1. @Getter
2. @Setter
3. public class CarInfoVO {
4.     @Desensitize(type = DesensitizeType.LICENSE_NUMBER)
5.     private String licenseNumber;
7.     @Desensitize(type = DesensitizeType.MOBILE_PHONE)
8.     private String ownerMobile;
10.     @Desensitize(type = DesensitizeType.ID_CARD)
11.     private String ownerIdCard;
13.     @Desensitize(type = DesensitizeType.BANK_CARD)
14.     private String ownerBankCardNo;
16.     @Desensitize(type = DesensitizeType.CUSTOM, startIndex = 0, endIndex = 1)
17.     private String ownerName;
18. }

复制代码

1. @GetMapping("/car/info")
2. @ResponseBody
3. public WebResult<CarInfoVO> queryCarInfo() {
4.     CarInfoVO carInfoVO = new CarInfoVO();
5.     carInfoVO.setLicenseNumber("沪B08U28");
6.     carInfoVO.setOwnerMobile("18216556791");
7.     carInfoVO.setOwnerIdCard("410328200001010007");
8.     carInfoVO.setOwnerBankCardNo("6214856213978533");
9.     carInfoVO.setOwnerName("叶子农");
11.     return WebResult.success(carInfoVO);
12. }

复制代码

输出结果：

4. 注意事项

4.1 无参构造函数不要删

上文中新建的自定义序列化类的无参构造函数表面上看没有任何调用，在IDEA中看着是下图这样的：

但千万不要手贱删除（我就手贱了，哈哈），否则会抛运行时异常：

4.2 自定义脱敏注解不生效

如果上文中提到的每一步都正常操作了，但自定义脱敏注解还是不生效：

那很可能是Spring Boot默认的消息转换器被替换成fastjson了，因为Spring Boot默认是使用jackson进行序列化的，上面的方案也是
基于jackson的，但如果项目中明确指定了使用fastjson进行序列化，那上面的自定义脱敏注解就不会生效：

1. @Bean
2. public HttpMessageConverters httpMessageConverters() {
3.     FastJsonConfig fastJsonConfig = new FastJsonConfig();
4.     fastJsonConfig.setSerializerFeatures(SerializerFeature.WriteMapNullValue, SerializerFeature.BrowserCompatible);
5.     FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
6.     fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
7.     return new HttpMessageConverters(fastJsonHttpMessageConverter);
8. }

复制代码

此时的解决方案是新建过滤器类，实现com.alibaba.fastjson.serializer.ValueFilter接口并重写process方法：

1. public class DesensitizeValueFilter implements ValueFilter {
2.     @Override
3.     public Object process(Object object, String name, Object value) {
4.         try {
5.             Field field = object.getClass().getDeclaredField(name);
6.             Desensitize desensitize = field.getAnnotation(Desensitize.class);
7.             if (desensitize == null) {
8.                 return value;
9.             }
10.             if (!(value instanceof String) || ((String) value).length() == 0) {
11.                 return value;
12.             }
13.             String valueStr = (String) value;
14.             DesensitizeType type = desensitize.type();
15.             switch (type) {
16.                 // 手机号脱敏
17.                 case MOBILE_PHONE:
18.                     return DesensitizedUtil.mobilePhone(valueStr);
19.                 // 车牌号脱敏
20.                 case LICENSE_NUMBER:
21.                     return DesensitizedUtil.carLicense(valueStr);
22.                 // 身份证号脱敏
23.                 case ID_CARD:
24.                     return DesensitizedUtil.idCardNum(valueStr, 3, 4);
25.                 // 银行卡脱敏
26.                 case BANK_CARD:
27.                     return DesensitizedUtil.bankCard(valueStr);
28.                 // 自定义脱敏
29.                 case CUSTOM:
30.                     return CharSequenceUtil.hide(valueStr, desensitize.startIndex(), desensitize.endIndex());
31.                 default:
32.                     break;
33.             }
34.         } catch (NoSuchFieldException e) {
35.             return value;
36.         }
37.         return value;
38.     }
39. }

复制代码

然后在上面声明httpMessageConverters()的地方新增以下代码：

1. fastJsonConfig.setSerializeFilters(new DesensitizeValueFilter());

复制代码

此时，上文中自定义的脱敏注解中，@JacksonAnnotationsInside和@JsonSerialize(using = DesensitizeSerializer.class)
可以移除：

再次运行验证，会发现自定义脱敏注解生效了：

4.3 注意影响范围

在VO的某个字段上加上@Desensitize(type = DesensitizeType.MOBILE_PHONE)后，所有使用到该VO的接口，在返回数据时，
该字段都会被脱敏，如果列表页接口和详情接口共用了这个VO，但实际情况是列表页该字段需要脱敏，编辑页该字段不需要脱敏，
这种场景就需要特别注意。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！