d18n 项目教程

1. 项目目录结构及介绍

d18n 是一个用于关系型数据库（RDBMS）的数据脱敏工具。以下是项目的目录结构及其介绍：

d18n/
├── cmd/
│   └── d18ncmd/
│       └── d18n
├── common/
├── corpus/
├── detect/
├── doc/
│   ├── db.md
│   ├── mask.md
│   ├── quickstart.md
│   └── save.md
├── emport/
├── lint/
├── mask/
├── preview/
├── save/
├── test/
├── .gitignore
├── COPYRIGHT
├── LICENSE
├── Makefile
├── README.md
├── go.mod
└── go.sum

目录结构介绍

• cmd/: 包含项目的命令行工具入口文件。
  • d18ncmd/: 具体的命令行工具实现。
    • d18n: 启动文件，用于执行数据脱敏操作。
• common/: 包含项目通用的工具和函数。
• corpus/: 包含用于数据脱敏的语料库。
• detect/: 包含敏感信息检测的相关代码。
• doc/: 包含项目的文档文件。
  • db.md: 数据库支持的文档。
  • mask.md: 数据脱敏策略的文档。
  • quickstart.md: 快速入门指南。
  • save.md: 保存查询结果的文档。
• emport/: 包含数据导入的相关代码。
• lint/: 包含数据文件格式检查的相关代码。
• mask/: 包含数据脱敏的具体实现。
• preview/: 包含数据预览的相关代码。
• save/: 包含数据保存的相关代码。
• test/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• COPYRIGHT: 版权信息。
• LICENSE: 项目许可证。
• Makefile: 项目的构建文件。
• README.md: 项目介绍和使用说明。
• go.mod: Go 模块依赖文件。
• go.sum: Go 模块依赖的校验文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/d18ncmd/d18n，这是一个可执行的二进制文件。启动文件的主要功能是执行数据脱敏操作，支持多种数据库类型和数据脱敏策略。

启动文件的使用

./cmd/d18ncmd/d18n --help

通过 --help 参数可以查看启动文件支持的所有命令和参数。

3. 项目的配置文件介绍

d18n 项目的配置文件主要包括以下几种：

3.1 数据库配置

在执行数据脱敏操作时，需要指定数据库的连接信息。可以通过命令行参数 --dsn 或 --defaults-extra-file 来指定数据库连接字符串或配置文件。

3.2 数据脱敏配置

数据脱敏的配置文件通常是一个 CSV 文件，定义了需要脱敏的字段及其脱敏规则。配置文件的路径可以通过 --mask 参数指定。

3.3 敏感信息检测配置

敏感信息检测的配置文件通常是一个 YAML 文件，定义了需要检测的敏感信息类型及其规则。配置文件的路径可以通过 --sensitive 参数指定。

3.4 其他配置

• --file: 指定查询结果的保存文件类型和路径。
• --limit: 限制查询结果的行数。
• --verbose: 输出详细的执行信息。

通过这些配置文件和命令行参数，可以灵活地配置和执行数据脱敏操作。