sensitive-spring-boot-starter 使用教程

最新推荐文章于 2024-09-14 08:06:27 发布

余钧冰Daniel

最新推荐文章于 2024-09-14 08:06:27 发布

阅读量1k

点赞数 24

本文链接：https://blog.csdn.net/gitblog_00862/article/details/142239497

版权

sensitive-spring-boot-starter 使用教程

sensitive-spring-boot-starter 一款强大的数据脱敏插件，支持多种脱敏策略（中文姓名、身份证号、固定电话、手机号码、地址、电子邮箱、密码、车牌号、银行卡号...），支持自定义脱敏策略，支持自定义脱敏替换符，支持多层嵌套属性脱敏，支持在Controller上使用注解跳过脱敏... 项目地址: https://gitcode.com/gh_mirrors/se/sensitive-spring-boot-starter

1. 项目介绍

sensitive-spring-boot-starter 是一款强大的数据脱敏插件，支持多种脱敏策略，包括中文姓名、身份证号、固定电话、手机号码、地址、电子邮箱、密码、车牌号、银行卡号等。此外，还支持 AES、DES、BASE64、RSA 等加密算法进行数据脱敏。该插件支持自定义脱敏策略、自定义脱敏替换符，并且支持多层嵌套属性脱敏。在 Controller 上使用注解可以跳过脱敏。

2. 项目快速启动

2.1 导入依赖

首先，在项目的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.lzhpo</groupId>
    <artifactId>sensitive-spring-boot-starter</artifactId>
    <version>${latest-version}</version>
</dependency>

2.2 配置实体类

在需要脱敏的实体类字段上使用 @Sensitive 注解配置脱敏规则。例如：

import com.lzhpo.sensitive.annotation.Sensitive;
import com.lzhpo.sensitive.strategy.SensitiveStrategy;

public class User {
    @Sensitive(strategy = SensitiveStrategy.CHINESE_NAME)
    private String name;

    @Sensitive(strategy = SensitiveStrategy.ID_CARD)
    private String idCard;

    @Sensitive(strategy = SensitiveStrategy.MOBILE_PHONE)
    private String mobilePhone;

    // Getters and Setters
}

2.3 启动应用

完成上述配置后，启动 Spring Boot 应用即可。插件会自动对标注了 @Sensitive 注解的字段进行脱敏处理。

3. 应用案例和最佳实践

3.1 自定义脱敏策略

如果内置的脱敏策略不能满足需求，可以通过自定义脱敏策略来实现。例如，保留前后缀脱敏策略：

import com.lzhpo.sensitive.annotation.Sensitive;
import com.lzhpo.sensitive.strategy.SensitiveStrategy;
import com.lzhpo.sensitive.annotation.SensitiveKeepLength;

public class CustomUser {
    @Sensitive(strategy = SensitiveStrategy.CUSTOMIZE_KEEP_LENGTH)
    @SensitiveKeepLength(preKeep = 1, postKeep = 1)
    private String name;

    // Getters and Setters
}

3.2 忽略特定接口的脱敏

在某些情况下，可能需要忽略特定接口的脱敏处理。可以通过在 Controller 上使用 @IgnoreSensitive 注解来实现：

import com.lzhpo.sensitive.annotation.IgnoreSensitive;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.http.ResponseEntity;

@RestController
@RequestMapping("/ignore")
@IgnoreSensitive
public class NoSensitiveController {

    @GetMapping("sample")
    public ResponseEntity<User> sample() {
        return ResponseEntity.ok(new User("张三", "123456789012345678", "13800138000"));
    }
}