借助网络配置,控制Modbus工具的日志显示,避免卡死界面
智能大石头 authored at 2021-12-11 22:09:19
16.71 KiB
XCoder
# 码神工具(XCoder)需求文档 > 版本:v1.0 | 日期:2026-11-11 > 定位:跨平台桌面开发者工具箱(Windows / Linux x64+arm64 / LoongArch 新世界 / macOS) > 完成状态见[功能清单](/NewLife/XCoder/Blob/master/Doc/功能清单.md),实现方案见[架构设计](/NewLife/XCoder/Blob/master/Doc/架构设计.md),界面方案对比见[界面布局方案对比](/NewLife/XCoder/Blob/master/Doc/界面布局方案对比.md),HTML 原型见[界面设计](/NewLife/XCoder/Blob/master/Doc/界面设计/index.html)。 本文档只回答「码神工具做成什么样」,不写实现细节。 --- ## 1. 背景与愿景 ### 1.1 系统定位 码神工具是面向**开发者与运维工程师**的多功能桌面工具箱:数据建模与代码生成、网络与协议调试、工业设备通信、加解密与文本处理、系统与媒体小工具。单一下载、单一下载包内聚齐全部工具,离线可用。 二十余年一直用 WinForms(MDI + 顶部菜单)实现,当前主力用户为 Windows 10/11 开发者,少量服务器系统与国产 Linux 环境(含 LoongArch 新世界)。本次革新的目标是:**一套代码、一个产品形态,同时覆盖 Windows、主流 Linux(x64/arm64/LoongArch 新世界)与 macOS**,并在高分辨率屏幕、非 100% 缩放、远程桌面等场景下保持清晰稳定。信创方向已有明确客户/招标要求,目标为新世界 ABI 2.0;具体验收以客户实际环境为准。 ### 1.2 愿景 - **一次到位**:把现有 WinForms 版、Avalonia 实验版、macOS 版的功能合并为**唯一一个产品**,不再出现「某平台只有壳、某些工具缺失」的状态。「一次到位」指同一版本发布全部目标平台;硬件类工具按平台能力矩阵声明可用性,未验收的能力置灰并说明,不等同于「每个平台所有硬件工具都已验证」。 - **工具好找、好开、好并用**:像应用商店一样浏览工具,像 IDE 一样开标签并行使用,像启动器一样一个快捷键直达。 - **界面清晰**:矢量图标、统一的间距与配色、浅色/深色双主题并跟随系统,任何缩放下都不模糊、不串位。 - **跨平台能力尽量对等**:纯托管工具全平台一致;硬件类工具按平台能力矩阵给出真实能力或明确提示,不静默失败;未验收的能力置灰。 ### 1.3 核心竞品(参考产品,用于界面与功能取舍) | 产品 | 定位 | 值得借鉴的做法 | |------|------|----------------| | DevToys | 开发者工具箱,单一应用内多工具 | 工具卡片首页 + 左侧分组列表 + 搜索直达 + 单窗口工具宿主 | | Microsoft PowerToys | 系统增强工具集 | 单实例 + 托盘 + 快捷键唤起;每个工具独立窗口可选 | | 360 安全卫士 / 火绒 | 面向大众的工具集 | 「小工具图标墙」心智;点击即用、零学习成本 | | JetBrains Toolbox / VS Code | 开发工具容器 | 左侧导航 + 顶部标签 + 可停靠/拆分的工作区 | > 上述为方向参考,具体做法与取舍见[界面布局方案对比](/NewLife/XCoder/Blob/master/Doc/界面布局方案对比.md)。 --- ## 2. 核心目标 | 编号 | 目标 | 所属层级 | 一句话描述 | |------|------|----------|------------| | APP | 桌面外壳 | 基础层 | 工作台、命令面板、标签/浮动窗口、主题、设置、更新 | | DEV | 开发与数据 | 核心层 | 数据建模、数据同步、SQL、API、Redis、文本与加解密 | | NET | 网络与通信 | 核心层 | 网络/消息/MQTT/SSH/Modbus/串口调试 | | IND | 工业与设备 | 核心层 | CAN、Modbus 主从、I/O、USB、声卡、IP 设置 | | EFF | 效率工具 | 外围层 | 图标水印、目录统计、坐标/GPS/地图、备份、语音、频谱 | | OPS | 平台适配与发布 | 支撑层 | 平台抽象、目标平台打包分发、测试与验收 | --- ## 3. 功能需求 工具统一具备:工作台卡片入口、搜索关键字、标签或浮动窗口打开、状态栏状态显示、配置持久化。下列逐项只描述业务能力。 ### 3.1 APP — 桌面外壳 - **APP-1 工作台首页**:品牌区、分类导航、搜索框、快捷入口、全部工具卡片网格;按窗口宽度自适应列数。 - **APP-2 工具注册表**:工具在入口代码显式注册(键、标题、分类、图标、描述、搜索关键字、平台可用性、视图工厂),新增工具只改一处。 - **APP-3 标签工作区**:同一工具单实例复用;标签可切换、关闭、滚动,左侧列表联动;标签右键菜单提供关闭自身/其他/左侧/右侧/全部,以及标签与浮动窗口互迁。 - **APP-4 浮动窗口**:工具可在「标签」与「浮动窗口」之间来回迁移并保持状态;浮动窗口记忆位置尺寸、可置顶。 - **APP-5 命令面板**:全局快捷键唤起,输入即搜索工具与动作,回车打开;支持最近使用排序。 - **APP-6 主题系统**:浅色/深色两套主题,默认跟随系统,可在设置中强制;强调色跟随系统(只覆盖 `Accent` 系列,品牌渐变与控制台不变),高对比度模式下自动切换纯黑白高对比配色;日志与控制台区域在任何主题下保持高对比深底;Windows 下系统标题栏与窗口边框跟随应用主题(深色主题不再残留白色标题栏),运行中切换与新建窗口都即时生效。 - **APP-7 统一状态栏**:显示当前工具名称与其真实状态(连接/未连接/执行中),不伪造结果。 - **APP-8 设置中心**:主题、语言、快捷入口、浮动窗口行为、日志与配置目录、更新通道。 - **APP-9 单实例与托盘**:重复启动激活已有实例;托盘常驻,可唤出工作台/命令面板;左键单击(含双击)托盘图标唤回主窗口,右键打开托盘菜单。 - **APP-10 多语言**:沿用现有词表机制,中文(简/繁)、英、日、韩、德、法、西、葡、俄、阿共 11 种;界面按最长文案留位。 - **APP-11 配置与日志**:用户配置、连接串、日志分别存放于各平台规范目录;敏感信息(密码/密钥)加密存储,优先使用系统凭据存储(Windows DPAPI / macOS Keychain / Linux Secret Service),未接入前以本机绑定加密兜底且界面不回显明文。 - **APP-12 在线更新**:检查更新、下载与提示,失败不阻断使用。 - **APP-13 外壳空间管理**:左侧导航可在 216px 与 64px 图标轨之间收起(Ctrl+B,状态持久化);工具工作区自动收起顶栏(标题与标签重复、搜索只作用于工作台),顶栏动作移入标签条;专注模式(Ctrl+Shift+F,Esc 退出)隐藏侧栏、顶栏与状态栏;F11 全屏。工作台始终保留完整导航与搜索。 ### 3.2 DEV — 开发与数据 - **DEV-1 数据建模**:连接数据库或导入 XML 模型,浏览表/字段/索引,生成实体代码与建表 SQL,支持模型管理与会话保存。 - **DEV-2 数据同步**:源/目标库连接、表勾选、字段映射、差异预览与执行(含备份与回滚提示)。 - **DEV-3 SQL 工作台**:连接管理、架构树浏览、SQL 编辑与执行、结果表格、导出;写操作二次确认。 - **DEV-4 API 调试**:NewLife.Remoting RPC 连接、Action 列表、参数编辑、调用与交互日志。 - **DEV-5 API 发现**:局域网广播,或按单个 IP / CIDR 网段 / IP 范围探测 ApiServer;表格按原版字段完整展示 Id、名称、本机地址、机器名、版本、系统、来源地址、服务端时间、编码与服务器地址;支持复制地址、导出 CSV 与转入 API 调试。 - **DEV-6 Redis 管理**:连接、库与键浏览、值查看/编辑、命令执行与危险操作保护。 - **DEV-7 正则表达式**:匹配、替换、捕获组与批量文件替换(替换前预览与备份)。 - **DEV-8 加密解密**:摘要、HMAC、Base64/Hex、URL、HTML/Unicode 与 RSA 等 34 个安全命令;左侧命令栏点击即执行,右侧按「原文 → 密码/参数 → 结果」纵向流水线组织,原文与密码均支持字符串/HEX/Base64,结果可多选三种表示并单条回填原文,支持格式感知的上下互换与链路衔接,异常输入有明确提示。 - **DEV-9 对称加密**:AES/DES 等对称算法加解密与参数配置。 - **DEV-10 MD5 解密**:MD5 查询与彩虹表/在线接口调用(离线优先)。 - **DEV-11 文件编码**:文件字符集探测、预览与转换,转换前备份。 ### 3.3 NET — 网络与通信 - **NET-1 网络调试**:TCP/UDP 客户端与服务端调试,收发日志与十六进制视图。 - **NET-2 消息调试**:消息协议组装、收发与解析。 - **NET-3 MQTT 客户端**:Broker 连接、发布/订阅、主题树与消息日志。 - **NET-4 SSH 工具**:SSH 终端与命令执行,密钥/密码认证,会话管理。 - **NET-5 Modbus TCP**:主站读写、寄存器表与轮询。 - **NET-6 Modbus RTU**:串口主站读写、CRC 校验与报文日志。 - **NET-7 串口调试**:串口枚举、参数配置、收发、十六进制/文本切换。 - **NET-8 网络语音播报**:向指定终端发送语音播报消息。 ### 3.4 IND — 工业与设备 - **IND-1 CAN 调试**:CAN 报文收发、周期发送、过滤与日志(Windows 厂商 DLL / Linux SocketCAN / macOS 厂商驱动)。 - **IND-2 CAN DBC 查看器**:DBC 文件解析、信号与报文解码(SAE J1939 支持)。 - **IND-3 Modbus Master**:批量寄存器读写与设备模板。 - **IND-4 Modbus Slave**:从站模拟,供上位机联调。 - **IND-5 I/O 控制**:基于 Modbus 的 I/O 模块读写与状态监控。 - **IND-6 USB 设备**:枚举 USB 设备与 HUB 拓扑,显示 VID/PID/速率(Windows WMI / Linux sysfs / macOS system_profiler)。 - **IND-7 声卡测试**:音频设备枚举、选择、录音与回放测试。 - **IND-8 IP 设置**:网卡状态查看与地址配置(Windows netsh / Linux nmcli / macOS networksetup),危险操作确认与回滚。 ### 3.5 EFF — 效率工具 - **EFF-1 图标水印**:批量图标处理、水印、尺寸与格式转换。 - **EFF-2 磁盘星图**:以磁盘墙 + 可下钻树图呈现磁盘与文件夹空间占用,方块面积按容量/大小铺开,滑条表示已用/可用;进入目录先列出子目录与文件撑起框架,再套用上次扫描缓存的大小,最后后台并行统计并回写缓存;用实心/斜纹/时钟区分已完成、统计中与缓存复核;统计文件数量、类型分布与最大文件并支持导出;右键可删除文件或目录,默认移入回收站,永久删除须二次确认,确认后立即关闭确认框并用非阻塞忙碌条与完成提示反馈;删除进行中仍可继续确认其他条目,任务进入队列依次后台执行(前序删除已带走的目标自动跳过);右侧“最大的文件”支持双击以系统默认程序打开、右键打开所在目录或复制路径;右侧展示回收站与常见临时/缓存目录占用,有具体路径的项可一键打开目录,支持二次确认后清空回收站或清理临时目录,完成后刷新可清理项、磁盘可用空间及已加载的相关节点;Windows/.NET 环境额外展示 NuGet 包缓存与下载缓存(清理或提示迁移到空间更大的磁盘),Linux 额外展示 journal 系统日志与 `/var/log` 轮转归档(只删旧归档,正在写入的日志不动);支持直接选择磁盘根目录开始统计。 - **EFF-3 坐标转换**:WGS84/GCJ02/BD09 互转与批量转换。 - **EFF-4 GPS 辅助**:定位数据解析、HEX 转浮点、轨迹查看。 - **EFF-5 地图接口**:地理编码、逆编码、路径规划接口调试,支持多服务商。 - **EFF-6 手机备份**:通过 adb 备份/整理设备文件,操作前明确风险与备份位置。 - **EFF-7 语音助手**:文本转语音播报、导出音频(Windows SAPI / macOS say / Linux espeak)。 - **EFF-8 梅尔频谱**:音频采集、梅尔频谱计算与可视化。 ### 3.6 OPS — 平台适配与发布 - **OPS-1 平台抽象层**:设备与系统能力(串口、CAN、音频、USB、网络配置、凭据、进程)统一接口,各平台实现,按平台能力声明可用性。 - **OPS-2 Windows 实现**:厂商 DLL、WMI、netsh、SAPI、系统凭据。 - **OPS-3 Linux 实现**:SocketCAN、ALSA/PulseAudio、sysfs、nmcli、Secret Service、dialout 权限检测;覆盖 x64/arm64,LoongArch 新世界复用。 - **OPS-4 macOS 实现**:厂商驱动、CoreAudio/system_profiler、networksetup、Keychain。 - **OPS-5 Windows 打包**:自包含单文件 + 安装包,支持 x64/arm64。 - **OPS-6 Linux 打包**:AppImage + deb/rpm,覆盖 Ubuntu/Debian/Fedora 与 UOS/麒麟(x64/arm64),以及 LoongArch 新世界(loongarch64,自带 Loongnix .NET 10 运行时)。 - **OPS-7 macOS 打包**:`.app` + DMG,Developer ID 签名与公证;CI 出包 + Mac 真机验收,能力缺失时按矩阵置灰。 - **OPS-8 测试与验收**:单元测试、无头 UI 冒烟、LoongArch QEMU 冒烟 + 龙芯真机、macOS CI + Mac 真机、真机联调清单与发布检查表。 --- ## 4. 界面形态需求 ### 4.1 主界面布局 - 三区结构:左侧导航栏(品牌、工作台、分类、已打开工具)+ 顶部区域(标题、搜索、主题切换、命令面板入口)+ 内容区(工作台或工具工作区),底部统一状态栏。侧栏可在 216px 与 64px 图标轨之间收起;顶栏只在工作台显示,工具工作区自动收起;工具工作区可进入专注模式(隐藏侧栏、顶栏与状态栏),并支持 F11 全屏。 - 工作台:Hero 区(产品定位与版本信息)+ 使用统计卡片 + 快捷入口(可配置、可排序)+ 全部工具卡片网格(按分类分组、可筛选)。 - 工具工作区:顶部标签条(含关闭、滚动、回工具首页),工具内容占满剩余空间,工具内部可再分栏。 - 浮动窗口:与标签同源同状态;提供「移回标签」「置顶」操作;关闭后状态按设置保留或释放。 ### 4.2 交互要求 - 全局快捷键:命令面板(Ctrl+K)、侧栏折叠(Ctrl+B)、专注模式(Ctrl+Shift+F,Esc 退出)、全屏(F11)、关闭当前标签(Ctrl+W),以及工具内主操作(按工具定义)。快捷键可查可改。 - 搜索:工具名、描述、分类、关键字模糊匹配;键盘上下选择、回车打开。 - 状态可见:工具执行中/已连接/错误在状态栏与标签上均有提示,不使用无意义的「就绪」占位。 - 危险操作(写库、覆盖文件、修改网络配置、设备写入)必须二次确认,并给出可回滚路径。 ### 4.3 视觉规范 - 4pt 栅格,字号、间距、圆角、图标尺寸全部令牌化;图标一律矢量,禁止位图拉伸。 - 浅色与深色共用同一套语义令牌(背景/表面/边框/文字/主色/危险色/控制台背景)。 - 在 100%~200% 缩放、远程桌面(RDP)与多显示器混合 DPI 下,文字清晰、控件不重叠、布局不溢出。 --- ## 5. 🧊 暂缓清单 | 功能 | 暂缓理由 | 解冻前提 | |------|----------|----------| | 摄像头采集与预览 | 三平台(DirectShow/V4L2/AVFoundation)适配成本高,用户面窄 | 有明确用户需求且平台抽象层稳定后 | | CANopen / UDS 深度调试 | 现有能力以 CAN 报文为主,协议栈工作量大 | 工业用户提出具体设备与协议要求 | | 手机备份 iOS 完整备份 | 依赖第三方工具链与实际设备联调 | 选定可靠备份通道后 | | 第三方插件热加载 | 本期以官方工具为主,插件会带来兼容与安全负担 | 工具集稳定且有第三方诉求 | | 配置云同步 | 需要账号与云端存储,涉及隐私与合规 | 有统一账号体系时 | | 全局热键的 Linux/macOS 实现 | Windows 已用线程级 RegisterHotKey 实现(无需子类化窗口);Linux 需 X11/Wayland 全局快捷键协议、macOS 需 Carbon/IOKit,均需真机联调 | 有 Linux/macOS 用户明确诉求时 | --- ## 6. 不做什么 - **不做 Windows 7 / 8.1 支持**:目标运行时与 UI 框架均不覆盖,维护成本过高。最低 Windows 10 1607 / Server 2019。 - **不做 LoongArch 旧世界 ABI 1.0**:v1 仅支持新世界 ABI 2.0;旧世界需第三方 ABI1.0 原生库,后续按客户需求单独评估。 - **不做 Web 版 / 移动端**:桌面端是唯一交付形态,不为浏览器另做一套。 - **不做插件市场与第三方 SDK**:本期不承诺外部生态。 - **不保留 WinForms MDI 形态**:新版本不再提供 MDI 子窗体与顶部菜单式工具入口。 - **不做静默降级**:平台不支持的能力必须显式提示,不允许「按钮可点但无反应」。 - **不承诺未验收的硬件能力可用**:未验收的硬件能力按平台能力矩阵置灰,不静默降级。 - **不做 macOS 无签名分发**:macOS 正式包必须 Developer ID 签名并公证;无证书的预览包不作为正式发布。 --- (完)