Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hxz393 committed Nov 27, 2023
1 parent 9689830 commit 7df8d4f
Show file tree
Hide file tree
Showing 4 changed files with 234 additions and 136 deletions.
69 changes: 56 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- **日志记录和错误处理**:配备先进的日志系统和错误处理机制。
- **实用功能**:包含搜索、复制、导出等多种功能,并设有忽略列表。

程序截图
主窗口截图

![main screen](https://raw.githubusercontent.com/hxz393/ConfigCenterComparer/main/doc/main_screen.jpg)

Expand All @@ -23,7 +23,7 @@
### 操作系统

- **开发环境**`Windows 10 专业工作站版`,版本 `22H2`
- **兼容性**:支持 `Win10 x64` 及更高版本操作系统。不支持 `Win 7``Win XP`,因为使用了 `Python 3.10`
- **兼容性**:支持 `Win 7 x64` 及更高版本操作系统。不支持`Win XP`。支持服务器 `Windows Server 2008` 以上版本
- **跨平台特性**:由于 QT 跨平台特征,其他操作系统理论上可手动编译成可执行文件。编译指南详见下文。

### 配置中心
Expand All @@ -46,7 +46,7 @@ Nacos 支持 `yaml` 格式的配置。不支持其他格式。

## 获取程序

对于 Win10 以上操作系统用户,可以直接下载使用。其他操作系统用户,可尝试通过源码构建可执行程序,或在 Python IDE 中运行。
在 Windows 平台,已打包两种版本。Win7 下可用版本,在文件名中标注了`-Win7(x64)`,请按需下载。其他操作系统用户,可尝试通过源码构建可执行程序,或在 Python IDE 中运行。

### 下载地址

Expand All @@ -55,11 +55,11 @@ Nacos 支持 `yaml` 格式的配置。不支持其他格式。
- **方式一**:前往 [release](https://github.com/hxz393/ConfigCenterComparer/releases) 页面下载 `ConfigCenterComparer.exe`
- **方式二**:通过 [百度网盘](https://pan.baidu.com/s/1RK7uBqaqgqJHLJbadXI48g?pwd=6666) 下载 `ConfigCenterComparer.7z` 压缩包,解压后运行。

下载的压缩包,需要解压缩后运行可执行文件,否则程序配置将无法保存
下载的压缩包,需要解压缩后再运行,否则程序配置将无处保存

### 自行打包

手动编译需要事先安装好 `Python 3.10` 以上版本、`PyQT 5.15` 以上版本和 `pyinstaller` 软件包。其他依赖报缺啥装啥
手动编译需要事先安装好 `Python 3.7` 以上版本、`PyQT 5.10` 以上版本和 `pyinstaller 5.6` 软件包。其他第三方依赖库有:`PyMySQL``PyYAML``paramiko``requests``sshtunnel`,没有版本规定

编译步骤如下:

Expand Down Expand Up @@ -94,6 +94,12 @@ Nacos 支持 `yaml` 格式的配置。不支持其他格式。
pyinstaller -F -w -i media/main.ico --add-data 'media/;media' ConfigCenterComparer.py
```

如果使用 `Anaconda` 作为虚拟环境,打包时要加上 `-p` 参数,指定虚拟环境所在目录。例如:

```sh
pyinstaller -F -w -i media/main.ico --add-data media/;media -p C:\ProgramData\Anaconda3\envs\ccc ConfigCenterComparer.py
```

成功编译后,可执行文件会生成到 `dist` 目录下面。


Expand Down Expand Up @@ -157,7 +163,7 @@ Nacos 支持 `yaml` 格式的配置。不支持其他格式。

- **选择语言**

默认为「English」。更换语言后需重启程序
默认为「English」。选择可切换程序显示语言

- **选择配置中心类型**

Expand All @@ -169,7 +175,7 @@ Nacos 支持 `yaml` 格式的配置。不支持其他格式。

- **表格颜色开关**

如果配置条目数量超过一万条,可以关闭表格颜色展示,可大幅提高运行速度
如果配置条目数量有上万条,可以关闭表格颜色展示,能大幅提高运行速度

- **替换服务名**

Expand All @@ -195,7 +201,7 @@ Nacos 支持 `yaml` 格式的配置。不支持其他格式。

Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json``config\config_nacos.json`。同样,不建议手动修改。

最多支持 4 套环境配置比对,通过选项卡点击切换。Apollo 和 Nacos 连接需要的配置一样,各配置项说明如下:
最多支持四套环境配置比对,通过选项卡点击切换。Apollo 和 Nacos 连接需要的配置一样,各配置项说明如下:

- **启用**

Expand Down Expand Up @@ -225,13 +231,13 @@ Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json` 和

## 开始

点击「测试连接」或「开始运行」按钮后,按钮变为灰色状态。运行完毕会显示弹窗或数据,完成时间由网络速度决定,请耐心等待。
点击「测试连接」或「开始运行」按钮后,按钮变为灰色状态。运行完毕会显示弹窗或数据,完成时间主要由网络速度决定,请耐心等待。

### 测试

配置好数据库连接后,可以先进行连通性测试。从工具栏或 「开始」菜单中,点击「测试连接」按钮或选项进行测试:

- 如果连接顺畅,大约 10 秒后会弹窗显示测试通过结果
- 如果连接顺畅,大约 10 秒后会弹窗显示 MySQL 和 SSH 连接测试结果
- 如果有网络或配置问题,导致连接失败,可能需要一段时间才会弹窗显示测试结果。可以在「查看日志」中分析连接失败具体原因。

### 运行
Expand All @@ -242,11 +248,28 @@ Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json` 和
- 如果有个别环境连接失败,将不会在最终结果中展示对应环境配置。可以在「查看日志」中分析连接失败具体原因。
- 如果要获取更新配置,可重新点击「开始运行」来更新表格。程序不会将结果缓存到本地文件中。

### 查重

从数据库获取到数据后,从工具栏或 「开始」菜单中,点击「配置查重」按钮或选项,可以对运行结果进行进一步查重。这个查重功能,对比的是同一环境下重复配置。例如:

在公共配置中配置过数据库连接池大小,那么在其他应用私有配置中,同样配置数据库连接池大小,且值与公共环境一致,可以认为应用私有配置中存在重复配置。

查重功能可以查找出此类配置。查重结果窗口如下图所示:

![connect settings](https://raw.githubusercontent.com/hxz393/ConfigCenterComparer/main/doc/comparison_results.jpg)

窗口分为两块:

- 主要区域为查重结果表格,通过选项卡对不同环境进行区分。出了主窗口中见过的字段,最左侧还有一列数字行号,由分组号码和组内号码组成。
- 上面有两个输入框,具体作用为:
- 公共配置输入框,用于标记公共配置所在行。输入公共配置名例如 `global` ,点击「设置」后,global 所在的整行会以红色字体显示。
- 搜索输入框,从配置键或值中搜索内容。没有匹配的行将会被隐藏。搜索字段不区分大小写。



## 结果展示

主界面包含菜单栏、工具栏、过滤栏、主表格和状态栏,下面主要说明主表格。
主界面从上到下分别为菜单栏、工具栏、过滤栏、主表格和状态栏,下面主要说明主表格。

### 表头

Expand All @@ -264,7 +287,7 @@ Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json` 和
- 不一致:所有不符合以上状态的情况,都归为不一致。
- **忽略**:值为「是」或者「否」。为用户手动设置。

表头支持拖动排列,点击表头能排序。右键表头可以选择隐藏或显示某列数据
表头支持拖动排列,点击表头能排序。表头右键菜单可以选择隐藏或显示某列数据

### 颜色

Expand All @@ -288,7 +311,7 @@ Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json` 和

### 快速过滤

针对「一致性」和「忽略」列的值,进行过滤。在下拉框中选择过滤条件,选中的条件如果匹配某行的值,匹配行会从表格中隐藏。
针对「一致性」和「忽略」列的值进行过滤。在下拉框中选择过滤条件,选中的条件如果匹配某行的值,匹配行会从表格中隐藏。

如果勾选「反选」框,则表格中只会展示匹配的行。

Expand Down Expand Up @@ -338,6 +361,8 @@ Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json` 和

左下角「清空」按钮,点击会清空日志文件内容。日志文件存放在 `logs` 目录内,超过 1MB 大小会回滚,最多保留十个文件。

右下角「刷新」按钮,点击可以切换日志持续显示模式,方便监控日志。

### 检查更新

从「帮助」菜单选择「检查更新」,将会在线检查程序是否有更新版本。以弹窗告知检查结果。
Expand All @@ -346,6 +371,10 @@ Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json` 和

从「帮助」菜单选择「关于软件」,弹出程序说明和构建信息。

### 调试程序

开发调试代码使用,对用户没有实际作用。



# 常见问题
Expand All @@ -358,6 +387,20 @@ Apollo 和 Nacos 的连接配置分别保存在 `config\config_apollo.json` 和

为避免更新日志过长,只保留最近更新日志。

## 版本 1.1.0(2023.11.28)

新增内容:

1. 新增配置查重功能;
2. 日志查看窗口新增刷新按钮。

优化内容:

1. 修改语言管理类,切换语言立即生效,不再需要重启;
2. 修改配置管理类,减少对配置文件读取次数;
3. 修改日志查看窗口显示模式,可独立主窗口运行;
4. 修改代码以向下支持到 Python 3.7,并提供 Win 7 下可用版本。

## 版本 1.0.2(2023.11.21)

新增内容:
Expand Down
Loading

0 comments on commit 7df8d4f

Please sign in to comment.