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

⛰️个人主页: 蒾酒

🔥系列专栏：《spring boot实战》

🌊山高路远，行路漫漫，终有归途

写在前面

本文介绍了springboot开发后端服务中，接口数据脱敏优雅的设计与实现，坚持看完相信对你有帮助。

同时欢迎订阅springboot系列专栏，持续分享spring boot的使用经验。

内容简介

本文介绍了一种以优雅的方式实现对接口返回的敏感数据，如手机号、邮箱、身份证等信息的脱敏处理。这种方法也是企业常用方法。话不多说我们一起来看一下吧。

效果展示：

实现思路

• 自定义一个脱敏注解用于标记需要脱敏的字段，并且在注解中指定脱敏策略属性。
• 自定义脱敏策略枚举类，用于维护手机号、邮箱、身份证等信息的脱敏处理方式。
• 自定义脱敏 JSON 序列化器，在该序列化器中找到带有该注解的字段，根据注解中指定的脱敏策略，在序列化过程中将数据进行脱敏处理并输出到 JSON 中。

实现步骤

1.自定义脱敏注解

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.mijiu.commom.custom.serializable.DesensitizationJsonSerializable;
import com.mijiu.commom.enumerate.DesensitizationStrategyEnum;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author mijiupro
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = DesensitizationJsonSerializable.class)
public @interface Desensitization {
    DesensitizationStrategyEnum desensitizationStrategy();//这是自定义的脱敏策略枚举类型，用于指定脱敏策略，获取对应脱敏处理方法

}

2.编写脱敏策略枚举类

脱敏的本质其实就是个字符串的替换，我们在脱敏策略枚举类中通过定义函数接口，维护多种类型脱敏策略对应的字符串替换方法。这样做可以保证可维护性可扩展性。

import lombok.Getter;

import java.util.function.Function;

/**
 * 脱敏策略枚举类，维护对不同类型信息的脱敏处理方式
 * @author mijiupro
 */
@Getter
public enum DesensitizationStrategyEnum {

    // 手机号脱敏策略，保留前三位和后四位
    PHONE(s -> s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2")),

    // 邮箱脱敏策略，保留邮箱用户名第一个字符和@符号前后部分
    EMAIL(s -> s.replaceAll("(\\w)[^@]*(@\\w+\\.\\w+)", "$1****$2")),

    // 身份证号脱敏策略，保留前四位和后四位
    ID_CARD(s -> s.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1*****$2")),

    // 地址脱敏策略，保留省市信息，其余部分脱敏为**
    ADDRESS(s -> s.replaceAll("([\\u4e00-\\u9fa5]{2})[\\u4e00-\\u9fa5]+", "$1**")),

    // 银行卡号脱敏策略，保留前四位和后三位
    BANK_CARD(s -> s.replaceAll("(\\d{4})\\d{8,12}(\\d{3})", "$1************$2")),

    // 姓名脱敏策略，保留姓氏第一个字符，其余部分脱敏为**
    NAME(s -> s.charAt(0) + "**"),

    // 密码脱敏策略，统一显示为******
    PASSWORD(s -> "******");

    private final Function<String, String> desensitization;

    DesensitizationStrategyEnum(Function<String, String> desensitization) {
        this.desensitization = desensitization;
    }

}

3.编写JSON序列化实现

需要清楚

• 平时接口返回的数据结构直接都是交给默认的序列化器把对象转成json的。
• 实现脱敏的本质就是在这前面添加了一段逻辑，找到带有脱敏注解的属性然后拿到注解指定的脱敏策略实例化这个脱敏策略枚举类，应用对应的脱敏方法处理需要脱敏字段，得到脱敏后的值交给json生成器得到最终脱敏后的json

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.*;

import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import com.mijiu.commom.annotation.Desensitization;
import com.mijiu.commom.enumerate.DesensitizationStrategyEnum;

import java.io.IOException;
import java.util.Objects;

/**
 * 自定义的脱敏JSON序列化器
 * @author mijiupro
 */

public class DesensitizationJsonSerializable extends JsonSerializer<String> implements ContextualSerializer {

    private DesensitizationStrategyEnum desensitizationStrategy; // 脱敏策略

    @Override
    public void serialize(String s, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        // 将字符串按照设定的脱敏策略进行脱敏处理后序列化到 JSON 中
        jsonGenerator.writeString(desensitizationStrategy.getDesensitization().apply(s));
    }

    @Override
    public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty) throws JsonMappingException {
        // 获取属性上的 Desensitization 注解
        Desensitization annotation = beanProperty.getAnnotation(Desensitization.class);

        // 判断注解不为空且属性类型为 String
        if (Objects.nonNull(annotation) && Objects.equals(String.class, beanProperty.getType().getRawClass())) {
            this.desensitizationStrategy = annotation.desensitizationStrategy(); // 设置脱敏策略
            return this;
        }

        // 返回默认的序列化器
        return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
    }
}

4.编写测试类

/**
 * @author mijiupro
 */
@Data
@Builder
public class PersonalInfo {

    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.PHONE)
    private String phone; // 手机号

    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.EMAIL)
    private String email; // 邮箱

    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.ID_CARD)
    private String idCard; // 身份证号

    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.ADDRESS)
    private String address; // 地址

    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.BANK_CARD)
    private String bankCard; // 银行卡号

    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.NAME)
    private String name; // 姓名

    @Desensitization(desensitizationStrategy = DesensitizationStrategyEnum.PASSWORD)
    private String password; // 密码

}

5.编写测试接口

/**
 * @author mijiupro
 */
@RestController
@RequestMapping("/test/desensitization")
@Tag(name = "脱敏测试接口", description = "脱敏测试接口")
public class DesensitizationTestController {
    @GetMapping("/get-info")
    @Operation(summary = "获取脱敏信息")
    public PersonalInfo getInt() {

        return PersonalInfo.builder()
                .name("言冰云")
                .phone("13812345678")
                .email("[email protected]")
                .idCard("110101199003073321")
                .address("四川省成都市郫都区百草路一号")
                .password("1234567890")
                .bankCard("62220210001234567890")
                .build();
    }
}

6.接口测试

这里通过swagger3进行接口测试：

Spring Boot3整合knife4j(swagger3)_springboot3 knife4j-CSDN博客文章浏览阅读2.1k次，点赞39次，收藏52次。Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j (xiaominfo.com)作者的使用的spring boot 3.2.2为当前最新版，所以依赖导入最新的knife4j 4.4.0。3.1 增强模式 | Knife4j (xiaominfo.com)好一个spring boot项目且版本为3X，项目可正常启动。快速开始 | Knife4j (xiaominfo.com)接下来配置以下接口文档的作者等信息。@Tag注解：标记接口类别。_springboot3 knife4jhttps://blog.csdn.net/qq_62262918/article/details/135761392?spm=1001.2014.3001.5502测试结果：

写在最后

springboot3实现优雅的数据脱敏到这里就结束了，本文共列举了实现了七种常见的类型的数据脱敏。任何问题评论区或私信讨论，欢迎指正。