springboot3使用​自定义注解＋Jackson优雅实现接口数据脱敏

在现代应用中，数据安全与隐私保护变得越来越重要，尤其是在处理用户隐私数据时。如果我们在使用Spring Boot开发RESTful接口时，希望实现一些数据的脱敏处理，可以考虑结合自定义注解和Jackson库来优雅地完成这一需求。本文将介绍如何使用Spring Boot 3实现数据脱敏的功能。

一、什么是数据脱敏

数据脱敏是对敏感信息进行处理，确保在不暴露真实数据的情况下，仍能够满足业务需求。例如，将用户的身份证号码、手机号等信息进行部分隐藏，显现的只是一些数字而不是完整的数据。

二、实现思路

我们可以通过自定义注解标记需要脱敏的字段，然后利用Jackson的序列化功能，在将对象转换为JSON时进行处理。具体步骤如下：

1. 定义自定义注解。
2. 实现自定义序列化逻辑。
3. 在实体类中使用该注解。
4. 测试效果。

三、代码示例

1. 定义自定义注解

首先，我们定义一个名为@Sensitive的自定义注解，用于标注需要脱敏的字段。

package com.example.demo.annotation;

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 {
    // 可以扩展注解属性，指定脱敏类型
}

2. 实现自定义序列化逻辑

接下来，我们通过Jackson的JsonSerializer来实现脱敏的逻辑。创建一个SensitiveSerializer类，用于处理带有@Sensitive注解的字段。

package com.example.demo.serializer;

import com.example.demo.annotation.Sensitive;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import org.springframework.stereotype.Component;

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

@Component
public class SensitiveSerializer extends JsonSerializer<Object> {

    @Override
    public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        // 使用反射获取注解信息
        Field[] fields = value.getClass().getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(Sensitive.class)) {
                field.setAccessible(true);
                String originalValue = (String) field.get(value);
                // 脱敏处理：这里只是简单地保留前3位和后4位
                String maskedValue = originalValue.replaceAll("(?<=\\w{3})\\w(?=\\w{4})", "*");
                gen.writeString(maskedValue);
                return;
            }
        }
        // 默认行为
        gen.writeObject(value);
    }
}

3. 在实体类中使用该注解

然后，我们在需要脱敏的实体类中使用@Sensitive注解标记需要脱敏的字段。

package com.example.demo.model;

import com.example.demo.annotation.Sensitive;

public class User {
    private String name;

    @Sensitive
    private String phoneNumber;

    // 构造器、getter和setter省略
}

4. 配置Jackson使用自定义序列化器

最后，我们需要在Spring Boot的配置中注册这个自定义序列化器，使其在序列化时生效。

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;
    }
}

5. 测试效果

现在，我们可以创建一个控制器来测试这一功能。

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

    @GetMapping("/info")
    public User getUserInfo() {
        User user = new User();
        user.setName("张三");
        user.setPhoneNumber("13912345678"); // 敏感信息
        return user;
    }
}

四、总结

通过以上步骤，我们可以很方便地在Spring Boot 3中使用自定义注解及Jackson库实现接口数据的脱敏处理。这种方法既灵活又易于维护，也能够根据业务需求进行扩展。希望本文能对你的项目开发有所帮助！