原来还可以这样实现数据脱敏，学到了

前言

在项目中，有一些敏感的数据是不能直接展示的，比如手机号、身份证号等。这些数据是需要我们进行脱敏之后才返回的，脱敏即是对数据的部分信息进行屏蔽处理，比如我们经常看到的手机号中间4位使用****显示。

最简单的处理方法就是在返回给客户端的对象上进行处理后再返回，但是这样做过于硬编码，不易修改和维护。

下面的方法是我在网上看到的一个方法，它采用了注解声明序列化方式的方法进行属性的处理，十分简洁方便，下面就来看一下吧

注：下面的方法适用于Jackson序列化

1、定义脱敏的策略

首先我们根据自己的业务需求来定义相应的脱敏策略，代码如下

/**
 * 自定义脱敏策略
 */
public enum  SensitiveStrategy {

    /**
     * 用户名脱敏
     */
    USERNAME(s -> s.replaceAll("(.).*", "$1***")),

    /**
     * 手机号脱敏
     */
    PHONE(s -> s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2")),

    /**
     * 身份证脱敏
     */
    ID_CARD(s -> s.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1****$2")),
    ;

    /**
     * 一个function函数
     */
    private final Function<String, String> desensitizer;

    SensitiveStrategy(Function<String, String> desensitizer) {
        this.desensitizer = desensitizer;
    }

    public Function<String, String> getDesensitizer() {
        return desensitizer;
    }


}

2、自定义序列化方式

JsonSerializer是Jackson的序列化器，用于定义如何序列化

ContextualSerializer 是Jackson提供的一个序列化相关的接口，它的作用是通过字段已知的上下文信息定制 JsonSerializer ，只需要实现 createContextual 方法即可

下面是我自定义的一个序列化器，大家可以参考

public class SensitiveJsonSerializer extends JsonSerializer<String> implements ContextualSerializer {

    private SensitiveStrategy sensitiveStrategy;

    /**
     *
     * @param value 需要序列化的值，不能为null
     * @param jsonGenerator 用于输出结果Json的内容
     * @param serializerProvider 可以用来获取序列化器
     * @throws IOException
     */
    @Override
    public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        //通过getDesensitizer获取脱敏方法，apply方法将value作为入参执行脱敏方法
        jsonGenerator.writeString(sensitiveStrategy.getDesensitizer().apply(value));
    }

    /**
     *
     * @param prov 用于访问配置
     * @param property 表示属性的方法或字段(用于访问要序列化的值)
     * @return 返回一个JsonSerializer用于序列化指定属性的值;
     * @throws JsonMappingException
     */
    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException {
        //获取字段上的自定义脱敏注解
        Sensitive annotation = property.getAnnotation(Sensitive.class);
        //注解需要不为null而且需要是String类型
        if (Objects.nonNull(annotation) && Objects.equals(String.class,property.getType().getRawClass())){
            this.sensitiveStrategy=annotation.strategy();
            return this;
        }
        return prov.findValueSerializer(property.getType(), property);
    }
}

3、自定义脱敏注解

我们使用自定义注解来标识需要脱敏的字段，这样灵活性和方便性都较好，所以我们需要自定义一个注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveJsonSerializer.class)
public @interface Sensitive {

    SensitiveStrategy strategy();

}

4、使用

只要我们把自定义的注解标识到需要脱敏的字段，选择对应的脱敏策略（该类需要序列化【implements Serializable】）

  @Sensitive(strategy=SensitiveStrategy.USERNAME)
  private String name;

那么在将该json对象返回给前端时，就会对该字段进行相应的脱敏策略