利用Hutool+自定义注解实现数据脱敏

已于 2023-09-16 16:58:16 修改
阅读量530 收藏
点赞数
文章标签： java spring boot
于 2023-09-06 14:07:30 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/HackAzrael/article/details/132714124
版权

利用Hutool+自定义注解实现数据脱敏

前言

我们在使用手机银行的时候经常能看到APP上会将银行卡的卡号中间部分给隐藏掉使用 ***** 来代替，在某些网站上查看一些业务密码时（例如签到密码等）也会使用 ***** 来隐藏掉真正的密码，那么这种方式是如何实现的呢？

Hutool

Hutool是一个小而全的Java工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率，使Java拥有函数式语言般的优雅，让Java语言也可以“甜甜的”。

Hutool中的工具方法来自每个用户的精雕细琢，它涵盖了Java开发底层代码中的方方面面，它既是大型项目开发中解决小问题的利器，也是小型项目中的效率担当；

Hutool是项目中 util 包友好的替代，它节省了开发人员对项目中公用类和公用工具方法的封装时间，使开发专注于业务，同时可以最大限度的避免封装不完善带来的bug。

我们这篇文章的实现思路就基于Hutool来实现，在Hutool中提供了一个名为 DesensitizedUtil 的工具类，我们使用这个工具类来加密。

首先我们先来看一下这个类里的具体实现，如下：

image.png

我们可以看到映入眼帘的除了一个无参构造之外就是一个名为 desensitized 的方法，这个方法就是我们加密的主要方法，里面利用了 switch…case 方法来区分不同的加密方法。我们可以来写一个单元测试来测试一下通过这个方法加密后是什么样的。

image.png

以上为加密后的信息，里面我使用了不同的类型来进行加密，目前最新版的Hutool支持脱敏加密的类型如下：

  1. 用户ID
  2. 中文名
  3. 密码
  4. 地址
  5. 邮箱
  6. 座机号
  7. 手机号
  8. 中国大陆的车牌号
  9. 银行卡号
  10. IPv4地址
  11. IPv6地址
  12. 自定义脱敏

实现

通过以上的示例我们就可以开始编写我们自己的脱敏操作了，首先我们要先根据以上Hutool中提供的脱敏类型来编写我们自己的类型**（如嫌麻烦也可省略此步骤，直接使用DesensitizedUtil中的DesensitizedType）**

编写数据脱敏类型

/**
 * @author Bummon
 * @description 数据脱敏策略
 * @date 2023-09-01 17:43
 */
public enum DataMaskingType {

    /**
     * 用户ID
     */
    USER_ID,
    /**
     * 中文名
     */
    CHINESE_NAME,
    /**
     * 身份证号
     */
    ID_CARD,
    /**
     * 座机
     */
    FIXED_PHONE,
    /**
     * 手机号
     */
    MOBILE_PHONE,
    /**
     * 地址
     */
    ADDRESS,
    /**
     * 邮箱
     */
    EMAIL,
    /**
     * 密码
     */
    PASSWORD,
    /**
     * 中国大陆车牌号
     */
    CAR_LICENSE,
    /**
     * 银行卡号
     */
    BANK_CARD,
    /**
     * IPv4地址
     */
    IPV4,
    /**
     * IPv6地址
     */
    IPV6,
    /**
     * 自定义类型
     */
    CUSTOM;

}

编写自定义注解

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;

/**
 * @author Bummon
 * @description 数据脱敏自定义注解
 * @date 2023-09-01 18:01
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = DataMaskingSerialize.class)
public @interface DataMasking {

    /**
     * 数据脱敏类型
     */
    DataMaskingType type() default DataMaskingType.CUSTOM;

    /**
     * 脱敏开始位置（包含）
     */
    int start() default 0;

    /**
     * 脱敏结束位置（不包含）
     */
    int end() default 0;

}

需要注意的是：当DataMaskingType为 CUSTOM 时，才需要填写 start 和 end ，且这两个参数才会生效，且 start 中是包含当前下标的字符的，而 end 不包含当前下标的字符。

编写自定义序列化类

import cn.hutool.core.text.CharSequenceUtil;
import cn.hutool.core.util.DesensitizedUtil;
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;

/**
 * @author Bummon
 * @description
 * @date 2023-09-01 18:14
 */
@AllArgsConstructor
@NoArgsConstructor
public class DataMaskingSerialize extends JsonSerializer implements ContextualSerializer {

    private DataMaskingType type;

    private Integer start;

    private Integer end;

    @Override
    public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        String value = (String) o;
        switch (type) {
            //userId
            case USER_ID:
                jsonGenerator.writeString(String.valueOf(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.USER_ID)));
                break;
            //中文名
            case CHINESE_NAME:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.CHINESE_NAME));
                break;
            //身份证号
            case ID_CARD:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.ID_CARD));
                break;
            //座机
            case FIXED_PHONE:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.FIXED_PHONE));
                break;
            //手机号
            case MOBILE_PHONE:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.MOBILE_PHONE));
                break;
            //地址
            case ADDRESS:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.ADDRESS));
                break;
            //邮箱
            case EMAIL:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.EMAIL));
                break;
            case BANK_CARD:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.BANK_CARD));
                break;
            //密码
            case PASSWORD:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.PASSWORD));
                break;
            //中国大陆车牌号
            case CAR_LICENSE:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.CAR_LICENSE));
                break;
            case IPV4:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.IPV4));
                break;
            case IPV6:
                jsonGenerator.writeString(DesensitizedUtil.desensitized(value, DesensitizedUtil.DesensitizedType.IPV6));
                break;
            //自定义
            case CUSTOM:
                jsonGenerator.writeString(CharSequenceUtil.hide(value, start, end));
                break;
            default:
                break;
        }
    }

    @Override
    public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty) throws JsonMappingException {
        if (Objects.nonNull(beanProperty)) {
            //判断是否为string类型
            if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {
                DataMasking anno = beanProperty.getAnnotation(DataMasking.class);
                if (Objects.isNull(anno)) {
                    anno = beanProperty.getContextAnnotation(DataMasking.class);
                }
                if (Objects.nonNull(anno)) {
                    return new DataMaskingSerialize(anno.type(), anno.start(), anno.end());
                }
            }
            return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
        }
        return serializerProvider.findNullValueSerializer(null);
    }
}

我们继承于 JsonSerializer 并实现了 ContextualSerializer 中的方法，并对我们自定义注解声明的字段进行拦截和脱敏加密操作，接下来我们可以来测试一下效果。

测试

因为是实例化的时候才会被脱敏，那我们就创建一个实体类来存放我们需要加密的信息。

编写测试实体类

import com.bummon.mask.DataMasking;
import com.bummon.mask.DataMaskingType;
import lombok.*;

/**
 * @author Bummon
 * @description
 * @date 2023-09-01 18:29
 */
@Data
@Builder
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class TestEntity {

    @DataMasking(type = DataMaskingType.USER_ID)
    private Integer userId;

    @DataMasking(type = DataMaskingType.CHINESE_NAME)
    private String userName;

    @DataMasking(type = DataMaskingType.ADDRESS)
    private String address;

    @DataMasking(type = DataMaskingType.ID_CARD)
    private String idCard;

    @DataMasking(type = DataMaskingType.FIXED_PHONE)
    private String fixedPhone;

    @DataMasking(type = DataMaskingType.MOBILE_PHONE)
    private String mobilePhone;

    @DataMasking(type = DataMaskingType.EMAIL)
    private String email;

    @DataMasking(type = DataMaskingType.PASSWORD)
    private String password;

    @DataMasking(type = DataMaskingType.CAR_LICENSE)
    private String carLicense;

    @DataMasking(type = DataMaskingType.BANK_CARD)
    private String bankCard;

    @DataMasking(type = DataMaskingType.IPV4)
    private String ipv4;

    @DataMasking(type = DataMaskingType.IPV6)
    private String ipv6;

    @DataMasking(type = DataMaskingType.CUSTOM,start = 3,end = 9)
    private String custom;

    /**
     * 不进行数据脱敏的字段
     */
    private String noMask;


}

编写测试Controller

import com.bummon.entity.TestEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Bummon
 * @description
 * @date 2023-09-01 18:39
 */
@RestController
public class TestController {

    @GetMapping("/test")
    public TestEntity test() {
        return TestEntity.builder()
                .userId(1234567890)
                .userName("张三")
                .password("12")
                .address("河南省郑州市中原区")
                .email("xxxx@xx.com")
                .fixedPhone("0838-5553792")
                .mobilePhone("13888888888")
                .carLicense("豫P3U253")
                .bankCard("1679374639283740")
                .idCard("412711223344556677")
                .ipv4("192.168.1.236")
                .ipv6("abcd:1234:aCA9:123:4567:089:0:0000")
                .custom("289073458794")
                .noMask("我是不需要数据脱敏的字段")
                .build();
    }

}

接下来我们启动项目来看测试一下得到的是否为我们预期的数据：

image.png

我们可以看到，我们加了注解的字段都被正确的脱敏了，而没加注解的字段会正常显示。

总结

我们使用了Hutool的DesensitizedUtil中的 desensitized 方法来实现数据脱敏，在 CUSTOM 类型的脱敏字段中，start 和 end 两个属性是必填的，且 start 包含当前下标，而 end 不包含当前下标。

本文结束，感谢观看。

推荐

关注博客和公众号获取最新文章

Bummon’s Blog ｜ Bummon’s Home ｜ 公众号

Bummon.
关注
自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏【权限控制】
lucky_love816的博客
12-26 1111
我们在使用手机银行的时候经常能看到APP上会将银行卡的卡号中间部分给隐藏掉使用 ***** 来代替，在某些网站上查看一些业务密码时（例如签到密码等）也会使用 ***** 来隐藏掉真正的密码，那么这种方式是如何实现的呢？我们这篇文章的实现思路就基于Hutool来实现，在Hutool中提供了一个名为 DesensitizedUtil 的工具类，我们使用这个工具类来加密。
Hutool实现数据脱敏
BUG指挥课堂
07-20 7230
数据脱敏是一种通过去除或替换敏感数据中的部分信息，以保护数据隐私和安全的技术。其主要目的是确保数据仍然可以在各种场景中使用，同时保护敏感信息，防止数据泄露和滥用。数据脱敏通常用于处理包含个人身份信息和其他敏感信息的数据集，如手机号、姓名、地址、银行卡、身份证号、车牌号等等。在数据脱敏过程中，通常会采用不同的算法和技术，以根据不同的需求和场景对数据进行处理。例如，对于身份证号码，可以使用掩码算法（masking）将前几位数字保留，其他位用“X”或"*"代替；
【数据脱敏】身份证，手机号，密码数据脱敏hutool
舒克日记的博客
11-30 2371
在项目开发过程中，例如：身份证号码，电话号码，地址，邮箱号码这类敏感信息，希望不被别人看到。这时如果时前端做了脱敏操作，人们可以通过F12调试看到请求返回信息，仍能看到。所以需要后台开发做数据脱敏操作
利用 Hutool 提供的 DesensitizedUtil脱敏工具类配合 Jackson 通过注解的方式完成数据脱敏（自用）
qq_45713664的博客
09-09 917
要使用 Hutool 的 `DesensitizedUtil` 类配合 Jackson 注解来完成数据脱敏，可以遵循以下步骤。`DesensitizedUtil` 提供了多种脱敏方式（如手机号码、身份证号、姓名等），而 Jackson 注解允许你在序列化过程中应用这些脱敏操作。通过这些步骤，您可以利用 Hutool 提供的 `DesensitizedUtil` 脱敏工具类，并结合 Jackson 的自定义序列化器来实现数据脱敏。// 输出脱敏后的 JSON 字符串。-- 根据实际需要选择合适的版本 -->
Hutool工具类库
qq_38821319的博客
10-17 214
Hutool是一个小而全的Java工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率，使Java拥有函数式语言般的优雅，让Java语言也可以“甜甜的”。Hutool中的工具方法来自每个用户的精雕细琢，它涵盖了Java开发底层代码中的方方面面，它既是大型项目开发中解决小问题的利器，也是小型项目中的效率担当；Hutool是项目中“util”包友好的替代，它节省了开发人员对项目中公用类和公用工具方法的封装时间，使开发专注于业务，同时可以最大限度的避免封装不完善带来的bug。
Java（springboot下）中加密解密的实现（通过自定义密钥并基于hutool工具包进行实现）
m0_62586364的博客
01-09 2487
Java（springboot框架）中加密解密的实现（通过自定义密钥并基于hutool工具包进行实现）；引入依赖，可直接复制使用
自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏
08-11
自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏 自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏 自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏 自定义注解结合Hutool对SpringBoot接口返回...
利用Hutool与自定义注解实现SpringBoot数据脱敏
资源摘要信息:"在本篇文档中，我们将深入探讨如何利用自定义注解结合Hutool工具库在SpringBoot应用中对接口返回的数据进行脱敏处理。首先，我们将了解自定义注解在SpringBoot中的应用以及Hutool工具库的相关功能。...
利用自定义注解与Hutool库对SpringBoot接口返回数据进行高效脱敏处理
最新发布
11-08
利用自定义注解与Hutool库对SpringBoot接口返回数据进行高效脱敏处理
使用hutool快速进行身份证手机号脱敏、获取随机数等
gl_xxx的博客
01-15 1756
Hutool是一个Java工具包类库，对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装，组成各种Util工具类,这里演示两个常用工具类，当然他的功能远不止这些。
Hutool工具类集介绍及简单使用
liuerchong的博客
04-27 6759
Hutool是一个Java工具集，针对项目中util包进行开刀，抽象大量的工具方法，旨在减少项目中工具类的数量，将我们的编码工作专注在业务上。Hutool 对文件、流、加密解密、转码、正则、线程、XML、日期、Http客户端 等 JDK 方法进行封装，组成各种 Util 工具类。 Hutool并非框架，而是一个工具类方法集合，随用随取，且随时可被替换，与任何框架不冲突。 Hutool的大部分工具方...
Hutool：一行代码搞定数据脱敏
数字世界探险者
08-15 815
1.1数据脱敏的定义数据脱敏百度百科中是这样定义的：数据脱敏，指对某些敏感信息通过脱敏规则进行数据的变形，实现敏感隐私数据的可靠保护。这样就可以在开发、测试和其它非生产环境以及外包环境中安全地使用脱敏后的真实数据集。在涉及客户安全数据或者一些商业性敏感数据的情况下，在不违反系统规则条件下，对真实数据进行改造并提供测试使用，如身份证号、手机号、卡号、客户号等个人信息都需要进行数据脱敏。是数据库安全技术之一。总的来说，数据脱敏是指对某些敏感信息通过脱敏规则进行数据的变形，实现敏感隐私数据的可靠保护。
Hutool 实现敏感信息展示脱敏及其反脱敏
weixin_73077810的博客
11-16 2277
业务中如果出现敏感数据展示，数据脱敏是一种重要的安全措施。数据脱敏是指在处理和存储敏感信息时，将这些信息中的敏感部分替换为无意义的数据，以保护用户的隐私和数据安全。本文基于Hutool工具类来实现一键式快速数据脱敏操作
【Java】 sonar | java | sonar生成扫描token | 扫描示例 | 常见问题处理
hgSuper的博客
11-29 2611
1、sonar已经安装OK2、springboot项目3、maven项目。
Java好用的工具类及方法使用记录
qq_36203030的博客
07-26 574
java常用工具类记录
数据脱敏
weixin_41559555的博客
06-02 344
//判断某个字符串是否为空的标准是str==null或者str.length==0或者是str==""; StringUtils.isBlank(str) //判断某个字符串是否为空的标准是str==null或者str.length==0 StringUtils.isEmpty(str); 把一个字符串按逗号进行分割的方法： String ridStr=""; 循环得到一个list集合中的rid,在把他拼接成一个字符串并且用逗号进行分割开（因我代码中的rid是一个long类型，所以要去t..
【linlong】Idea项目端口号被占用
m0_70535240的博客
06-14 5420
【linlong】Idea启动项目端口号被占用问题
org.apache.commons.lang.StringUtils;的时候出错解决方法
热门推荐
Ranchonono的博客
07-24 1万+
import org.apache.commons.lang.StringUtils;的时候出错解决方法 菜鸟一枚，才开始学习后台以及idea，导入项目就遇到错误，这边的解决方法也是为自己备注一下以免下次遇到忘记了。 错误如下： 找到project structure下的libraries，看自己的lang包是多少。这边是3. 修改一下，加个3，变成 就可以了。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Bummon.

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值