add README.md.

master
applesline 2022-01-21 03:54:13 +00:00 committed by Gitee
parent a5acb554cd
commit 6802fb12a0
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
1 changed files with 66 additions and 0 deletions

66
README.md Normal file
View File

@ -0,0 +1,66 @@
# desensitize
#### 介绍
数据脱敏工具包
#### 软件架构
#### 安装教程
1. 添加依赖
```
<dependency>
<groupId>io.github.applesline</groupId>
<artifactId>desensitize</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
```
2. 打开脱敏开关 @EnableDesensitize
```
import org.applesline.desensitize.annotation.EnableDesensitize;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableDesensitize
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
```
3. 针对方法的局部脱敏 @Desensitize
```
@RequestMapping("4")
@Desensitize(fieldMapping = @FieldMapping(fields = {"_mobile"},type = DesensitizeType.MOBILE))
public Result demo4() {
return new Result("111111111@163.com","17622233344");
}
```
#### 使用说明
1. xxxx
2. xxxx
3. xxxx
#### 参与贡献
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request
#### 特技
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)