SpringBoot实战：轻松实现接口数据脱敏

2024-07-15 14:25 由自足发表于 #后端开发

引言

在现代的互联网应用中，数据安全和隐私保护变得越来越重要。尤其是在接口返回数据时，如何有效地对敏感数据进行脱敏处理，是每个开发者都需要关注的问题。本文将通过一个简单的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写论文