数据脱敏库 desensitization 使用手册

数据脱敏库 desensitization 使用手册

desensitization 项目地址: https://gitcode.com/gh_mirrors/de/desensitization

安装指南

Maven 集成

为了将 desensitization 库整合到您的项目中，您需要在 pom.xml 文件中添加以下依赖：

<dependencies>
    <dependency>
        <groupId>red.zyc</groupId>
        <artifactId>desensitization</artifactId>
        <version>3.0.0</version>
    </dependency>
</dependencies>

确保您的环境兼容 JDK 1.8 或更高版本。对于基于 JDK21 开发的功能，请确保您的开发与运行时环境满足要求。

非Maven项目

如果您不使用 Maven 管理项目，可以通过下载 JAR 包的形式引入依赖。前往项目 Releases 页面，下载对应版本的 JAR，并将其添加到项目的类路径中。

项目的使用说明

对象属性脱敏

标记敏感字段

首先，为敏感数据字段加上对应的注解，如 @ChineseName, @PhoneNumber 等。示例中展示了 Child 类的定义，其中包含了各种类型的数据脱敏需求。

public class Child {
    @ChineseName
    public String name = "小明";
    @PhoneNumber
    public String phoneNumber = "19962000001";
    @Password
    public String password = "123456789";
    @Cascade
    public Father father;
    // 父类Father的定义省略，假设它也有受保护的敏感信息
}

脱敏操作

使用 Sensitive.desensitize() 方法来创建一个脱敏后的对象副本：

Child sanitizedChild = Sensitive.desensitize(new Child());

这会自动替换所有标记了敏感注解的字段值，以符合脱敏规则。

字面量或集合脱敏

对于非对象的敏感数据（如字符串列表、数组、映射），您需要提供数据的类型以及其上的敏感注解，以便正确脱敏：

// 字符串脱敏示例
String emailDesensitized = Sensitive.desensitize("123456@qq.com", new AnnotatedTypeToken<@Email String>() {});

// 列表脱敏
List<String> emailsDesensitized = Sensitive.desensitize(
    Stream.of("123456@qq.com").collect(Collectors.toList()),
    new AnnotatedTypeToken<List<@Email String>>() {}
);

// 数组脱敏
String[] emailsArrayDesensitized = Sensitive.desensitize(
    new String[]{"123456@qq.com"},
    new AnnotatedTypeToken<@Email String[]>() {}
);

// 映射脱敏
Map<String, String> namesAndEmailsDesensitized = Sensitive.desensitize(
    Stream.of(new SimpleEntry<>("张三", "123456@qq.com")).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)),
    new AnnotatedTypeToken<Map<@ChineseName String, @Email String>>() {}
);

项目API使用文档

Sensitive 类提供了主要的脱敏功能，具体方法包括：

• desensitize(Object object)：对整个对象进行脱敏处理。
• desensitize(T value, AnnotatedTypeToken<T> typeToken)：适用于基本类型、集合、数组或映射的脱敏，通过类型令牌指定敏感性注解。

项目扩展

如果您正在使用 Spring Boot，推荐使用 desensitization-spring-boot starter，它可以自动化数据脱敏流程，减少编码工作。

许可证

本项目遵循 Apache License 2.0，您可以自由地使用、修改和分发，但需遵守许可证条款。

---

以上便是 desensitization 数据脱敏库的基本使用手册，通过遵循这些步骤，您能够轻松实现敏感数据的安全处理。

desensitization 项目地址: https://gitcode.com/gh_mirrors/de/desensitization