SpringBoot實戰：輕鬆實現介面資料脫敏

自足發表於2024-07-15
Spring Boot

引言

在現代的網際網路應用中，資料安全和隱私保護變得越來越重要。尤其是在介面返回資料時，如何有效地對敏感資料進行脫敏處理，是每個開發者都需要關注的問題。本文將透過一個簡單的Spring Boot專案，介紹如何實現介面資料脫敏。

一、介面資料脫敏概述

1.1 介面資料脫敏的定義

介面資料脫敏是指在介面返回資料時，對其中的敏感資訊進行處理，使其無法直接被識別和利用。例如，將使用者的身份證號、手機號等資訊進行部分隱藏。

1.2 介面資料脫敏的重要性

  • 保護使用者隱私：防止使用者的敏感資訊被洩露。
  • 合規要求：滿足相關法律法規對資料保護的要求。
  • 減少風險：降低資料被惡意利用的風險。

1.3 介面資料脫敏的實現方式

常見的脫敏方式包括：

  • 字元替換：用特定字元替換敏感資訊的一部分。
  • 字元隱藏：隱藏敏感資訊的一部分字元。
  • 自定義規則：根據業務需求自定義脫敏規則。

二、開發環境

  • IDE：IntelliJ IDEA
  • JDK：1.8+
  • Spring Boot：2.5.4

三、實現介面返回資料脫敏

3.1 新增依賴

首先，在pom.xml中新增必要的依賴：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
    </dependency>
</dependencies>

3.2 建立自定義註解

建立一個自定義註解@Sensitive，用於標識需要脫敏的欄位：

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 Sensitive {
    SensitiveType type();
}

3.3 定義脫敏列舉類

定義一個列舉類SensitiveType，用於指定脫敏的型別：

public enum SensitiveType {
    MOBILE,
    ID_CARD,
    EMAIL
}

3.4 建立自定義序列化類

建立一個自定義序列化類SensitiveSerializer，實現脫敏邏輯：

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

import java.io.IOException;

public class SensitiveSerializer extends JsonSerializer<String> {

    private final SensitiveType type;

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

    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        switch (type) {
            case MOBILE:
                gen.writeString(value.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"));
                break;
            case ID_CARD:
                gen.writeString(value.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1******$2"));
                break;
            case EMAIL:
                gen.writeString(value.replaceAll("(^[^@]{3})[^@]*(@.*$)", "$1****$2"));
                break;
            default:
                gen.writeString(value);
        }
    }
}

四、測試

4.1 編寫測試程式碼

建立一個簡單的使用者類，並在欄位上使用@Sensitive註解：

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

public class User {
    private String name;

    @Sensitive(type = SensitiveType.MOBILE)
    @JsonSerialize(using = SensitiveSerializer.class)
    private String mobile;

    @Sensitive(type = SensitiveType.ID_CARD)
    @JsonSerialize(using = SensitiveSerializer.class)
    private String idCard;

    @Sensitive(type = SensitiveType.EMAIL)
    @JsonSerialize(using = SensitiveSerializer.class)
    private String email;

    // getters and setters
}

建立一個控制器，返回使用者資訊：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @GetMapping("/user")
    public User getUser() {
        User user = new User();
        user.setName("張三");
        user.setMobile("13812345678");
        user.setIdCard("123456789012345678");
        user.setEmail("example@example.com");
        return user;
    }
}

4.2 測試

啟動Spring Boot應用，訪問/user介面，檢視返回結果：

{
    "name": "張三",
    "mobile": "138****5678",
    "idCard": "1234******5678",
    "email": "exa****@example.com"
}

五、總結

透過本文的示例，我們瞭解瞭如何在Spring Boot中實現介面資料脫敏。透過自定義註解和序列化類，可以靈活地對不同型別的敏感資料進行處理，保護使用者的隱私資訊。

希望本文對你有所幫助，如果你有任何問題或建議，歡迎在評論區留言。

百萬大學生都在用的AI寫論文工具，篇篇無重複👉：AI寫論文

相關文章