102 lines
3.0 KiB
Markdown
102 lines
3.0 KiB
Markdown
# printServer
|
||
|
||
## 项目概况
|
||
printServer 是一个面向 Windows 的本地打印服务应用。
|
||
|
||
它当前由以下几部分组成:
|
||
- Node.js HTTP 服务,监听本地 3000 端口
|
||
- 本地 WebSocket 服务,监听 3001 端口
|
||
- 前端页面 views/index.html,用于绑定工作台、查看打印机、查看组件状态、执行注册服务等操作
|
||
- Windows PowerShell 脚本,用于打印机状态轮询
|
||
- 打印组件与远程 WebSocket 通信逻辑,用于接收远端指令并驱动本地打印
|
||
- Electron 桌面壳,用于后续安装包、托盘图标和桌面启动能力
|
||
|
||
## 当前能力
|
||
- 查询 Windows 打印机列表
|
||
- 监听打印机状态变化
|
||
- 通过页面查看本地打印组件状态
|
||
- 通过 WebSocket 调用本地服务方法
|
||
- 页面点击注册/注销服务状态
|
||
- 已开始接入 Electron 桌面入口与托盘常驻能力
|
||
|
||
## 技术结构
|
||
- 入口文件:index.js
|
||
- 核心框架:core/
|
||
- 服务层:services/
|
||
- 控制器:controllers/
|
||
- 页面:views/
|
||
- Windows 脚本:printer.ps1
|
||
- 配置文件:config.json
|
||
|
||
## 目录说明
|
||
- controllers/
|
||
- HTTP 控制器
|
||
- core/
|
||
- 主应用、WebSocket 服务、WebSocket 客户端、打印组件核心逻辑
|
||
- services/
|
||
- 业务服务,如打印机、设置、绑定
|
||
- views/
|
||
- 页面模板,目前主要是 index.html
|
||
- daemon/
|
||
- 守护或服务相关配置文件
|
||
- 临时/
|
||
- 临时分析文档、测试脚本、临时日志的统一目录,可在任务结束后整体清理
|
||
|
||
## 本地运行
|
||
环境要求:
|
||
- Windows
|
||
- Node.js
|
||
- PowerShell
|
||
- 已安装并可调用的打印机驱动
|
||
|
||
启动方式:
|
||
```bash
|
||
node index.js
|
||
```
|
||
|
||
开发模式:
|
||
```bash
|
||
npm run dev
|
||
```
|
||
|
||
打开页面:
|
||
- http://127.0.0.1:3000/
|
||
|
||
## 页面与服务调用关系
|
||
页面通过浏览器连接本地 WebSocket 服务:
|
||
- 页面地址由本地 HTTP 服务提供
|
||
- 页面中的按钮通过 wsSendWithCallback 发送 method
|
||
- WebSocket 服务按 method 路由到 services/ 下对应实例方法
|
||
|
||
示例:
|
||
- setting.register -> services/setting.js
|
||
- setting.unregister -> services/setting.js
|
||
- printer.getWindowsPrinters -> services/printer.js
|
||
|
||
## 当前打包方向
|
||
当前已确定的桌面化与 EXE 打包方向为:
|
||
- Electron 作为桌面壳
|
||
- electron-builder 作为打包工具
|
||
- NSIS 作为 Windows 安装包输出方式
|
||
|
||
选择这个方向的原因:
|
||
- 需要桌面图标启动
|
||
- 需要系统托盘图标常驻
|
||
- 需要安装包体验
|
||
- 需要打开页面并继续复用现有 index.html 和本地服务能力
|
||
- 比单纯将 Node 打成 exe 更容易控制窗口、托盘、安装和运行态
|
||
|
||
## 后续打包目标
|
||
- 支持可重复打包
|
||
- 输出完整安装包 EXE
|
||
- 安装后创建桌面快捷方式
|
||
- 启动后保留系统托盘图标
|
||
- 能打开页面并完成注册到服务
|
||
- 打包时纳入配置文件、页面资源、PowerShell 脚本与相关依赖
|
||
|
||
## 注意事项
|
||
- 当前项目包含明显的 Windows 依赖
|
||
- dm 相关能力已从本项目移除,不再属于当前交付范围
|
||
- 3000 和 3001 端口需避免被占用
|
||
- 临时测试与分析文件统一放在 临时/ 目录
|