一個注解優雅的實現接口數據脫敏

作者：不才陳某 2024-11-07 10:55:26

開發前端

通常接口返回值中的一些敏感數據也是要脫敏的，比如身份證號、手機號碼、地址.....通常的手段就是用*隱藏一部分數據，當然也可以根據自己需求定制。

大家好，我是不才陳某~

言歸正傳，如何優雅的實現呢？有兩種實現方案，如下：

整合Mybatis插件，在查詢的時候針對特定的字段進行脫敏
整合Jackson，在序列化階段對特定字段進行脫敏

第一種方案網上很多實現方式，下面演示第二種，整合Jackson。

1. 自定義一個Jackson注解

需要自定義一個脫敏注解，一旦有屬性被標注，則進行對應得脫敏，如下：

/**
 * 自定義jackson注解，標注在屬性上
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveJsonSerializer.class)
public @interface Sensitive {
    //脫敏策略
    SensitiveStrategy strategy();
}

2. 定制脫敏策略

針對項目需求，定制不同字段的脫敏規則，比如手機號中間幾位用*替代，如下：

/**
 * 脫敏策略，枚舉類，針對不同的數據定制特定的策略
 */
public enum SensitiveStrategy {
    /**
     * 用戶名
     */
    USERNAME(s -> s.replaceAll("(\\S)\\S(\\S*)", "$1*$2")),
    /**
     * 身份證
     */
    ID_CARD(s -> s.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1****$2")),
    /**
     * 手機號
     */
    PHONE(s -> s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2")),
    /**
     * 地址
     */
    ADDRESS(s -> s.replaceAll("(\\S{3})\\S{2}(\\S*)\\S{2}", "$1****$2****"));


    private final Function<String, String> desensitizer;

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

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

以上只是提供了部分，具體根據自己項目要求進行配置。

3. 定制JSON序列化實現

下面將是重要實現，對標注注解@Sensitive的字段進行脫敏，實現如下：

/**
 * 序列化注解自定義實現
 * JsonSerializer<String>：指定String 類型，serialize()方法用于將修改后的數據載入
 */
public class SensitiveJsonSerializer extends JsonSerializer<String> implements ContextualSerializer {
    private SensitiveStrategy strategy;

    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeString(strategy.desensitizer().apply(value));
    }

    /**
     * 獲取屬性上的注解屬性
     */
    @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);

    }
}

4. 定義Person類，對其數據脫敏

使用注解@Sensitive注解進行數據脫敏，代碼如下：

@Data
public class Person {
    /**
     * 真實姓名
     */
    @Sensitive(strategy = SensitiveStrategy.USERNAME)
    private String realName;
    /**
     * 地址
     */
    @Sensitive(strategy = SensitiveStrategy.ADDRESS)
    private String address;
    /**
     * 電話號碼
     */
    @Sensitive(strategy = SensitiveStrategy.PHONE)
    private String phoneNumber;
    /**
     * 身份證號碼
     */
    @Sensitive(strategy = SensitiveStrategy.ID_CARD)
    private String idCard;
}

5. 模擬接口測試

以上4個步驟完成了數據脫敏的Jackson注解，下面寫個controller進行測試，代碼如下：

@RestController
public class TestController {
    @GetMapping("/test")
    public Person test(){
        Person user = new Person();
        user.setRealName("不才陳某");
        user.setPhoneNumber("19796328206");
        user.setAddress("浙江省杭州市....");
        user.setIdCard("4333333333334334333");
        return user;
    }
}

調用接口查看數據有沒有正常脫敏，結果如下：

{
    "realName": "不*陳某",
    "address": "浙江省****市..****",
    "phoneNumber": "197****8206",
    "idCard": "4333****34333"
}

6. 總結

數據脫敏有很多種實現方式，關鍵是哪種更加適合，哪種更加優雅.....

責任編輯：武曉燕來源：碼猿技術專欄

接口數據脫敏