快捷導(dǎo)航

SpringBoot3使用?自定義注解＋Jackson實(shí)現(xiàn)接口數(shù)據(jù)脫敏的步驟

更新時(shí)間：2024年03月26日 10:38:19 作者：蒾酒

本文介紹了一種以?xún)?yōu)雅的方式實(shí)現(xiàn)對(duì)接口返回的敏感數(shù)據(jù),如手機(jī)號(hào)、郵箱、身份證等信息的脫敏處理,這種方法也是企業(yè)常用方法,話不多說(shuō)我們一起來(lái)看一下吧

寫(xiě)在前面

本文介紹了springboot開(kāi)發(fā)后端服務(wù)中，接口數(shù)據(jù)脫敏優(yōu)雅的設(shè)計(jì)與實(shí)現(xiàn)，堅(jiān)持看完相信對(duì)你有幫助。

內(nèi)容簡(jiǎn)介

本文介紹了一種以?xún)?yōu)雅的方式實(shí)現(xiàn)對(duì)接口返回的敏感數(shù)據(jù)，如手機(jī)號(hào)、郵箱、身份證等信息的脫敏處理。這種方法也是企業(yè)常用方法。話不多說(shuō)我們一起來(lái)看一下吧。

效果展示：

實(shí)現(xiàn)思路

自定義一個(gè)脫敏注解用于標(biāo)記需要脫敏的字段，并且在注解中指定脫敏策略屬性。
自定義脫敏策略枚舉類(lèi)，用于維護(hù)手機(jī)號(hào)、郵箱、身份證等信息的脫敏處理方式。
自定義脫敏 JSON 序列化器，在該序列化器中找到帶有該注解的字段，根據(jù)注解中指定的脫敏策略，在序列化過(guò)程中將數(shù)據(jù)進(jìn)行脫敏處理并輸出到 JSON 中。

實(shí)現(xiàn)步驟

1.自定義脫敏注解

 
import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.mijiu.commom.custom.serializable.DesensitizationJsonSerializable;
import com.mijiu.commom.enumerate.DesensitizationStrategyEnum;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * @author mijiupro
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = DesensitizationJsonSerializable.class)
public @interface Desensitization {
    DesensitizationStrategyEnum desensitizationStrategy();//這是自定義的脫敏策略枚舉類(lèi)型，用于指定脫敏策略，獲取對(duì)應(yīng)脫敏處理方法
 
}

2.編寫(xiě)脫敏策略枚舉類(lèi)

脫敏的本質(zhì)其實(shí)就是個(gè)字符串的替換，我們?cè)诿撁舨呗悦杜e類(lèi)中通過(guò)定義函數(shù)接口，維護(hù)多種類(lèi)型脫敏策略對(duì)應(yīng)的字符串替換方法。這樣做可以保證可維護(hù)性可擴(kuò)展性。

import lombok.Getter;
 
import java.util.function.Function;
 
 
/**
 * 脫敏策略枚舉類(lèi)，維護(hù)對(duì)不同類(lèi)型信息的脫敏處理方式
 * @author mijiupro
 */
@Getter
public enum DesensitizationStrategyEnum {
 
    // 手機(jī)號(hào)脫敏策略，保留前三位和后四位
    PHONE(s -> s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2")),
 
    // 郵箱脫敏策略，保留郵箱用戶(hù)名第一個(gè)字符和@符號(hào)前后部分
    EMAIL(s -> s.replaceAll("(\\w)[^@]*(@\\w+\\.\\w+)", "$1****$2")),
 
    // 身份證號(hào)脫敏策略，保留前四位和后四位
    ID_CARD(s -> s.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1*****$2")),
 
    // 地址脫敏策略，保留省市信息，其余部分脫敏為**
    ADDRESS(s -> s.replaceAll("([\\u4e00-\\u9fa5]{2})[\\u4e00-\\u9fa5]+", "$1**")),
 
    // 銀行卡號(hào)脫敏策略，保留前四位和后三位
    BANK_CARD(s -> s.replaceAll("(\\d{4})\\d{8,12}(\\d{3})", "$1************$2")),
 
    // 姓名脫敏策略，保留姓氏第一個(gè)字符，其余部分脫敏為**
    NAME(s -> s.charAt(0) + "**"),
 
    // 密碼脫敏策略，統(tǒng)一顯示為******
    PASSWORD(s -> "******");
 
    private final Function<String, String> desensitization;
 
    DesensitizationStrategyEnum(Function<String, String> desensitization) {
        this.desensitization = desensitization;
    }
 
}

3.編寫(xiě)JSON序列化實(shí)現(xiàn)

需要清楚

平時(shí)接口返回的數(shù)據(jù)結(jié)構(gòu)直接都是交給默認(rèn)的序列化器把對(duì)象轉(zhuǎn)成json的。
實(shí)現(xiàn)脫敏的本質(zhì)就是在這前面添加了一段邏輯，找到帶有脫敏注解的屬性然后拿到注解指定的脫敏策略實(shí)例化這個(gè)脫敏策略枚舉類(lèi)，應(yīng)用對(duì)應(yīng)的脫敏方法處理需要脫敏字段，得到脫敏后的值交給json生成器得到最終脫敏后的json

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.*;
 
import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import com.mijiu.commom.annotation.Desensitization;
import com.mijiu.commom.enumerate.DesensitizationStrategyEnum;
 
import java.io.IOException;
import java.util.Objects;
 
/**
 * 自定義的脫敏JSON序列化器
 * @author mijiupro
 */
 
 
public class DesensitizationJsonSerializable extends JsonSerializer<String> implements ContextualSerializer {
 
    private DesensitizationStrategyEnum desensitizationStrategy; // 脫敏策略
 
    @Override
    public void serialize(String s, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        // 將字符串按照設(shè)定的脫敏策略進(jìn)行脫敏處理后序列化到 JSON 中
        jsonGenerator.writeString(desensitizationStrategy.getDesensitization().apply(s));
    }
 
    @Override
    public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty) throws JsonMappingException {
        // 獲取屬性上的 Desensitization 注解
        Desensitization annotation = beanProperty.getAnnotation(Desensitization.class);
 
        // 判斷注解不為空且屬性類(lèi)型為 String
        if (Objects.nonNull(annotation) && Objects.equals(String.class, beanProperty.getType().getRawClass())) {
            this.desensitizationStrategy = annotation.desensitizationStrategy(); // 設(shè)置脫敏策略
            return this;
        }
 
        // 返回默認(rèn)的序列化器
        return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
    }
}

4.編寫(xiě)測(cè)試類(lèi)

/**
 * @author mijiupro
 */
@Data
@Builder
public class PersonalInfo {
 
    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.PHONE)
    private String phone; // 手機(jī)號(hào)
 
    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.EMAIL)
    private String email; // 郵箱
 
    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.ID_CARD)
    private String idCard; // 身份證號(hào)
 
    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.ADDRESS)
    private String address; // 地址
 
    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.BANK_CARD)
    private String bankCard; // 銀行卡號(hào)
 
    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.NAME)
    private String name; // 姓名
 
    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.PASSWORD)
    private String password; // 密碼
 
}

5.編寫(xiě)測(cè)試接口

/**
 * @author mijiupro
 */
@RestController
@RequestMapping("/test/desensitization")
@Tag(name = "脫敏測(cè)試接口", description = "脫敏測(cè)試接口")
public class DesensitizationTestController {
    @GetMapping("/get-info")
    @Operation(summary = "獲取脫敏信息")
    public PersonalInfo getInt() {
 
 
        return PersonalInfo.builder()
                .name("言冰云")
                .phone("13812345678")
                .email("mijiu@qq.com")
                .idCard("110101199003073321")
                .address("四川省成都市郫都區(qū)百草路一號(hào)")
                .password("1234567890")
                .bankCard("62220210001234567890")
                .build();
    }
}