Spring Boot中的数据脱敏处理
今天我们来探讨一下在Spring Boot中如何进行数据脱敏处理。
1. 引言
数据脱敏是指对敏感数据进行部分或全部掩盖，以保护数据隐私。在实际应用中，我们常常需要在日志、API响应或者数据库中对敏感数据进行脱敏处理，比如身份证号、手机号、邮箱地址等。Spring Boot提供了强大的框架支持，使得我们可以轻松地实现数据脱敏。
2. 数据脱敏的场景
常见的数据脱敏场景包括：
- 日志记录：防止敏感信息在日志中泄露。
- API响应：保护用户隐私，防止敏感信息暴露给客户端。
- 数据库存储：在存储之前对数据进行脱敏处理，以确保数据安全。
3. 定义脱敏注解
我们首先定义一个注解@SensitiveData，用于标记需要脱敏的字段。
package cn.juwatech.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface SensitiveData {
SensitiveType value();
}
同时，我们定义一个枚举SensitiveType来表示不同的脱敏类型。
package cn.juwatech.annotation;
public enum SensitiveType {
CHINESE_NAME, ID_CARD, PHONE_NUMBER, EMAIL
}
4. 实现脱敏处理器
接下来，我们实现一个脱敏处理器SensitiveDataSerializer，用于对标记了@SensitiveData注解的字段进行脱敏处理。
package cn.juwatech.util;
import cn.juwatech.annotation.SensitiveData;
import cn.juwatech.annotation.SensitiveType;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
public class SensitiveDataSerializer extends JsonSerializer<String> {
@Override
public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
SensitiveData sensitiveData = serializers.getActiveView().getAnnotation(SensitiveData.class);
if (sensitiveData != null) {
SensitiveType type = sensitiveData.value();
switch (type) {
case CHINESE_NAME:
gen.writeString(maskChineseName(value));
break;
case ID_CARD:
gen.writeString(maskIdCard(value));
break;
case PHONE_NUMBER:
gen.writeString(maskPhoneNumber(value));
break;
case EMAIL:
gen.writeString(maskEmail(value));
break;
default:
gen.writeString(value);
}
} else {
gen.writeString(value);
}
}
private String maskChineseName(String name) {
if (name.length() <= 1) {
return "*";
}
return name.charAt(0) + "*".repeat(name.length() - 1);
}
private String maskIdCard(String idCard) {
return idCard.replaceAll("(\\d{4})\\d{10}(\\d{4})", "$1******$2");
}
private String maskPhoneNumber(String phoneNumber) {
return phoneNumber.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2");
}
private String maskEmail(String email) {
int atIndex = email.indexOf("@");
if (atIndex <= 1) {
return "*".repeat(atIndex) + email.substring(atIndex);
}
return email.charAt(0) + "*".repeat(atIndex - 1) + email.substring(atIndex);
}
}
5. 配置Jackson
为了让Jackson在序列化时使用我们的脱敏处理器，我们需要进行相关配置。
package cn.juwatech.config;
import cn.juwatech.util.SensitiveDataSerializer;
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(String.class, new SensitiveDataSerializer());
objectMapper.registerModule(module);
return objectMapper;
}
}
6. 使用脱敏注解
现在我们可以在需要脱敏的字段上使用@SensitiveData注解。例如：
package cn.juwatech.model;
import cn.juwatech.annotation.SensitiveData;
import cn.juwatech.annotation.SensitiveType;
public class User {
private String username;
@SensitiveData(SensitiveType.CHINESE_NAME)
private String realName;
@SensitiveData(SensitiveType.ID_CARD)
private String idCard;
@SensitiveData(SensitiveType.PHONE_NUMBER)
private String phoneNumber;
@SensitiveData(SensitiveType.EMAIL)
private String email;
// Getters and Setters
}
7. 控制器示例
最后，我们编写一个控制器来测试数据脱敏功能。
package cn.juwatech.controller;
import cn.juwatech.model.User;
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.setUsername("johndoe");
user.setRealName("张三");
user.setIdCard("123456789012345678");
user.setPhoneNumber("13800138000");
user.setEmail("johndoe@example.com");
return user;
}
}
启动Spring Boot应用并访问/user端点，可以看到返回的JSON中敏感数据已经被脱敏处理。
8. 总结
本文介绍了在Spring Boot中如何进行数据脱敏处理。通过自定义注解和Jackson配置，我们可以轻松实现对敏感数据的脱敏，保护用户隐私。在实际应用中，我们可以根据具体需求灵活调整脱敏策略，确保数据安全。
