摘要：在当今互联网时代，数据安全和隐私保护的重要性愈发凸显。对于互联网软件开发人员而言，确保敏感信息在传输过程中不被泄露是一项至关重要的任务。在 Spring Boot3 开发的 RESTFul 接口中，对响应内容进行脱敏处理，能够有效保护用户的隐私数据，提升系统的
在当今互联网时代，数据安全和隐私保护的重要性愈发凸显。对于互联网软件开发人员而言，确保敏感信息在传输过程中不被泄露是一项至关重要的任务。在 Spring Boot3 开发的 RESTFul 接口中，对响应内容进行脱敏处理，能够有效保护用户的隐私数据，提升系统的安全性和可信度。本文将深入探讨如何在 Spring Boot3 中实现 RESTFul 接口响应内容的脱敏处理。
1.1 接口数据脱敏的定义
接口数据脱敏，即在 API 接口向客户端返回数据时，针对包含敏感信息（如个人身份信息、财务数据等）的字段执行特殊处理。通过运用特定算法或遵循既定规则，将敏感字段的部分或全部内容隐藏或替换，比如用星号（*）或其他占位符来掩盖关键信息，同时尽可能维持数据的原有格式和一定程度的可读性，防止敏感数据直接暴露给未授权的访问者。
1.2 接口数据脱敏的重要性
强化用户隐私保护：对用户的姓名、身份证号码、手机号码等个人敏感信息进行脱敏处理，是切实保护用户隐私的有效手段，可避免敏感信息被非法获取与滥用，维护用户的合法权益。
确保法律合规性：随着全球数据保护法规日益严格，像欧盟的《通用数据保护条例》(GDPR) 和中国的《个人信息保护法》等，实施数据脱敏已成为企业合规运营的关键。通过脱敏操作，企业能够规避触犯相关法律条款，降低因违规带来的法律风险。
降低数据泄露风险：即便出现数据不慎泄露的情况，经过脱敏处理的数据也能大幅降低敏感信息被直接利用的风险，减轻数据泄露给企业、用户及社会造成的潜在危害。
促进数据的安全共享与利用：在保护个人隐私的基础上，脱敏后的数据仍具备足够的分析价值，为数据的安全共享和有效利用创造了条件，推动数据在合规框架内流通与融合，实现数据价值的最大化。
1.3 接口数据脱敏的实现方式
手动脱敏：直接在业务逻辑层代码中逐个对敏感数据进行处理。此方式虽灵活性较高，但易因人为疏忽导致脱敏遗漏，并且会使代码中充斥大量重复的处理逻辑，增加维护成本。
AOP（面向切面编程）：借助 AOP 技术，通过定义切面拦截 API 接口返回的数据流，实现对敏感字段的统一处理。该方法可将脱敏逻辑从业务代码中分离出来，进行集中管理，提升代码的可维护性和可扩展性。不过，由于 AOP 的拦截机制会带来一定的处理开销，可能对系统性能产生影响。
自定义序列化器：在数据序列化阶段，利用 JSON 序列化框架（如 Jackson）提供的自定义序列化器功能，自动处理敏感字段。这种方式既能保持良好的性能，又能将脱敏逻辑与业务逻辑完全解耦，让代码更清晰、易管理。
注解 + 反射：通过定义自定义注解标记需要脱敏的字段，在数据返回前，运用 Java 的反射机制在运行时动态遍历这些字段并实施脱敏处理。此方式简化了脱敏操作流程，开发者只需通过简单注解标记即可实现脱敏功能，也便于后续对脱敏逻辑的维护与扩展。在 Spring Boot3 中，结合自定义注解与 Jackson 序列化器实现 RESTFul 接口响应内容脱敏是一种常用且高效的方法，接下来我们将详细介绍其实现过程。
在开始实现脱敏功能之前，先确保我们的开发环境已准备就绪：
JDK 版本：JDK 17 。Spring Boot 版本：Spring Boot 3.2.2 。构建工具：Maven 。在pom.xml文件中添加相关依赖，主要包括hutool-all工具类库用于简化脱敏逻辑，以及jackson-databind用于 JSON 数据的序列化和反序列化：
cn.hutoolhutool-all5.8.25com.fasterxml.jackson.corejackson-databind2.9.2添加完依赖后，Maven 会自动下载并管理这些依赖包，为后续的开发工作提供支持。
3.1 创建自定义注解
首先，我们创建一个自定义注解@Desensitize，用于标记需要进行脱敏处理的字段。该注解包含脱敏类型type以及自定义规则的起始和结束位置startInclude、endExclude：
@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.FIELD)@JacksonAnnotationsInside@JsonSerialize(using = DesensitizeSerializer.class)public @interface Desensitize {DesensitizeType type default DesensitizeType.DEFAULT;int startInclude default 0;int endExclude default 0;}在上述代码中，@Retention(RetentionPolicy.RUNTIME)表示该注解在运行时有效；@Target(ElementType.FIELD)指定该注解只能用于字段；@JacksonAnnotationsInside用于将多个 Jackson 注解组合在一起；@JsonSerialize(using = DesensitizeSerializer.class)指定了该注解标记的字段在序列化时使用DesensitizeSerializer类进行处理。
3.2 定义脱敏枚举类
接着，定义枚举类DesensitizeType，用于明确字段的脱敏类型，如手机号、邮箱、身份证号、银行卡号等常见类型，以及自定义规则类型：
public enum DesensitizeType {DEFAULT,CUSTOM_RULE,PHONE,EMAIL,ID_CARD,BANK_CARD,ADDRESS,CHINESE_NAME,PASSWORD,}通过这个枚举类，我们可以在@Desensitize注解中方便地指定不同的脱敏类型，以满足各种业务场景的需求。
3.3 创建自定义序列化类
创建DesensitizeSerializer类，它继承自JsonSerializer并实现ContextualSerializer接口。在serialize方法中，根据不同的脱敏类型对字符串进行相应的脱敏处理。
public class DesensitizeSerializer extends JsonSerializer implements ContextualSerializer {private DesensitizeType type;private int startInclude;private int endExclude;public DesensitizeSerializer {this.type = DesensitizeType.DEFAULT;}public DesensitizeSerializer(DesensitizeType type) {this.type = type;}@Overridepublic void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {// 根据脱敏类型进行相应的脱敏处理switch (type) {case PHONE:value = DesensitizedUtil.phoneNum(value);break;case EMAIL:value = DesensitizedUtil.email(value);break;case ID_CARD:value = DesensitizedUtil.idCardNum(value, 4, 4);break;default:// 自定义规则脱敏if (startInclude >= 0 && endExclude > 0 && startInclude createContextual(SerializerProvider serializers, BeanProperty property) {if (property!= null) {if (property.getType.getRawClass == String.class) {Desensitize annotation = property.getAnnotation(Desensitize.class);if (annotation!= null) {return new DesensitizeSerializer(annotation.type, annotation.startInclude, annotation.endExclude);}}}return serializers.findValueSerializer(property.getType, null);}}在serialize方法中，针对不同的DesensitizeType，利用Hutool工具类库中的DesensitizedUtil工具类进行相应的脱敏操作。例如，DesensitizedUtil.phoneNum(value)用于对手机号进行脱敏，保留前三位和后四位，中间部分用星号替换；DesensitizedUtil.email(value)用于对邮箱进行脱敏，保留邮箱用户名的第一个字符和@符号前后部分；DesensitizedUtil.idCardNum(value, 4, 4)用于对身份证号进行脱敏，保留前四位和后四位，中间部分用星号替换。对于自定义规则的脱敏，通过StrUtil.hide(value, startInclude, endExclude)方法，按照指定的起始和结束位置对字符串进行隐藏处理。
createContextual方法用于在运行时根据字段上的@Desensitize注解获取相应的脱敏配置，并创建对应的DesensitizeSerializer实例。如果字段没有标记@Desensitize注解，则返回默认的序列化器。
3.4 使用自定义注解进行脱敏
在需要进行脱敏处理的实体类字段上使用@Desensitize注解。例如，假设有一个User类，包含手机号、邮箱、身份证号等敏感信息字段：
public class User {private String username;@Desensitize(type = DesensitizeType.PHONE)private String phone;@Desensitize(type = DesensitizeType.EMAIL)private String email;@Desensitize(type = DesensitizeType.ID_CARD)private String idCard;// 省略getter和setter方法}在上述代码中，phone字段标记了@Desensitize(type = DesensitizeType.PHONE)，表示该字段在接口响应序列化时会按照手机号的脱敏规则进行处理；email字段和idCard字段同理，分别按照邮箱和身份证号的脱敏规则进行处理。而username字段未标记@Desensitize注解，将正常返回原始数据。
3.5 测试接口
编写一个简单的 Controller 来测试脱敏效果：
@RestControllerpublic class UserController {@GetMapping("/user")public User getUser {User user = new User;user.setUsername("张三");user.setPhone("13812345678");user.setEmail("example@example.com");user.setIdCard("123456789012345678");return user;}}启动 Spring Boot 应用，访问/user接口，返回的 JSON 数据中，phone、email和idCard字段会按照预设的脱敏规则进行脱敏处理，而username字段正常显示原始值。例如，返回的数据可能如下：
{"username": "张三","phone": "138****5678","email": "e****@example.com","idCard": "1234******5678"}通过以上步骤，我们成功在 Spring Boot3 中实现了 RESTFul 接口响应内容的脱敏处理，有效保护了敏感信息在传输过程中的安全性。
通过自定义注解和自定义序列化器相结合的方式，我们在 Spring Boot3 中优雅地实现了 RESTFul 接口响应内容的脱敏处理。这种方式不仅具有良好的可扩展性和可维护性，还能根据不同的业务需求灵活配置脱敏规则。在实际应用中，还可以进一步拓展该方案。例如，结合用户角色进行动态脱敏，不同角色的用户可能需要看到不同敏感程度的数据，管理员可以查看完整的敏感信息，而普通用户只能看到脱敏后的数据。可以在脱敏序列化器中，根据当前登录用户的角色动态选择脱敏策略。
另外，对于一些需要可逆脱敏的场景，比如客服人员在验证用户身份后，需要查看完整的手机号等敏感信息，可以设计可逆的脱敏算法，并在特定的业务逻辑中实现数据的还原。同时，要注意在性能优化方面，避免在高频接口中使用过于复杂的正则匹配等操作，以免影响系统的响应速度。总之，数据脱敏是保障数据安全和用户隐私的重要手段，在开发过程中需要根据实际情况进行合理的设计和实现。希望本文能为广大互联网软件开发人员在 Spring Boot3 开发中处理接口响应内容脱敏问题提供有益的参考和帮助。
来源：从程序员到架构师一点号
