Springboot自定义注解完成数据脱敏

如题

• 最近发现一个有挺有用的数据脱敏饭方式，不需要任何其他的依赖，完全在Springboot项目内完成，原文在这，笔者此基础上添加了一个邮箱脱敏，特此记录一下。

 
 

定义枚举脱敏策略

import java.util.function.Function;

/**
 * @author unknown
 * @since 2023/08/19 15:04
 */
public enum SensitiveStrategy {

    /**
     * Username sensitive strategy.  $1 替换为正则的第一组  $2 替换为正则的第二组
     */
    /**
     * 地址
     */
    ADDRESS(new Function<String, String>() {
        @Override
        public String apply(String s) {
            return s.replaceAll("(\\S{3})\\S{2}(\\S*)\\S{2}", "$1****$2****");
        }
    }),
    /**
     * 电子邮件
     */
    EMAIL(new Function<String, String>() {
        @Override
        public String apply(String s) {
            return s.replaceAll("(?<=^.{3}).*(?=@)", "*****");
        }
    }),
    /**
     * 身份证号码
     */
    ID_CARD(new Function<String, String>() {
        @Override
        public String apply(String s) {
            return s.replaceAll("(\\d{3})\\d{13}(\\w{2})", "$1****$2");
        }
    }),
    /**
     * 手机号
     */
    PHONE(new Function<String, String>() {
        @Override
        public String apply(String s) {
            return s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2");
        }
    }),
    /**
     * 用户名称
     */
    USERNAME(new Function<String, String>() {
        @Override
        public String apply(String s) {
            return s.replaceAll("(\\S)\\S(\\S*)", "$1*$2");
        }
    });


    private final Function<String, String> deSerializer;

    /**
     * 定义构造函数，传入一个函数
     */
    SensitiveStrategy(Function<String, String> deSerializer) {
        this.deSerializer = deSerializer;
    }

    /**
     * getter方法
     */
    public Function<String, String> deSerializer() {
        return deSerializer;
    }

 
 

自定义注解

• 将自定义的 JSON 序列化和脱敏策略绑定在一起

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author unknown
 * @since 2023/08/19 15:07
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside //将多个注解组合到一起
@JsonSerialize(using = SensitiveJsonSerializer.class) //声明使用自定义的序列化器
public @interface Sensitive {
    
    SensitiveStrategy strategy();
}

 
 

自定义脱敏序列化

/**
 * @author unknown
 * @since 2023/08/19 15:13
 */
public class SensitiveJsonSerializer extends JsonSerializer<String> implements ContextualSerializer {
    private SensitiveStrategy strategy;


    //serialize方法执行脱敏序列化逻辑
    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        // 返一个Function
//        Function<String, String> stringStringFunction = strategy.deSerializer();
        // Function.apply(value) 执行枚举里面定义的脱敏方法
        gen.writeString(strategy.deSerializer().apply(value));
    }

    //reateContextual方法用来获取实体类上的@Sensitive注解并根据条件初始化对应的JsonSerializer对象;
    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException {
        Sensitive annotation = property.getAnnotation(Sensitive.class);
        if (Objects.nonNull(annotation) && Objects.equals(String.class, property.getType().getRawClass())) {
            this.strategy = annotation.strategy();
            return this;
        }
        return prov.findValueSerializer(property.getType(), property);
    }
}

 
 

使用注解

• 笔者是添加在返回的VO中，这样在内部操作时不会影响其他逻辑操作

public class UserFindByIdResponseVO {

    /**
     * <p>主键</p>
     */
    private String userId;

    /**
     * <p>电话号码</p>
     */
    @Sensitive(strategy = SensitiveStrategy.PHONE)
    private String phoneNumber;

    /**
     * <p>邮箱-登录验证</p>
     */
    @Sensitive(strategy = SensitiveStrategy.EMAIL)
    private String email;

 
 

结果验证