当前位置：首页 > article >正文

springboot jackson 数据脱敏

article 2024/10/23 20:53:43

整体思路

对于一个class 包含多个字段，哪个字段是敏感字段，该字段是手机号还是邮箱，希望如何进行脱敏，这些需要被定义，因此第一步定义《敏感注解》
将注解放到指定得class的字段上，并且标记是邮箱还是手机号
重写序列化逻辑，将明文手机号替换为密文

第一步：定义注解
其中
@Target(ElementType.FIELD) 表示要修饰的内容是字段
@JsonSerialize(using = SensitiveJsonSerializer.class) 表示具体的序列化方法要使用SensitiveJsonSerializer定义的，该SensitiveJsonSerializer后面会说到。
DesensitizedType desensitizedType(); 表示使用注解时，可以传递一个参数，该参数时一个方法

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

DesensitizedType 定义如下

public enum DesensitizedType
{
    /**
     * 姓名，第2位星号替换
     */
    USERNAME(s -> s.replaceAll("(\\S)\\S(\\S*)", "$1*$2")),

    /**
     * 身份证，中间10位星号替换
     */
    ID_CARD(s -> s.replaceAll("(\\d{4})\\d{10}(\\d{4})", "$1** **** ****$2")),

    /**
     * 手机号，中间4位星号替换
     */
    PHONE(s -> s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2")),

    /**
     * 电子邮箱，仅显示第一个字母和@后面的地址显示，其他星号替换
     */
    EMAIL(s -> s.replaceAll("(^.)[^@]*(@.*$)", "$1****$2")),

    /**
     * 银行卡号，保留最后4位，其他星号替换
     */
    BANK_CARD(s -> s.replaceAll("\\d{15}(\\d{3})", "**** **** **** **** $1"));


    private final Function<String, String> desensitizer;

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

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

第二步：修饰字段，指明该字段问密文字段 email

public class User {
    @Sensitive(desensitizedType = DesensitizedType.EMAIL)
    private String name;

    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

第三步，重写序列化逻辑

    private DesensitizedType desensitizedType;

    @Override
    public void serialize(String s, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        jsonGenerator.writeString(desensitizedType.desensitizer().apply(s));
    }

    @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.desensitizedType = annotation.desensitizedType();
            return this;
        }
        return prov.findValueSerializer(property.getType(), property);
    }