Skip to content

Commit

Permalink
📝 (desensitization) 脱敏组件添加扩展脱敏规则文档
Browse files Browse the repository at this point in the history
  • Loading branch information
Hccake committed Apr 24, 2024
1 parent 3ba0681 commit 6833594
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/admin/server/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@

## 数据库配置

版本: mysql
版本: MySQL
默认字符集:utf8mb4
默认排序规则:utf8mb4_general_ci

:::warning
5.7.x 系列 mysql,需要开启 timestamp 类型默认值为 null 的支持, 在执行 sql 前先执行以下 sql.
5.7.x 及以下版本的 MySQL,需要开启 timestamp 类型默认值为 null 的支持, 在执行 sql 前先执行以下 sql.
```sql
set session explicit_defaults_for_timestamp = 1;
```
Expand Down
33 changes: 31 additions & 2 deletions docs/guide/feature/desensitization.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,36 @@ Ballcat 提供了 EasyExcel 对于脱敏注解的处理实现,具体使用参

## 扩展使用

### 自定义简单类型脱敏处理器
### 扩展脱敏规则
组件内置的规则无法实现业务需求时,可以通过实现 `SlideDesensitizeRule``RegexDesensitizeRule` 接口来对应扩展滑动脱敏或正则脱敏规则。

例如实现自己的银行卡号滑动脱敏规则,前7后3为明文,其他位替换为 *
```java
public class MyBankCardNoSlideDesensitizeRule implements SlideDesensitizeRule {

@Override
public int leftPlainTextLen() {
return 7;
}

@Override
public int rightPlainTextLen() {
return 3;
}

@Override
public String maskString() {
return "*";
}

@Override
public boolean reverse() {
return false;
}
}
```

### 扩展简单类型脱敏处理器

a) 首先定义自己的 `SimpleDesensitizationHandler` 实现类:

Expand Down Expand Up @@ -448,7 +477,7 @@ SimpleDesensitizationHandler desensitizationHandler =
/**
* 测试自定义脱敏
*/
@JsonSimpleDesensitize(handler = SimpleDesensitizatioHanderSPIExample.class)
@SimpleDesensitize(handler = SimpleDesensitizatioHanderSPIExample.class)
private String testField;
```

Expand Down

0 comments on commit 6833594

Please sign in to comment.