124 lines
5.3 KiB
Markdown
124 lines
5.3 KiB
Markdown
# 报告生成工具使用文档
|
||
|
||
## 1. 功能简介
|
||
本工具用于根据风机巡检数据自动生成 Word 报告。
|
||
支持 **配置文件** 与 **命令行参数** 两种输入方式，命令行可覆盖配置文件中的同名字段。
|
||
|
||
## 2. 准备
|
||
1. 获取可执行程序。
|
||
2. 准备输出目录（默认 `./output`）。
|
||
3. 获取要生成报告的机组id。
|
||
4. 获取要生成的报告包含的检查来源（外部、内部、防雷）。
|
||
|
||
## 3. 配置文件启动
|
||
|
||
在项目根目录新建 `config.json`（或任意文件名,但需要在命令行指定），格式可如下，必填必须填写，选填则键也不需要，否则会覆盖默认值，下面是默认的配置文件：
|
||
```json
|
||
{
|
||
"json1": {
|
||
"turbine_id": "183463dbf40d9278549a76b82b175dd9" //机组id 必填
|
||
},
|
||
"json2": {
|
||
"shengcheng_dir": "./output", //输出目录 必填
|
||
|
||
//选填项
|
||
"if_waibu": true, //是否包含外部检测图片即对应信息
|
||
"if_neibu": true, //是否包含内部检测图片即对应信息
|
||
"if_fanglei": true, //是否包含防雷检测图片即对应信息
|
||
|
||
"userName": "admin", //报告编制人
|
||
"baogaoCheck": "未审核", //报告审核人
|
||
"key_words": "缺,损,裂,脱,污", //关键词（英文逗号分隔），用于汇总表标红
|
||
"data_processor": "未获取", //数据处理人
|
||
"jiancha_renyuan": "未获取", //检查人员
|
||
"check_date": null, //检查日期，日和时必须用空格分隔 YYYY-MM-DD hh:mm:ss
|
||
"coverurl": null, //封面图片 URL（不指定则获取project表中的封面url
|
||
"conclusion": "未填写总结", //报告总结文字
|
||
|
||
//报告结构定制
|
||
"if_docx_fengmian": true, //是否包含封面
|
||
"if_docx_project_overview": true, //是否包含项目概览表
|
||
"if_docx_inspection_method": true, //是否包含检查方案表
|
||
"if_docx_inspection_info": true, //是否包含检查信息表
|
||
"if_docx_chengguo_sub": true, //是否包含成果递交表
|
||
"if_docx_inspection_text": true, //是否包含检查汇总文字表
|
||
"if_docx_inspection_picture": true, //是否包含检查汇总图片表
|
||
"if_docx_defect_picture": true, //是否包含缺陷图片表
|
||
"if_docx_conclusion": true, //是否包含报告总结
|
||
|
||
//下面为枚举字段，程序通过这些字段在数据库中筛选、分类获取到的图片
|
||
"dianxing_enum": "TYPICAL", //典型图片类型枚举
|
||
"quexian_enum": "DEFECT", //缺陷图片类型枚举
|
||
"other_enum": "OTHER", //其他图片类型枚举 （目前程序不会操作其它图片）
|
||
"waibu_enum": "out-work", //外部图片来源枚举
|
||
"neibu_enum": "in-work", //内部图片来源枚举
|
||
"fanglei_enum": "lightning-protection-work", //防雷图片来源枚举
|
||
}
|
||
}
|
||
```
|
||
|
||
## 4. 命令行参数
|
||
|
||
| 参数 | 说明 | 示例 |
|
||
|------|------|------|
|
||
| `--config` / `-c` | 指定配置文件 | `--config prod.json` |
|
||
| `--turbine_id` / `--id` | 风机 ID | `--turbine_id 123456` |
|
||
| `--output_dir` / `--out` | 报告输出目录 | `--output_dir ./result` |
|
||
| `--template_dir` / `--tpl` | 模板目录 | `--template_dir ./tpl` |
|
||
| `--if_waibu` | 是否包含外部作业图片及信息 | `true` / `false` |
|
||
| `--if_neibu` | 是否包含内部作业图片及信息 | `true` / `false` |
|
||
| `--if_fanglei` | 是否包含防雷作业图片及信息 | `true` / `false` |
|
||
| `--userName` | 报告编制人 | `--userName 张三` |
|
||
| `--baogaoCheck` | 报告审核人 | `--baogaoCheck 已审核` |
|
||
| `--key_words` | 关键词（英文逗号分隔） | `--key_words 缺,损,裂` |
|
||
| `--data_processor` | 数据处理人 | `--data_processor 李四` |
|
||
| `--jiancha_renyuan` | 检查人员 | `--jiancha_renyuan 王五` |
|
||
| `--check_date` | 检查日期（YYYY-MM-DD hh:mm:ss） | `--check_date 2024-06-01 12:00:00` |
|
||
| `--coverurl` | 封面图片 URL | `--coverurl /stastic/path/to/pic` |
|
||
| `--conclusion` | 报告总结 | `--conclusion 整体良好` |
|
||
|
||
## 5. 使用示例
|
||
|
||
### 5.1 仅使用配置文件
|
||
根目录存放config.json后会加载config.json，或者使用命令行指定配置文件名和路径
|
||
|
||
#### Linux|bash
|
||
```bash
|
||
./report_generator
|
||
```
|
||
|
||
#### Windows|cmd
|
||
```cmd
|
||
./report_generator.exe
|
||
```
|
||
|
||
### 5.2 完全命令行
|
||
|
||
#### Linux|bash
|
||
```bash
|
||
./report_generator \
|
||
--turbine_id 123456 \
|
||
--output_dir ./my_out \
|
||
--if_waibu false \
|
||
--userName Alice \
|
||
--check_date 2024-06-01 \
|
||
--conclusion "检查完毕，无异常"
|
||
```
|
||
|
||
#### Windows|cmd
|
||
```cmd
|
||
./report_generator.exe \
|
||
--turbine_id 123456 \
|
||
--output_dir ./my_out \
|
||
--if_waibu false \
|
||
--userName Alice \
|
||
--check_date 2024-06-01 \
|
||
--conclusion "检查完毕，无异常"
|
||
```
|
||
|
||
### 5.3 混合方式
|
||
|
||
#### Linux|bash
|
||
```bash
|
||
./report_generator --config config.json --userName Bob --if_fanglei false
|
||
``` |