轻松搞定！SpringBoot中Jackson脱敏处理自定义注解

后端

2023-01-21 06:15:46

SpringBoot 中的 Jackson 脱敏处理

什么是脱敏处理？

在日常开发中，我们经常需要对某些敏感字段进行脱敏处理。脱敏处理是指将敏感信息替换成星号 (*) 或其他字符，以防止未经授权的人员访问或泄露这些信息。常见的需要脱敏处理的字段包括：

用户密码
身份证号
手机号
电子邮箱地址

Jackson 是什么？

Jackson 是一个用于 Java 的流行 JSON 库，它提供了强大的序列化和反序列化功能。SpringBoot 内置了 Jackson，我们可以利用它来轻松地实现字段的脱敏处理。

如何使用 Jackson 进行脱敏处理？

Jackson 默认情况下不会对任何字段进行脱敏处理。要对某个字段进行脱敏，我们需要执行以下步骤：

创建自定义注解

首先，我们需要创建一个自定义注解来标记需要脱敏的字段。这个注解必须继承 Jackson 提供的 @JacksonAnnotation 注解。例如，我们可以创建一个名为 @Sensitive 的注解：
```
import com.fasterxml.jackson.annotation.JacksonAnnotation;

public @interface Sensitive extends JacksonAnnotation {

}
```
在字段上添加注解

接下来，我们需要在需要脱敏的字段上添加 @Sensitive 注解。例如，假设我们有一个 User 类，其中有一个名为 password 的字段：
```
public class User {

    private String username;

    @Sensitive
    private String password;

}
```

配置 Jackson

最后，我们需要配置 Jackson，让它能够识别我们的自定义注解。我们在 SpringBoot 项目中添加以下配置：

@Configuration
public class JacksonConfig {

    @Bean
    public Jackson2ObjectMapper jacksonObjectMapper() {
        Jackson2ObjectMapper objectMapper = new Jackson2ObjectMapper();
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        objectMapper.registerModule(new SimpleModule().addSerializer(String.class, new SensitiveSerializer()));
        return objectMapper;
    }

}

代码示例

以下是一个完整的代码示例，演示如何使用 Jackson 在 SpringBoot 中对字段进行脱敏处理：

import com.fasterxml.jackson.annotation.JacksonAnnotation;

public @interface Sensitive extends JacksonAnnotation {

}

public class User {

    private String username;

    @Sensitive
    private String password;

}

@Configuration
public class JacksonConfig {

    @Bean
    public Jackson2ObjectMapper jacksonObjectMapper() {
        Jackson2ObjectMapper objectMapper = new Jackson2ObjectMapper();
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        objectMapper.registerModule(new SimpleModule().addSerializer(String.class, new SensitiveSerializer()));
        return objectMapper;
    }

}

public class SensitiveSerializer extends JsonSerializer<String> {

    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeString(value.replaceAll(".", "*"));
    }

}