淺析如何在SpringBoot中實現(xiàn)數(shù)據(jù)脫敏

更新時間：2024年03月14日 08:40:31 作者：一只愛擼貓的程序猿

脫敏是指在不改變原數(shù)據(jù)結構的前提下,通過某種方式處理數(shù)據(jù),使數(shù)據(jù)不能直接暴露用戶的真實信息,下面我們就來看看SpringBoot中實現(xiàn)數(shù)據(jù)脫敏的具體方法吧

在Spring Boot項目中實現(xiàn)字段的脫敏通常涉及到敏感信息的處理，如用戶的姓名、電話號碼、電子郵件地址等。脫敏是指在不改變原數(shù)據(jù)結構的前提下，通過某種方式處理數(shù)據(jù)，使數(shù)據(jù)不能直接暴露用戶的真實信息。

通過Jackson序列化機制實現(xiàn)的關鍵點

1. 自定義注解 SensitiveInfo

自定義注解SensitiveInfo是一個標記，它讓我們能夠在字段上指定該字段需要進行脫敏處理，并定義脫敏類型。當Jackson序列化對象時，并不會直接處理這個注解，而是等待序列化器去識別并根據(jù)這個注解的屬性來執(zhí)行相應的邏輯。

2. 自定義序列化器 SensitiveInfoSerialize

SensitiveInfoSerialize繼承自JsonSerializer，并實現(xiàn)了ContextualSerializer接口。這個序列化器是脫敏邏輯的核心，其主要方法說明如下：

serialize：這是覆蓋自JsonSerializer的方法，定義了具體的序列化邏輯。當字段被序列化時，這個方法會被調用，并根據(jù)脫敏類型進行相應的處理。
createContextual：這是ContextualSerializer接口的方法。Jackson調用此方法來創(chuàng)建一個上下文感知的序列化器實例。此方法檢查被注解的字段，提取注解SensitiveInfo的類型，并用這個信息創(chuàng)建一個新的序列化器實例。

3. 序列化過程

當Jackson執(zhí)行序列化過程時，對于每個字段，它將檢查字段是否有自定義的序列化器。如果有（在下邊的例子中，是@JsonSerialize指定的SensitiveInfoSerialize），Jackson會使用這個序列化器來處理字段。

在序列化器中，createContextual方法會根據(jù)字段的SensitiveInfo注解確定需要使用的脫敏類型。這樣，每個字段都可以有其專屬的脫敏邏輯。

當?shù)竭_serialize方法時，序列化器已經(jīng)知道該如何處理字段（例如，是將電話號碼中間四位替換成星號，還是將郵箱的用戶名部分脫敏）。然后，它執(zhí)行相應的脫敏操作并輸出結果。

4. 動態(tài)性

這種設計的一個關鍵優(yōu)勢是其動態(tài)性。通過注解和自定義序列化器，我們可以在不同的字段上應用不同的脫敏規(guī)則，甚至可以在運行時改變脫敏行為。所有這些都不需要更改實體類本身的代碼，只需要修改注解或者序列化器的邏輯即可。

5. 解耦

這種方法還有助于將業(yè)務邏輯（如何脫敏）與數(shù)據(jù)結構（用戶實體）解耦。你可以在不影響實體類的情況下，通過修改序列化器來改變脫敏邏輯，使得代碼更加模塊化，易于維護和測試。

通過Jackson序列化機制實現(xiàn)的實例代碼

步驟 1：定義脫敏注解

首先，定義一個脫敏注解SensitiveInfo，用來標注需要脫敏的字段。

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SensitiveInfo {
    SensitiveType type();
}

enum SensitiveType {
    PHONE_NUMBER,
    EMAIL
}

步驟 2：創(chuàng)建自定義序列化器

然后，創(chuàng)建一個自定義的序列化器SensitiveInfoSerialize來處理標注了SensitiveInfo注解的字段。

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.introspect.Annotated;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;

import java.io.IOException;

public class SensitiveInfoSerialize extends JsonSerializer<String> implements ContextualSerializer {

    private SensitiveType type;

    public SensitiveInfoSerialize() {}

    public SensitiveInfoSerialize(SensitiveType type) {
        this.type = type;
    }

    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        switch (type) {
            case PHONE_NUMBER:
                gen.writeString(DesensitizationUtil.desensitizePhoneNumber(value));
                break;
            case EMAIL:
                gen.writeString(DesensitizationUtil.desensitizeEmail(value));
                break;
            default:
                gen.writeString(value);
        }
    }

    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) {
        Annotated annotated = property.getMember();
        SensitiveInfo sensitiveInfo = annotated.getAnnotation(SensitiveInfo.class);
        if (sensitiveInfo != null) {
            return new SensitiveInfoSerialize(sensitiveInfo.type());
        }
        return this;
    }
}

步驟 3：應用注解到實體類

在實體類User中，使用@JsonSerialize注解結合SensitiveInfo來指定哪些字段需要脫敏。

public class User {
    private String name;

    @JsonSerialize(using = SensitiveInfoSerialize.class)
    @SensitiveInfo(type = SensitiveType.PHONE_NUMBER)
    private String phoneNumber;

    @JsonSerialize(using = SensitiveInfoSerialize.class)
    @SensitiveInfo(type = SensitiveType.EMAIL)
    private String email;

    // 省略構造方法、getter和setter
}

步驟 4：序列化并驗證結果

現(xiàn)在，當我們序列化User對象時，指定的字段將自動進行脫敏處理。

public class Main {
    public static void main(String[] args) throws JsonProcessingException {
        User user = new User("Alice", "1234567890", "alice@example.com");
        ObjectMapper mapper = new ObjectMapper();
        String result = mapper.writeValueAsString(user);
        System.out.println(result);
    }
}

當運行上述代碼時，你將看到控制臺輸出脫敏后的用戶信息，其中電話號碼和郵箱字段已根據(jù)我們的脫敏邏輯進行了處理。

這種方法的優(yōu)點是脫敏邏輯與業(yè)務邏輯解耦，通過注解即可靈活地對任何字段進行脫敏，不需要修改實體類或者在每次序列化時手動調用脫敏方法。這樣做使得代碼更加清晰，易于維護。

到此這篇關于淺析如何在SpringBoot中實現(xiàn)數(shù)據(jù)脫敏的文章就介紹到這了,更多相關SpringBoot實現(xiàn)數(shù)據(jù)脫敏內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: