SpringBoot中优雅的实现隐私数据脱敏（提供Gitee源码）

前言：在实际项目开发中，可能会对一些用户的隐私信息进行脱敏操作，传统的方式很多都是用replace方法进行手动替换，这样会由很多冗余的代码并且后续也不好维护，本期就讲解一下如何在SpringBoot中优雅的通过序列化的方式去实现数据的脱敏操作！

目录

一、导入pom依赖

二、DesensitizationEnum枚举类

三、Desensitization自定义注解

四、DesensitizationSerialize脱敏序列化器

五、User实体类

六、UserController请求层

七、运行测试

八、Gitee源码

九、总结

一、导入pom依赖

完整代码：

    <dependencies>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.18</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        
    </dependencies>

二、DesensitizationEnum枚举类

在DesensitizationSerialize序列化类中，会根据脱敏注解的type值，也就是DesensitizationEnum 中的类型，来判断需要使用哪种脱敏方式。

这边我就简单定义了5个枚举类型：

完整代码：

package com.example.desensitization.constant;

public enum DesensitizationEnum {

    /**
     * 自定义
     */
    CUSTOM_RULE,
    
    /**
     * 身份证号码
     */
    ID_CARD_NO,

    /**
     * 电话号码
     */
    PHONE,

    /**
     * 地址
     */
    ADDRESS,

    /**
     * 银行卡号
     */
    BANK_CARD_NO,
}

三、Desensitization自定义注解

这个是自定义的注解@Desensitization，用于标注需要进行脱敏的字段。

主要包含以下元注解和属性：

1、@Target(ElementType.FIELD)：表示该注解只能用于字段上。

2、@Retention(RetentionPolicy.RUNTIME)：表示该注解可以保留到运行时。

3、@JacksonAnnotationsInside：是一个Jackson的元注解，表示该注解可以作为Json序列化的注解。

4、@JsonSerialize：标注使用DesensitizationSerialize来进行序列化。

5、DesensitizationEnum type：需要脱敏的类型，对应枚举中的脱敏类型。

6、int start/end：可选的起始位置和结束位置，对于脱敏类型为字符串时有效。

完整代码：

package com.example.desensitization.annotation;

import com.example.desensitization.constant.DesensitizationEnum;
import com.example.desensitization.serialize.DesensitizationSerialize;
import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

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)
@JacksonAnnotationsInside
@JsonSerialize(using = DesensitizationSerialize.class)
public @interface Desensitization {

    DesensitizationEnum type();

    int start() default 0;

    int end() default 0;

}

四、DesensitizationSerialize脱敏序列化器

1、继承JsonSerializer<String>JsonSerializer是Jackson的序列化器基类，实现了将对象序列化为JSON的核心方法，这里继承它是为了实现字符串的自定义序列化。

2、实现ContextualSerializer接口ContextualSerializer可以让序列化器基于上下文环境进行定制化，实现这个接口后，可以实现createContextual()方法。

关键代码：

@AllArgsConstructor
@NoArgsConstructor
public class DesensitizationSerialize extends JsonSerializer<String> implements ContextualSerializer {

    private DesensitizationEnum type;

    private Integer start;

    private Integer end;
}

自定义序列化器方式可以实现非侵入式的灵活脱敏，对业务代码零侵入，且不依赖Spring等框架，更适合编写独立的应用服务。当然，AOP实现也有其适用场景，可以作为另一种可选方案。

createContextual()方法：

1、Controller的user()方法被调用，构建并返回了一个User对象。

2、开始对User对象进行JSON序列化，会先调用我们定义的DesensitizationSerialize中createContextual()方法，如果这个实体类被createContextual()方法处理过，则以后不会再走该方法，直接走serialize()方法。

3、DesensitizationSerialize会检查当前类字段是否有@Desensitization注解，如果有N个，则根据注解的type、start和end参数创建N个DesensitizationSerialize实例。

关键代码：

@Override
    public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty)
            throws JsonMappingException {
        if (beanProperty != null) {
            // 获取当前正在处理的字段的类型，判断如果是 String 类型则进行后续脱敏逻辑处理
            if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {
                // 通过 beanProperty 获取在字段上标注的 @Desensitization 注解
                Desensitization desensitization = beanProperty.getAnnotation(Desensitization.class);
                // 如果没有就尝试获取类注解
                if (desensitization == null) {
                    desensitization = beanProperty.getContextAnnotation(Desensitization.class);
                }
                // 不为null
                if (desensitization != null) {
                    // 如果获取到了注解,则根据注解的 type、start 和 end 参数创建 DesensitizationSerialize 实例，这是脱敏处理的序列化器
                    return new DesensitizationSerialize(desensitization.type(), desensitization.start(),
                            desensitization.end());
                }
            }
            // 直接返回默认的序列化器
            return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
        }
        // 直接返回默认的序列化器
        return serializerProvider.findNullValueSerializer(null);
    }

serialize方法： 

JsonGenerator是Jackjson提供的JSON生成器类。在自定义序列化器的serialize()方法中，会传入JsonGenerator实例。serialize()方法需要通过JsonGenerator将脱敏后的字符串写入到结果JSON中。

CharSequenceUtil和DesensitizedUtil都是hutool提供的工具类。

整体流程是：

1、根据注解的参数动态选择脱敏策略。

2、调用对应 Hutool 的脱敏函数处理字符串。

3、将脱敏结果写入JSON。

关键代码：

    @Override
    public void serialize(String s, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
            throws IOException {
        switch (type){
            //自定义
            case CUSTOM_RULE:
                jsonGenerator.writeString(CharSequenceUtil.hide(s, start, end));
                break;
            //身份证
            case ID_CARD_NO:
                jsonGenerator.writeString(DesensitizedUtil.idCardNum(s, 2, 6));
                break;
            //手机号
            case PHONE:
                jsonGenerator.writeString(DesensitizedUtil.mobilePhone(s));
                break;
            //地址
            case ADDRESS:
                jsonGenerator.writeString(DesensitizedUtil.address(s, 2));
                break;
            // 银行卡脱敏
            case BANK_CARD_NO:
                jsonGenerator.writeString(DesensitizedUtil.bankCard(s));
                break;
            default:
        }
    }

综上，整体的执行逻辑如下：

1、Controller返回一个实体对象。

2、如果实体对象是第一次进行脱敏，则会调用createContextual()方法。

3、获取当前实体对象所有使用Desensitization注解的字符串字段，创建对应的DesensitizationSerialize实例，实现脱敏处理的序列化器。

4、执行serialize()方法中switch的处理逻辑，由JsonGenerator将脱敏后的字符串写入到结果JSON中。

5、返回Json数据。

完整代码：

package com.example.desensitization.serialize;

import cn.hutool.core.text.CharSequenceUtil;
import cn.hutool.core.util.DesensitizedUtil;
import com.example.desensitization.annotation.Desensitization;
import com.example.desensitization.constant.DesensitizationEnum;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.BeanProperty;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import java.io.IOException;
import java.util.Objects;

@AllArgsConstructor
@NoArgsConstructor
public class DesensitizationSerialize extends JsonSerializer<String> implements ContextualSerializer {

    private DesensitizationEnum type;

    private Integer start;

    private Integer end;

    @Override
    public void serialize(String s, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
            throws IOException {
        switch (type){
            //自定义
            case CUSTOM_RULE:
                jsonGenerator.writeString(CharSequenceUtil.hide(s, start, end));
                break;
            //身份证
            case ID_CARD_NO:
                jsonGenerator.writeString(DesensitizedUtil.idCardNum(s, 2, 6));
                break;
            //手机号
            case PHONE:
                jsonGenerator.writeString(DesensitizedUtil.mobilePhone(s));
                break;
            //地址
            case ADDRESS:
                jsonGenerator.writeString(DesensitizedUtil.address(s, 2));
                break;
            // 银行卡脱敏
            case BANK_CARD_NO:
                jsonGenerator.writeString(DesensitizedUtil.bankCard(s));
                break;
            default:
        }
    }

    @Override
    public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty)
            throws JsonMappingException {
        if (beanProperty != null) {
            // 获取当前正在处理的字段的类型，判断如果是 String 类型则进行后续脱敏逻辑处理
            if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {
                // 通过 beanProperty 获取在字段上标注的 @Desensitization 注解
                Desensitization desensitization = beanProperty.getAnnotation(Desensitization.class);
                // 如果没有就尝试获取类注解
                if (desensitization == null) {
                    desensitization = beanProperty.getContextAnnotation(Desensitization.class);
                }
                // 不为null
                if (desensitization != null) {
                    // 如果获取到了注解,则根据注解的 type、start 和 end 参数创建 DesensitizationSerialize 实例，这是脱敏处理的序列化器
                    return new DesensitizationSerialize(desensitization.type(), desensitization.start(),
                            desensitization.end());
                }
            }
            // 直接返回默认的序列化器
            return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
        }
        // 直接返回默认的序列化器
        return serializerProvider.findNullValueSerializer(null);
    }
}

五、User实体类

给想要脱敏的字段加上 @Desensitization(type = DesensitizationEnum.枚举类型)注解即可。

完整代码：

package com.example.desensitization.domain;

import com.example.desensitization.annotation.Desensitization;
import com.example.desensitization.constant.DesensitizationEnum;
import lombok.Builder;
import lombok.Data;

@Data
@Builder
public class User {

    /**
     * 主键
     */
    private String id;

    /**
     * 用户名
     */
    private String name;

    /**
     * 身份证号码
     */
    @Desensitization(type = DesensitizationEnum.ID_CARD_NO)
    private String idCardNo;

    /**
     * 电话号码
     */
    @Desensitization(type = DesensitizationEnum.PHONE)
    private String phone;

    /**
     * 地址
     */
    @Desensitization(type = DesensitizationEnum.CUSTOM_RULE,start = 2,end = 5)
    private String address;

    /**
     * 银行卡号
     */
    @Desensitization(type = DesensitizationEnum.BANK_CARD_NO)
    private String bankCardNo;

}

六、UserController请求层

完整代码：

package com.example.desensitization.controller;

import com.example.desensitization.domain.User;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.UUID;

@RestController
@RequestMapping
public class UserController {

    @GetMapping("/user")
    public User user(){
        User user = User.builder()
                .id(UUID.randomUUID().toString())
                .name("张三").
                idCardNo("32089809285012823").
                phone("13919819285").
                bankCardNo("62427292012731238812").
                address("江苏省南通市").build();
        return user;
    }

}

七、运行测试

浏览器直接访问：http://localhost:8080/user

可以看到隐私的信息都进行了数据脱敏的处理！

八、Gitee源码

源码地址：SpringBoot中优雅的实现隐私数据脱敏

九、总结

以上就是我对于SpringBoot中如何优雅的实现隐私数据脱敏的完整教程，如有问题，欢迎评论区留言！ 

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/80737.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

【框架类】—MVVM框架

【框架类】—MVVM框架

一、MVVM框架有哪些 Vue.jsReact.jsAngular.js 二、对MVVM的认识 1. MVC是什么 全称 Model View Controller, 它采用模型(Model)-视图(View)-控制器(controller)的方法把业务逻辑、数据与界面显示分离 2. MVVM的定义 MVVM是一种软件架构模式&#xff0c;它代表了模型 --视…
阅读更多...
深入理解JVM——垃圾回收与内存分配机制详细讲解

深入理解JVM——垃圾回收与内存分配机制详细讲解

所谓垃圾回收&#xff0c;也就是要回收已经“死了”的对象。 那我们如何判断哪些对象“存活”&#xff0c;哪些已经“死去”呢&#xff1f; 一、判断对象已死 1、引用计数算法 给对象中添加一个引用计数器&#xff0c;每当有一个地方引用它时&#xff0c;计数器就加一&…
阅读更多...
探索无限创造力的星辰大道，画出想象的浩瀚宇宙！-turtle

探索无限创造力的星辰大道，画出想象的浩瀚宇宙！-turtle

介绍 视频教程地址在此&#xff1a;https://www.bilibili.com/video/BV1Pm4y1H7Tb/ 大家好&#xff0c;欢迎来到本视频&#xff01;今天&#xff0c;我们将一同探索Python编程世界中的一个有趣而创意的库——Turtle库。无需专业绘画技能&#xff0c;你就可以轻松地用代码绘制…
阅读更多...
人工智能在网络安全中的作用：当前的局限性和未来的可能性

人工智能在网络安全中的作用：当前的局限性和未来的可能性

人工智能 (AI) 激发了网络安全行业的想象力&#xff0c;有可能彻底改变安全和 IT 团队处理网络危机、漏洞和勒索软件攻击的方式。 然而&#xff0c;对人工智能的能力和局限性的现实理解至关重要&#xff0c;并且存在许多挑战阻碍人工智能对网络安全产生直接的变革性影响。 在…
阅读更多...
概述、搭建Redis服务器、部署LNP+Redis、创建Redis集群、连接集群、集群工作原理

概述、搭建Redis服务器、部署LNP+Redis、创建Redis集群、连接集群、集群工作原理

Top NSD DBA DAY09 案例1&#xff1a;搭建redis服务器案例2&#xff1a;常用命令限案例3&#xff1a;部署LNPRedis案例4&#xff1a;创建redis集群 1 案例1&#xff1a;搭建redis服务器 1.1 具体要求如下 在主机redis64运行redis服务修改服务运行参数 ip 地址192.168.88.6…
阅读更多...
在 ubuntu 18.04 上使用源码升级 OpenSSH_7.6p1到 OpenSSH_9.3p1

在 ubuntu 18.04 上使用源码升级 OpenSSH_7.6p1到 OpenSSH_9.3p1

1、检查系统已安装的当前 SSH 版本 使用命令 ssh -V 查看当前 ssh 版本&#xff0c;输出如下&#xff1a; OpenSSH_7.6p1 Ubuntu-4ubuntu0.7, OpenSSL 1.0.2n 7 Dec 20172、安装依赖&#xff0c;依次执行以下命令 sudo apt update sudo apt install build-essential zlib1g…
阅读更多...
[论文笔记]Glancing Transformer for Non-Autoregressive Neural Machine Translation

[论文笔记]Glancing Transformer for Non-Autoregressive Neural Machine Translation

引言 这是论文Glancing Transformer for Non-Autoregressive Neural Machine Translation的笔记。 传统的非自回归文本生成速度较慢，因为需要给定之前的token来预测下一个token。但自回归模型虽然效率高，但性能没那么好。 这篇论文提出了Glancing Transformer，可以只需要一…
阅读更多...
6.RocketMQ之索引文件ConsumeQueue

6.RocketMQ之索引文件ConsumeQueue

本文着重分析为consumequeue/topic/queueId目录下的索引文件。 1.ConsumeQueueStore public class ConsumeQueueStore {protected final ConcurrentMap<String>, ConcurrentMap<Integer>, ConsumeQueueInterface>> consumeQueueTable;public boolean load(…
阅读更多...
Selenium 测试用例编写

Selenium 测试用例编写

编写Selenium测试用例就是模拟用户在浏览器上的一系列操作&#xff0c;通过脚本来完成自动化测试。 编写测试用例的优势&#xff1a; 开源&#xff0c;免费。 支持多种浏览器 IE&#xff0c;Firefox&#xff0c;Chrome&#xff0c;Safari。 支持多平台 Windows&#xff0c;Li…
阅读更多...
Xxl-job安装部署以及SpringBoot集成Xxl-job使用

Xxl-job安装部署以及SpringBoot集成Xxl-job使用

1、安装Xxl-job&#xff1a; 可以使用docker拉取镜像部署和源码编译两种方式&#xff0c;这里选择源码编译安装。 代码拉取地址&#xff1a; https://github.com/xuxueli/xxl-job/tree/2.1.2 官方开发文档&#xff1a; https://www.xuxueli.com/xxl-job/#%E3%80%8A%E5%88%…
阅读更多...
Android5:活动生命周期

Android5:活动生命周期

创建项目Stopwatch activity_main.xml <?xml version"1.0" encoding"utf-8"?> <LinearLayoutxmlns:android"http://schemas.android.com/apk/res/android"xmlns:tools"http://schemas.android.com/tools"android:layout_w…
阅读更多...
ROS-PyQt小案例

ROS-PyQt小案例

前言&#xff1a;目前还在学习ROS无人机框架中&#xff0c;&#xff0c;&#xff0c; 更多更新文章详见我的个人博客主页【前往】 ROS与PyQt5结合的小demo&#xff0c;用于学习如何设计一个界面&#xff0c;并与ROS中的Service和Topic结合&#xff0c;从而控制多个小乌龟的运动…
阅读更多...
设计HTML5表单

设计HTML5表单

HTML5基于Web Forms 2.0标准对HTML4表单进行全面升级&#xff0c;在保持简便、易用的基础上&#xff0c;新增了很多控件和属性&#xff0c;从而减轻了开发人员的负担。表单为访问者提供了与网站进行互动的途径&#xff0c;完整的表单一般由控件和脚本两部分组成。 1、认识HTML…
阅读更多...
ansible的playbook剧本

ansible的playbook剧本

playbook剧本 PlayBook1.playbooks 本身由以下各部分组成2.示例&#xff1a;3.运行playbook补充参数&#xff1a; 4.定义、引用变量5.指定远程主机sudo切换用户6.when条件判断7.迭代8.Templates 模块1.先准备一个以 .j2 为后缀的 template 模板文件&#xff0c;设置引用的变量2…
阅读更多...
记录--webpack和vite原理

记录--webpack和vite原理

这里给大家分享我在网上总结出来的一些知识&#xff0c;希望对大家有所帮助 前言 每次用vite创建项目秒建好&#xff0c;前几天用vue-cli创建了一个项目&#xff0c;足足等了我一分钟&#xff0c;那为什么用 vite 比 webpack 要快呢&#xff0c;这篇文章带你梳理清楚它们的原理…
阅读更多...
Linux命令200例：clock的具体应用，设置系统的时钟时间、硬件时钟和定时器等相关信息

Linux命令200例：clock的具体应用，设置系统的时钟时间、硬件时钟和定时器等相关信息

&#x1f3c6;作者简介&#xff0c;黑夜开发者&#xff0c;全栈领域新星创作者✌。CSDN专家博主&#xff0c;阿里云社区专家博主&#xff0c;2023年6月csdn上海赛道top4。 &#x1f3c6;数年电商行业从业经验&#xff0c;历任核心研发工程师&#xff0c;项目技术负责人。 &…
阅读更多...
Atlas 元数据管理

Atlas 元数据管理

Atlas 元数据管理 1.Atlas入门 1.1概述 元数据原理和治理功能&#xff0c;用以构建数据资产的目录。对这个资产进行分类和管理&#xff0c;形成数据字典。 提供围绕数据资产的协作功能。 表和表之间的血缘依赖 字段和字段之间的血缘依赖 1.2架构图 导入和导出&#xff1…
阅读更多...
Educational Codeforces Round 62 (Rated for Div. 2) C. Playlist

Educational Codeforces Round 62 (Rated for Div. 2) C. Playlist

一开始肯定要排个序&#xff0c;b相同时t大的在前边&#xff0c;不同时b大的在前面。 然后想最多只能选k个的限制&#xff0c;可以这样想&#xff0c;每次用到的b只能用已选到的最小的值&#xff0c;那可以把每个b都枚举一遍&#xff0c;然后每一次选时长最长的&#xff0c;且…
阅读更多...
CCF C³ 走进百度：大模型与可持续生态发展

CCF C³ 走进百度：大模型与可持续生态发展

2023年8月10日&#xff0c;由CCF CTO Club发起的第22期C活动在百度北京总部进行&#xff0c;以“AI大语言模型技术与生态发展”主题&#xff0c;50余位企业界、学界专家、研究人员就此进行深入探讨。 CCF C走进百度 本次活动&#xff0c;CCF秘书长唐卫清与百度集团副总裁、深…
阅读更多...
DeepSort：基于检测的目标跟踪的经典

DeepSort：基于检测的目标跟踪的经典

本文来自公众号“AI大道理” DeepSORT在SORT的基础上引入了深度学习的特征表示和更强大的目标关联方式&#xff0c;有效地减少了身份切换的数量&#xff0c;缓解了重识别问题。 ​ 1、DeepSORT简介 DeepSORT的主要思想是将目标检测和目标跟踪两个任务相结合。 首先使用目标检…
阅读更多...
最新文章

Copyright @ 2022~2023