使用Spring Boot实现数据脱敏

使用Spring Boot实现数据脱敏

数据脱敏是指对敏感数据进行部分或全部隐藏，以确保数据在传输和使用过程中不被泄露。数据脱敏在保护用户隐私和满足合规性要求方面起着至关重要的作用。以下是如何使用Spring Boot实现数据脱敏的详细步骤。

1. 创建Spring Boot项目

首先，创建一个Spring Boot项目，可以使用Spring Initializr生成项目结构。添加如下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

2. 配置数据库连接

在 application.properties文件中配置数据库连接信息：

spring.datasource.url=jdbc:mysql://localhost:3306/your_database
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.jpa.hibernate.ddl-auto=update

3. 创建数据脱敏注解

定义一个自定义注解 @Sensitive来标记需要脱敏的字段：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Sensitive {
}

4. 创建数据脱敏工具类

实现一个工具类 SensitiveDataUtils，用于实际执行数据脱敏：

public class SensitiveDataUtils {

    public static String mask(String value) {
        if (value == null || value.isEmpty()) {
            return value;
        }
        int length = value.length();
        int maskLength = length / 2;
        StringBuilder maskedValue = new StringBuilder(value.substring(0, length - maskLength));
        for (int i = 0; i < maskLength; i++) {
            maskedValue.append('*');
        }
        return maskedValue.toString();
    }
}

5. 创建数据脱敏序列化器

创建一个自定义的Jackson序列化器 SensitiveSerializer，在序列化过程中执行脱敏操作：

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

import java.io.IOException;
import java.lang.reflect.Field;

public class SensitiveSerializer extends JsonSerializer<Object> {

    @Override
    public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeStartObject();
        Field[] fields = value.getClass().getDeclaredFields();
        for (Field field : fields) {
            field.setAccessible(true);
            try {
                Object fieldValue = field.get(value);
                if (field.isAnnotationPresent(Sensitive.class)) {
                    fieldValue = SensitiveDataUtils.mask(fieldValue.toString());
                }
                gen.writeObjectField(field.getName(), fieldValue);
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        gen.writeEndObject();
    }
}

6. 应用数据脱敏序列化器

在配置类中注册自定义的序列化器：

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class JacksonConfig {

    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        SimpleModule module = new SimpleModule();
        module.addSerializer(Object.class, new SensitiveSerializer());
        objectMapper.registerModule(module);
        return objectMapper;
    }
}

7. 创建实体类

创建一个包含敏感数据的实体类，并使用 @Sensitive注解标记需要脱敏的字段：

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    @Sensitive
    private String phoneNumber;

    @Sensitive
    private String email;

    // Getters and setters
}

8. 创建Controller

创建一个Controller来测试数据脱敏功能：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserRepository userRepository;

    @GetMapping
    public List<User> getUsers() {
        return userRepository.findAll();
    }
}

9. 测试数据脱敏功能

启动Spring Boot应用，访问 /users接口，可以看到返回的用户数据中的敏感字段已经被脱敏。

思维导图

- 使用Spring Boot实现数据脱敏
  - 创建Spring Boot项目
  - 配置数据库连接
  - 创建数据脱敏注解
  - 创建数据脱敏工具类
  - 创建数据脱敏序列化器
  - 应用数据脱敏序列化器
  - 创建实体类
  - 创建Controller
  - 测试数据脱敏功能

总结

通过上述步骤，您可以使用Spring Boot实现数据脱敏功能。在实际应用中，可以根据具体需求调整脱敏逻辑和策略，以确保敏感数据在传输和展示过程中得到有效保护。这种方法不仅可以提高数据安全性，还能满足合规性要求，保护用户隐私。