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

 更新时间:2023年10月10日 14:52:08   作者:掉发的小王  
我们在项目中会处理敏感数据时,通常需要对这些数据进行脱敏,本文主要使用了Springboot整合Hutool来自定义注解实现数据脱敏,感兴趣的可以理解下

一、前言

我们在项目中会处理敏感数据(如手机号、身份证号、姓名、地址等)时,通常需要对这些数据进行脱敏,以确保数据隐私和安全。

我们本次使用 Hutool 库来轻松实现数据脱敏,如果项目中不让使用,可以自己防着hutool来写一些工具类。

本次使用Springboot整合Hutool来自定义注解实现数据脱敏!

二、什么是数据脱敏

数据脱敏(Data Masking) ,也称为数据遮蔽或数据隐藏,是一种 数据保护技术 ,用于处理和存储敏感数据时,以减少或消除数据中的敏感信息,从而保护数据的隐私和安全。数据脱敏的主要目的是在保持数据可用性的同时,减少数据泄露和滥用的风险。

数据脱敏一般指数据库正常存储,返回前端时进行数据库处理!

三、Hutool简介

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

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

虽然Hutool可能会有一些bug,比起小编写的还是强上不少的,所以选定它来!

现在最新版为: 5.8.16 ,我们直接使用最新的,bug会少一些,功能会完善一些!

支持的脱敏规则:

  • 用户id
  • 中文姓名
  • 身份证号
  • 座机号
  • 手机号
  • 地址
  • 电子邮件
  • 密码
  • 中国大陆车牌,包含普通车辆、新能源车辆
  • 银行卡

四、实战整合

1. 导入依赖

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

2. 自定义注解

@JsonSerialize(using = SensitiveInfoSerializer.class) 用于指定在序列化时应该使用哪个自定义序列化器类

需要和下面的注解搭配使用 SensitiveInfoSerializer 我们自定义的序列化器才会生效

@JacksonAnnotationsInside 主要用于标记其他自定义注解,这意味着你可以在一个 Jackson 注解内部使用其他自定义注解,以组合各种注解来实现更复杂的序列化和反序列化逻辑。

/**
 * @author wangzhenjun
 * @date 2023/9/11 14:15
 */
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveInfoSerializer.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Desensitization {
    DesensitizationType type() default DesensitizationType.DEFAULT;
    /**
     * 前置不需要打码的长度
     */
    int prefixLen() default 0;
    /**
     * 后置不需要打码的长度
     */
    int suffixLen() default 0;
    /**
     * 遮罩字符
     */
    String maskingChar() default "*";
}

3. 支持类型枚举

/**
 * @author wangzhenjun
 * @date 2023/9/11 14:43
 */
public enum DesensitizationType {
    // 自定义规则
    CUSTOMIZE_RULE,
    // 默认的
    DEFAULT,
    //用户id
    USER_ID,
    //中文名
    CHINESE_NAME,
    //身份证号
    ID_CARD,
    //座机号
    FIXED_PHONE,
    //手机号
    MOBILE_PHONE,
    //地址
    ADDRESS,
    //电子邮件
    EMAIL,
    //密码
    PASSWORD,
    //中国大陆车牌,包含普通车辆、新能源车辆
    CAR_LICENSE,
    //银行卡
    BANK_CARD
}

4. 自定义序列化器

关于自定义的规则,大家可以根据自己的需求来写工具类,我这里简单使用Hutool的工具来了!

StrUtil.replace(value, prefixLen, suffixLen, maskingChar) StrUtil.hide(value, prefixLen, suffixLen)

createContextual 方法首先在序列化过程开始时被调用,返回的序列化器实例将用于后续的序列化过程。

serialize 方法责实际的序列化逻辑,将字段的值转换为JSON,并可以在其中执行自定义的脱敏逻辑。

/**
 * 数据脱敏序列化器
 *
 * @author wangzhenjun
 * @date 2023/9/11 14:16
 */
public class SensitiveInfoSerializer extends JsonSerializer<String> implements ContextualSerializer {
    private boolean useMasking = false;
    private DesensitizationType type;
    private int prefixLen;
    private int suffixLen;
    private String maskingChar;
    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        if (useMasking && value != null) {
            switch (type) {
                case MOBILE_PHONE:
                    gen.writeString(DesensitizedUtil.mobilePhone(value));
                    break;
                case ID_CARD:
                    gen.writeString(DesensitizedUtil.idCardNum(value, prefixLen, suffixLen));
                    break;
                case CUSTOMIZE_RULE:
//                    gen.writeString(StrUtil.replace(value, prefixLen, suffixLen, maskingChar));
                    gen.writeString(StrUtil.hide(value, prefixLen, suffixLen));
                    break;
                case CHINESE_NAME:
                    gen.writeString(DesensitizedUtil.chineseName(value));
                    break;
                case DEFAULT:
                    gen.writeString(value);
                default:
                    gen.writeString(value);
            }
        } else {
            gen.writeObject(value);
        }
    }
    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) {
        if (property != null) {
            Desensitization desensitization = property.getAnnotation(Desensitization.class);
            if (desensitization != null) {
                this.type = desensitization.type();
                this.prefixLen = desensitization.prefixLen();
                this.suffixLen = desensitization.suffixLen();
                this.maskingChar = desensitization.maskingChar();
                useMasking = true;
            }
        }
        return this;
    }
}

5. 实体类应用

/**
 * @author wangzhenjun
 * @date 2023/9/12 9:15
 */
@Data
public class User {
    @Desensitization(type = DesensitizationType.ID_CARD,prefixLen = 6,suffixLen = 16)
    private String cardId;
    @Desensitization(type = DesensitizationType.CHINESE_NAME)
    private String name;
    @Desensitization(type = DesensitizationType.MOBILE_PHONE)
    private String phone;
    @Desensitization(type = DesensitizationType.CUSTOMIZE_RULE,prefixLen = 3,suffixLen = 6)
    private String info;
}

6. 测试

@GetMapping("/getUser")
public Result getUser(){
    User user = new User();
    user.setCardId("372911111111111111");
    user.setPhone("15822229999");
    user.setName("赵飞燕");
    user.setInfo("这是机密文件,该打码打码");
    return Result.success(user);
}

完美脱敏,此次应该有掌声!

五、总结

本文通过Spring Boot与Hutool库的结合使用自定义注解,提供了一个简单而强大的方式来实现数据脱敏。希望能帮助到你,成功地实现数据脱敏功能,并提高应用程序的安全性。

本次例子脱敏选项没有演示全,大家可以自行补充完成,成为你们需要的数据脱敏策略,从而完美的处理用户数据脱敏问题!

可以试着使用AOP来完成脱敏,有兴趣的可以试一下哈!

以上就是Springboot+Hutool自定义注解实现数据脱敏的详细内容,更多关于Springboot Hutool数据脱敏的资料请关注脚本之家其它相关文章!

相关文章

  • FeignClient支持运行时动态指定URL方式

    FeignClient支持运行时动态指定URL方式

    在实际开发中,我们经常通过FeignClient接口调用三方API,当面对不同的环境对应不同的地址时,可以通过配置文件和占位符来切换,但在同一个环境中需要调用不同地址的相同接口时,这种方法就失效了,此时,可以通过实现RequestInterceptor接口来动态切换地址
    2024-11-11
  • logback-spring.xml的配置及示例详解(直接复制粘贴可用)

    logback-spring.xml的配置及示例详解(直接复制粘贴可用)

    在使用logback作为日志框架时,可以创建一个名为logback-spring.xml的配置文件来自定义日志输出的格式和方式,下面这篇文章主要给大家介绍了关于logback-spring.xml的配置及示例详解的相关资料,文中的代码直接复制粘贴可用,需要的朋友可以参考下
    2024-01-01
  • 基于Spring + Spring MVC + Mybatis 高性能web构建实例详解

    基于Spring + Spring MVC + Mybatis 高性能web构建实例详解

    这篇文章主要介绍了基于Spring + Spring MVC + Mybatis 高性能web构建实例详解,需要的朋友可以参考下
    2017-04-04
  • 一文带你了解Java排序算法

    一文带你了解Java排序算法

    这篇文章主要为大家详细介绍了Java中常见的三个排序算法:选择排序,冒泡排序和插入排序,文中的示例代码讲解详细,感兴趣的可以了解一下
    2022-08-08
  • 如何将文件流转换成byte[]数组

    如何将文件流转换成byte[]数组

    这篇文章主要介绍了如何将文件流转换成byte[]数组,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • Java中Semaphore(信号量)的使用方法

    Java中Semaphore(信号量)的使用方法

    这篇文章主要介绍了Java中Semaphore(信号量)的使用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • 深入理解Java设计模式之职责链模式

    深入理解Java设计模式之职责链模式

    这篇文章主要介绍了JAVA设计模式之职责链模式的的相关资料,文中示例代码非常详细,供大家参考和学习,感兴趣的朋友可以了解
    2021-11-11
  • java使用短信设备发送sms短信的示例(java发送短信)

    java使用短信设备发送sms短信的示例(java发送短信)

    这篇文章主要介绍了java使用短信设备发送sms短信的示例(java发送短信),需要的朋友可以参考下
    2014-04-04
  • 深度解析Java中的JSONObject从基础到高级应用

    深度解析Java中的JSONObject从基础到高级应用

    在当今前后端分离的架构中,JSONObject已成为Java开发者处理JSON数据的瑞士军刀,本文将深入解析JSONObject的核心机制与实战技巧,感兴趣的朋友跟随小编一起看看吧
    2025-09-09
  • Java日常练习题,每天进步一点点(10)

    Java日常练习题,每天进步一点点(10)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-07-07

最新评论