基于Jackson实现API接口数据脱敏

news2024/12/23 7:37:15

一、背景

用户的一些敏感数据，例如手机号、邮箱、身份证等信息，在数据库以明文存储（加密存储见《基于Mybatis-Plus拦截器实现MySQL数据加解密》）， 但在接口返回数据给浏览器（或三方客户端）时，希望对这些敏感数据进行脱敏。 同时在浏览器提交数据更新到后端接口时，后端接口需要判断敏感数据是否已脱敏，如果已脱敏则需要直接丢弃。

 

二、Jackson介绍

Jackson是SpringBoot默认的Json序列化和反序列化库，点击这里查看Jackson注解官方文档.

本文通过使用Jackson的@JsonSerialize注解实现序列化时脱敏操作，通过使用Jackson的@JsonDeserialize注解实现反序列化时脱敏数据检测并丢弃操作。

三、使用方法

该脱敏拦截器功能在wutong-base-api包（公司内部包）已经实现，如果您的项目已经依赖了base-api，就可以直接使用。

另外，在码云上有Demo案例，见: spring-jackson

基于wutong-base-api包的使用步骤如下。

1、添加wutong-base-api依赖

<dependency>
    <groupId>com.talkweb</groupId>
    <artifactId>wutong-base-api</artifactId>
    <version>请使用最新版本</version>
</dependency>

2、在yaml配置开关，启用加解密

spring:
  jackson:
    sensitive:
      # 序列化时是否对手机号进行脱敏，反序列化时是否过滤脱敏数据
      mobile: true
      # 序列化时是否对邮箱进行脱敏，反序列化时是否过滤脱敏数据
      email: true
      # 序列化时是否对身份证号进行脱敏，反序列化时是否过滤脱敏数据
      identity: true

3、定义VO类，使用Jackson注解实现数据脱敏

API接口出参(Rsp)，敏感数据序列化时脱敏

public class UserRspVO {
    private Long id;
    private String name;
    @JsonSerialize(using = CustomerJackSon.MobileSerialize.class)
    private String mobile;
    @JsonSerialize(using = CustomerJackSon.EmailSerialize.class)
    private String email;
    @JsonSerialize(using = CustomerJackSon.IdentitySerialize.class)
    private String identity;
}

API接口入参(Req)，过滤已脱敏的数据，直接丢弃

public class UserReqVO {
    private Long id;
    private String name;
    @JsonDeserialize(using = CustomerJackSon.MobileDeSerialize.class)
    private String mobile;
    @JsonDeserialize(using = CustomerJackSon.EmailDeSerialize.class)
    private String email;
    @JsonDeserialize(using = CustomerJackSon.IdentityDeSerialize.class)
    private String identity;
}

定义Controller接口

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

    @GetMapping
    public UserRspVO get() {
        UserRspVO rsp = new UserRspVO();
        rsp.setId(1L);
        rsp.setName("张三");
        rsp.setMobile("18866661234");
        rsp.setEmail("zhangsan@qq.com");
        rsp.setIdentity("434113199901015566");
        return rsp;
    }

    @PutMapping
    public UserRspVO put(@RequestBody UserReqVO req) {
        System.out.println(req);
        UserRspVO rsp = new UserRspVO();
        BeanUtils.copyProperties(req, rsp);
        return rsp;
    }
}

接口请求示例：

GET http://localhost:8080/user

入参：
无

出参：
{
  "id": "1",
  "name": "张三",
  "mobile": "188****1234", // 配置了mobile=true
  "email": "zhangsan@qq.com", // 配置了email=false
  "identity": "434113199901015566" // 未配置identity，默认为false
}

PUT http://127.0.0.1:8080/user

入参：
{
    "id": "12124",
    "name": "张三",
    "mobile": "188****1234",
    "email": "zh****@qq.com",
    "identity": "434***********5566"
}

Controller反序列化后接收到的数据：
{
    "id": "12124",
    "name": "张三",
    "mobile": null, // 配置了mobile=true
    "email": "zh****@qq.com", // 配置了email=false
    "identity": "434***********5566" // 未配置identity，默认为false
}

四、实现原理

1、SpringBoot定义变量实现脱敏开关

读取yaml配置

@ConfigurationProperties(prefix = "spring.jackson.sensitive")
public class JacksonProperties {
    private Boolean mobile;
    private Boolean email;
    private Boolean identity;
}

变量注入到JacksonConfig

@Configuration
@EnableConfigurationProperties(JacksonProperties.class)
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper(JacksonProperties props) {
        ObjectMapper mapper = new ObjectMapper();
        ContextAttributes attrs = ContextAttributes.getEmpty()
                .withSharedAttribute("mobile", props.getMobile())
                .withSharedAttribute("email", props.getEmail())
                .withSharedAttribute("identity", props.getIdentity());
        mapper.setDefaultAttributes(attrs);
        return mapper;
    }
}

2、实现序列化、反序列化逻辑

public class CustomerJackSon {
    /**
     * 手机号脱敏序列化
     */
    public static class MobileSerialize extends JsonSerializer<String> {
        @Override
        public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            if (null == value || value.length() != 11) {
                jsonGenerator.writeString(value);
                return;
            }
            Boolean mobile = (Boolean) serializerProvider.getAttribute("mobile");
            if (null == mobile || !mobile) {
                jsonGenerator.writeString(value);
                return;
            }
            jsonGenerator.writeString(value.substring(0, 3) + "****" + value.substring(7));
        }
    }

    /**
     * 手机号脱敏数据检测并丢弃
     */
    public static class MobileDeSerialize extends JsonDeserializer<String> {

        @Override
        public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JacksonException {
            String value = p.getText();
            if (null == value || value.length() != 11) {
                return value;
            }
            Boolean mobile = (Boolean) ctxt.getAttribute("mobile");
            if (null == mobile || !mobile) {
                return value;
            }
            if (value.contains("*")) {
                return null;
            }
            return value;
        }
    }

    /**
     * 邮箱脱敏序列化
     */
    public static class EmailSerialize extends JsonSerializer<String> {
        @Override
        public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            if (null == value || value.length() < 5) {
                jsonGenerator.writeString(value);
                return;
            }
            String[] split = value.split("@");
            if (split.length != 2 || split[0].length() < 2 || split[1].length() < 2) {
                jsonGenerator.writeString(value);
                return;
            }
            Boolean email = (Boolean) serializerProvider.getAttribute("email");
            if (null == email || !email) {
                jsonGenerator.writeString(value);
                return;
            }
            jsonGenerator.writeString(split[0].substring(0, 2) + "****@" + split[1]);
        }
    }

    /**
     * 邮箱脱敏数据检测并丢弃
     */
    public static class EmailDeSerialize extends JsonDeserializer<String> {

        @Override
        public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JacksonException {
            String value = p.getText();
            if (null == value || value.length() < 5) {
                return value;
            }
            Boolean email = (Boolean) ctxt.getAttribute("email");
            if (null == email || !email) {
                return value;
            }
            if (value.contains("*")) {
                return null;
            }
            return value;
        }
    }

    /**
     * 身份证脱敏序列化
     */
    public static class IdentitySerialize extends JsonSerializer<String> {
        @Override
        public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            if (null == value || value.length() != 18) {
                jsonGenerator.writeString(value);
                return;
            }
            Boolean identity = (Boolean) serializerProvider.getAttribute("identity");
            if (null == identity || !identity) {
                jsonGenerator.writeString(value);
                return;
            }
            jsonGenerator.writeString(value.substring(0, 3) + "***********" + value.substring(14));
        }
    }

    /**
     * 身份证脱敏数据检测并丢弃
     */
    public static class IdentityDeSerialize extends JsonDeserializer<String> {

        @Override
        public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JacksonException {
            String value = p.getText();
            if (null == value || value.length() != 18) {
                return value;
            }
            Boolean identity = (Boolean) ctxt.getAttribute("identity");
            if (null == identity || !identity) {
                return value;
            }
            if (value.contains("*")) {
                return null;
            }
            return value;
        }
    }
}

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

设计一个支持并发的前端接口缓存

设计一个支持并发的前端接口缓存

目录​​​​​​​ 缓存池 并发缓存 问题 思考 优化&#x1f914; 总结 最后 缓存池 缓存池不过就是一个map&#xff0c;存储接口数据的地方&#xff0c;将接口的路径和参数拼到一块作为key&#xff0c;数据作为value存起来罢了&#xff0c;这个咱谁都会。 const cach…
阅读更多...
DTU和MQTT网关优缺点

DTU和MQTT网关优缺点

目前市面上有两种设备实现Modbus转MQTT网关。网关式、DTU式。 钡铼技术网关内部进行转换 网关式 优点&#xff1a; 1、通讯模块和MCU分开&#xff0c;通讯模块只做通讯功能&#xff0c;协议转换有单独主控MCU&#xff0c;“硬转换”&#xff1b; 2、数据点是通过映射到主控…
阅读更多...
【严重】GitLab 存在代码执行漏洞

【严重】GitLab 存在代码执行漏洞

漏洞描述 GitLab 是一款基于Git的代码托管、版本控制、协作开发平台。 GitLab CE/EE 15.4 至 15.9.6 版本&#xff0c;15.10 至 15.10.5 版本和 15.11 至 15.11.1 版本存在代码执行漏洞。在某些条件下&#xff0c;实例上的任何GitLab用户都可以使用GraphQL端点将恶意运行程序…
阅读更多...
HTML框架-----标签（下）

HTML框架-----标签（下）

目录 前言&#xff1a; 5.容器标签 效果&#xff1a;​编辑 6.列表标签 (1)无序 &#xff08;2&#xff09;有序 7.图片标签 8.超链接标签 &#xff08;1&#xff09;链接资源 &#xff08;2&#xff09;超链接锚点 前言&#xff1a; 今天我们接着来继续学习html的标签&am…
阅读更多...
五重要性能测试指标揭秘！并发数、TPS、QPS、响应时间和资源利用率，了解性能瓶颈，优化系统高负载下的处理能力

五重要性能测试指标揭秘！并发数、TPS、QPS、响应时间和资源利用率，了解性能瓶颈，优化系统高负载下的处理能力

目录 前言&#xff1a; 1. 并发数 2. TPS 3. QPS 4. 响应时间 5. 资源利用率 总结 前言&#xff1a; 在高并发的场景下&#xff0c;我们需要考虑如何优化我们的应用程序&#xff0c;以确保它可以承受大量的请求并且在给定时间内响应。对于这个问题&#xff0c;性能测试就…
阅读更多...
字节码文件结构

字节码文件结构

目录 1、概述 2、JVM的两个无关性 3、Class字节码文件的结构 1、基本存储单位 2、字节码文件数据结构 3、Class文件格式 4、魔数与Class文件的版本 5、常量池 6、访问标志 7、类索引、父类索引与接口索引集合 8、字段表集合 9、方法表集合 10、属性表集合 11、总…
阅读更多...
centos7.9升级rockylinux8.8

centos7.9升级rockylinux8.8

前言 查看centos的版本 &#xff0c;我这台服务器是虚拟机,下面都是模拟实验 升级前一定要把服务器上配置文件&#xff0c;数据等进行备份 [rootlocalhost ~]#cat /etc/redhat-release CentOS Linux release 7.9.2009 (Core) [rootlocalhost ~]#uname -a Linux jenkins_ser…
阅读更多...
Ubuntu常见基本问题

Ubuntu常见基本问题

系列文章目录 文章目录 系列文章目录一、复制粘贴问题二、无法全屏问题三、设置为中文四、时间同步问题1、选择时区2、同步网络时间 一、复制粘贴问题 开启终端&#xff1a;ctrlaltt卸载已有工具 sudo apt-get autoremove open-vm-tools安装工具open-vm-tools sudo apt-get …
阅读更多...
echarts的y轴数据显示过长占不下，内容截取，鼠标hover上去显示全部

echarts的y轴数据显示过长占不下，内容截取，鼠标hover上去显示全部

初始效果&#xff1a; 优化后的效果&#xff1a; 优化点&#xff1a;控制了y轴显示字数&#xff0c;鼠标hover上去显示全部 主要实现思路参考了这位同学的文章&#xff1a;https://www.cnblogs.com/liuboren/p/9040622.html 我是用vue实现的&#xff0c;因为我需要一个页面中…
阅读更多...
各算法/协议知识理论笔记（fpga）

各算法/协议知识理论笔记（fpga）

一、利用fifo对3行数据求和 需要2个fifo保存第0行和第1行的数据&#xff0c;如下图 比如有20行数据&#xff0c;则将一行一行的输给fifo2, fifo2出来的数据再给fifo1.当fifo和fifo1有数据时&#xff0c;在准备给 fifo2输入新的一行数据时&#xff0c;同时读出fifo2&#xff0c;…
阅读更多...
Linux进程间通信（信号）

Linux进程间通信（信号）

信号发送 信号是 Linux 系统响应某些条件而产生的一个事件&#xff0c;接收到该信号的进程会执行相应的操作。 信号的产生有三种方式&#xff1a; &#xff08;1)由硬件产生&#xff0c;如从键盘输入 CtrlC 可以终止当前进程 &#xff08;2)由其他进程发送&#xff0c;如可在 …
阅读更多...
PostgreSQL修炼之道之高可用性方案设计（十七）

PostgreSQL修炼之道之高可用性方案设计（十七）

目录 20 高可用性方案设计&#xff08;二&#xff09; 20.2 基于共享存储的高可用方案 20.2.1 SAN存储的方案 20.2.2 DRBD的方案 20.3 WAL日志同步或流复制同步的方案 20.3.1 持续复制归档的standby的方法 20.3.2 异步流复制的方案 20.3.3 基于同步流复制方案 20.4 基于…
阅读更多...
国内外低代码开发平台发展情况如何？

国内外低代码开发平台发展情况如何？

国内外低代码开发平台发展情况如何&#xff1f;之前有些过很多关于低代码的内容&#xff0c;这篇就来详细梳理下国内外低代码开发平台发展现状。 关于低代码解读看这篇>>什么是低代码&#xff08;Low-Code&#xff09;&#xff1f;关于低代码平台看这篇>>主流的开…
阅读更多...
业务高速增长，如祺出行如何用腾讯云消息队列 RocketMQ 应对挑战

业务高速增长，如祺出行如何用腾讯云消息队列 RocketMQ 应对挑战

导语 作为广汽集团旗下的智慧出行平台&#xff0c;如祺出行上线四年时间&#xff0c;用户规模和订单量保持高速增长。在过去的2022年&#xff0c;如祺出行平台累计注册用户突破1800万&#xff0c;同比增长64%&#xff0c;年度订单总量超7000万&#xff0c;同比增长52%。 高速…
阅读更多...
【MCS-51】串行I/O接口及其通信

【MCS-51】串行I/O接口及其通信

我们知道MCS-51中有很多的引脚&#xff0c;这些引脚很多一般都是用作输入或者输出口&#xff0c;其中有两个引脚P3.0和P3.1比较特殊&#xff0c;我们常将其用作串行通信的数据发送和接收端TXD、RXD。 目录 &#x1f431;通信方式 &#x1f431;串行通信的传输方式和数据通信…
阅读更多...
python笔记17_实例演练_二手车折旧分析p2

python笔记17_实例演练_二手车折旧分析p2

…… 书接上文 4.车辆等级维度 探查车龄为5年的车辆&#xff0c;折旧价值与车辆等级的关系。 # 筛选出车龄为5的数据创建新表 data_age5 data[data[age] 5] data_age5 # 分组聚合计算均值 data_car_level data_age5.groupby(car_level_name)[lowest_price].mean().reset…
阅读更多...
16.2：岛屿数量问题

16.2：岛屿数量问题

文章目录 岛屿数量问题方法一&#xff1a;采用递归的方法方法二&#xff1a;使用并查集的方法&#xff08;map&#xff09;方法三&#xff1a;使用并查集的方法&#xff08;数组&#xff09; 岛屿数量问题 测试链接&#xff1a;https://leetcode.com/problems/number-of-islan…
阅读更多...
大数据：分布式计算，MapReduce，hadoop的计算组件，hive是sql分布式计算框架，底层就是基于MapReduce的

大数据：分布式计算，MapReduce，hadoop的计算组件，hive是sql分布式计算框架，底层就是基于MapReduce的

大数据&#xff1a;分布式计算&#xff0c;MapReduce&#xff0c;hadoop的计算组件&#xff0c;hive是sql分布式计算框架&#xff0c;底层就是基于MapReduce的 2022找工作是学历、能力和运气的超强结合体&#xff0c;遇到寒冬&#xff0c;大厂不招人&#xff0c;可能很多算法学…
阅读更多...
【C++】一文带你入门 STL

【C++】一文带你入门 STL

一 STL 组成 graph LRA[STL] --- B[容器 container]A --- C[配接器 adapter]A --- D[迭代器 iterator]A --- E[仿函数 function]A --- F[算法 algorithm]A --- G[空间配置器 allocator]二 常用容器 容器简介 下面我们来简单看一下这些容器的常用接口的使用&#xff0c;并分析…
阅读更多...
更新中-深度学习实战中遇到的一些概念+少量代码

更新中-深度学习实战中遇到的一些概念+少量代码

onnx ONNX 是一种用于机器学习模型的开放式表示格式&#xff0c;它可以让不同的深度学习框架之间共享模型。 import onnxruntime # 加载模型 session onnxruntime.InferenceSession(model.onnx) # 运行模型。第一个参数是输出变量列表&#xff0c;不指定的话返回所有值 outp…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023