, // 按照顺序摆放的html文本片段
87 | // updateTime: number, // 最后更新此任务信息的时间戳，用于超时时移除此对象
88 | // }
89 | // }
90 | };
91 | global.RENDER_RUNNER = new TaskRunner({ concurrency: 1 });
92 | global.RENDER_RUNNER_DONE = {};
93 |
94 | // socket.io 服务端，用于创建本地服务
95 | const ioServer = (global.SOCKET_SERVER = new require("socket.io")(server, {
96 | pingInterval: 10000,
97 | pingTimeout: 5000,
98 | maxHttpBufferSize: 10000000000,
99 | allowEIO3: true, // 兼容 Socket.IO 2.x
100 | // 跨域问题(Socket.IO 3.x 使用这种方式)
101 | cors: {
102 | // origin: "*",
103 | // 兼容 Socket.IO 2.x
104 | origin: (requestOrigin, callback) => {
105 | // 允许所有域名连接
106 | callback(null, requestOrigin);
107 | },
108 | methods: "GET, POST, PUT, DELETE, OPTIONS",
109 | allowedHeaders: "*",
110 | // 详情参数见 https://www.npmjs.com/package/cors
111 | credentials: false,
112 | },
113 | }));
114 |
115 | // socket.io 客户端，用于连接中转服务
116 | const ioClient = require("socket.io-client").io;
117 |
118 | /**
119 | * @description: 初始化
120 | */
121 | async function initialize() {
122 | // 限制一个窗口
123 | const gotTheLock = app.requestSingleInstanceLock();
124 | if (!gotTheLock) {
125 | // 销毁所有窗口、托盘、退出应用
126 | helper.appQuit();
127 | }
128 |
129 | // 当运行第二个实例时,聚焦到 MAIN_WINDOW 这个窗口
130 | app.on("second-instance", () => {
131 | if (MAIN_WINDOW) {
132 | if (MAIN_WINDOW.isMinimized()) {
133 | // 将窗口从最小化状态恢复到以前的状态
134 | MAIN_WINDOW.restore();
135 | }
136 | MAIN_WINDOW.focus();
137 | }
138 | });
139 |
140 | // 允许渲染进程创建通知
141 | ipcMain.on("notification", (event, data) => {
142 | const notification = new Notification(data);
143 | // 显示通知
144 | notification.show();
145 | });
146 |
147 | // 打开设置窗口
148 | ipcMain.on("openSetting", openSetWindow);
149 |
150 | // 获取设备唯一id
151 | ipcMain.on("getMachineId", (event) => {
152 | const machineId = getMachineId();
153 | event.sender.send("machineId", machineId);
154 | });
155 |
156 | // 获取设备ip、mac等信息
157 | ipcMain.on("getAddress", (event) => {
158 | address.all().then((obj) => {
159 | event.sender.send("address", {
160 | ...obj,
161 | port: store.get("port"),
162 | });
163 | });
164 | });
165 |
166 | // 当electron完成初始化
167 | app.whenReady().then(() => {
168 | // 创建浏览器窗口
169 | createWindow();
170 | app.on("activate", function() {
171 | if (BrowserWindow.getAllWindows().length === 0) {
172 | createWindow();
173 | }
174 | });
175 | console.log("==> Electron-hiprint 启动 <==");
176 | });
177 | }
178 |
179 | /**
180 | * @description: 创建渲染进程 主窗口
181 | * @return {BrowserWindow} MAIN_WINDOW 主窗口
182 | */
183 | async function createWindow() {
184 | const windowOptions = {
185 | width: 500, // 窗口宽度
186 | height: 300, // 窗口高度
187 | title: store.get("mainTitle") || "Electron-hiprint",
188 | useContentSize: true, // 窗口大小不包含边框
189 | center: true, // 居中
190 | resizable: false, // 禁止窗口缩放
191 | show: false, // 初始隐藏
192 | webPreferences: {
193 | // 设置此项为false后，才可在渲染进程中使用 electron api
194 | contextIsolation: false,
195 | nodeIntegration: true,
196 | },
197 | };
198 |
199 | // 窗口左上角图标
200 | if (!app.isPackaged) {
201 | windowOptions.icon = path.join(__dirname, "build/icons/256x256.png");
202 | } else {
203 | app.setLoginItemSettings({
204 | openAtLogin: store.get("openAtLogin"),
205 | openAsHidden: store.get("openAsHidden"),
206 | });
207 | }
208 |
209 | // 创建主窗口
210 | MAIN_WINDOW = new BrowserWindow(windowOptions);
211 |
212 | // 添加加载页面 解决白屏的问题
213 | loadingView(windowOptions);
214 |
215 | // 初始化系统设置
216 | systemSetup();
217 |
218 | // 加载主页面
219 | const indexHtml = path.join("file://", app.getAppPath(), "assets/index.html");
220 | MAIN_WINDOW.webContents.loadURL(indexHtml);
221 |
222 | // 退出
223 | MAIN_WINDOW.on("closed", () => {
224 | MAIN_WINDOW = null;
225 | server.close();
226 | });
227 |
228 | // 点击关闭，最小化到托盘
229 | MAIN_WINDOW.on("close", (event) => {
230 | if (store.get("closeType") === "tray") {
231 | // 最小化到托盘
232 | MAIN_WINDOW.hide();
233 |
234 | // 隐藏任务栏
235 | MAIN_WINDOW.setSkipTaskbar(true);
236 |
237 | // 阻止窗口关闭
238 | event.preventDefault();
239 | } else {
240 | // 销毁所有窗口、托盘、退出应用
241 | helper.appQuit();
242 | }
243 | });
244 |
245 | // 主窗口 Dom 加载完毕
246 | MAIN_WINDOW.webContents.on("dom-ready", async () => {
247 | try {
248 | if (!store.get("openAsHidden")) {
249 | MAIN_WINDOW.show();
250 | }
251 | // 未打包时打开开发者工具
252 | if (!app.isPackaged) {
253 | MAIN_WINDOW.webContents.openDevTools();
254 | }
255 | // 本地服务开启端口监听
256 | server.listen(store.get("port") || 17521);
257 | // 初始化本地 服务端事件
258 | initServeEvent(ioServer);
259 | // 有配置中转服务时连接中转服务
260 | if (
261 | store.get("connectTransit") &&
262 | store.get("transitUrl") &&
263 | store.get("transitToken")
264 | ) {
265 | global.SOCKET_CLIENT = ioClient(store.get("transitUrl"), {
266 | transports: ["websocket"],
267 | query: {
268 | client: "electron-hiprint",
269 | },
270 | auth: {
271 | token: store.get("transitToken"),
272 | },
273 | });
274 |
275 | // 初始化中转 客户端事件
276 | initClientEvent();
277 | }
278 | } catch (error) {
279 | console.error(error);
280 | }
281 | });
282 |
283 | // 初始化托盘
284 | initTray();
285 | // 打印窗口初始化
286 | await printSetup();
287 | // 渲染窗口初始化
288 | await renderSetup();
289 |
290 | return MAIN_WINDOW;
291 | }
292 |
293 | /**
294 | * @description: 加载等待页面，解决主窗口白屏问题
295 | * @param {Object} windowOptions 主窗口配置
296 | * @return {Void}
297 | */
298 | function loadingView(windowOptions) {
299 | const loadingBrowserView = new BrowserView();
300 | MAIN_WINDOW.setBrowserView(loadingBrowserView);
301 | loadingBrowserView.setBounds({
302 | x: 0,
303 | y: 0,
304 | width: windowOptions.width,
305 | height: windowOptions.height,
306 | });
307 |
308 | const loadingHtml = path.join(
309 | "file://",
310 | app.getAppPath(),
311 | "assets/loading.html",
312 | );
313 | loadingBrowserView.webContents.loadURL(loadingHtml);
314 |
315 | // 主窗口 dom 加载完毕，移除 loadingBrowserView
316 | MAIN_WINDOW.webContents.on("dom-ready", async (event) => {
317 | loadingBrowserView.webContents.destroy();
318 | MAIN_WINDOW.removeBrowserView(loadingBrowserView);
319 | });
320 | }
321 |
322 | /**
323 | * @description: 初始化系统设置
324 | * @return {Void}
325 | */
326 | function systemSetup() {
327 | // 隐藏菜单栏
328 | Menu.setApplicationMenu(null);
329 | }
330 |
331 | /**
332 | * @description: 显示主窗口
333 | * @return {Void}
334 | */
335 | function showMainWindow() {
336 | if (MAIN_WINDOW.isMinimized()) {
337 | // 将窗口从最小化状态恢复到以前的状态
338 | MAIN_WINDOW.restore();
339 | }
340 | if (!MAIN_WINDOW.isVisible()) {
341 | // 主窗口关闭不会被销毁，只是隐藏，重新显示即可
342 | MAIN_WINDOW.show();
343 | }
344 | if (!MAIN_WINDOW.isFocused()) {
345 | // 主窗口未聚焦，使其聚焦
346 | MAIN_WINDOW.focus();
347 | }
348 | MAIN_WINDOW.setSkipTaskbar(false);
349 | }
350 |
351 | /**
352 | * @description: 初始化托盘
353 | * @return {Tray} APP_TRAY 托盘实例
354 | */
355 | function initTray() {
356 | let trayPath = path.join(app.getAppPath(), "assets/icons/tray.png");
357 |
358 | APP_TRAY = new Tray(trayPath);
359 |
360 | // 托盘提示标题
361 | APP_TRAY.setToolTip("hiprint");
362 |
363 | // 托盘菜单
364 | const trayMenuTemplate = [
365 | {
366 | // 神知道为什么 linux 上无法识别 tray click、double-click，只能添加一个菜单
367 | label: "显示主窗口",
368 | click: () => {
369 | showMainWindow();
370 | },
371 | },
372 | {
373 | label: "设置",
374 | click: () => {
375 | console.log("==>TRAY 打开设置窗口<==");
376 | openSetWindow();
377 | },
378 | },
379 | {
380 | label: "软件日志",
381 | click: () => {
382 | console.log("==>TRAY 查看软件日志<==");
383 | shell.openPath(logPath);
384 | },
385 | },
386 | {
387 | label: "打印记录",
388 | click: () => {
389 | console.log("==>TRAY 打开打印记录窗口<==");
390 | if (!PRINT_LOG_WINDOW) {
391 | printLogSetup();
392 | } else {
393 | PRINT_LOG_WINDOW.show();
394 | }
395 | },
396 | },
397 | {
398 | label: "关于",
399 | click: () => {
400 | console.log("==>TRAY 打开关于弹框<==");
401 | showAboutDialog();
402 | },
403 | },
404 | {
405 | label: "退出",
406 | click: () => {
407 | console.log("==>TRAY 退出应用<==");
408 | helper.appQuit();
409 | },
410 | },
411 | ];
412 |
413 | APP_TRAY.setContextMenu(Menu.buildFromTemplate(trayMenuTemplate));
414 |
415 | // 监听点击事件
416 | APP_TRAY.on("click", function() {
417 | console.log("==>TRAY 点击托盘图标<==");
418 | showMainWindow();
419 | });
420 | return APP_TRAY;
421 | }
422 |
423 | /**
424 | * @description: 打开设置窗口
425 | * @return {BrowserWindow} SET_WINDOW 设置窗口
426 | */
427 | async function openSetWindow() {
428 | if (!SET_WINDOW) {
429 | await setSetup();
430 | } else {
431 | SET_WINDOW.show();
432 | }
433 | return SET_WINDOW;
434 | }
435 |
436 | // 初始化主窗口
437 | initialize();
438 |
--------------------------------------------------------------------------------
/src/set.js:
--------------------------------------------------------------------------------
1 | /*
2 | * @Date: 2023-09-05 17:34:28
3 | * @LastEditors: admin@54xavier.cn
4 | * @LastEditTime: 2024-12-22 16:50:24
5 | * @FilePath: \xavier9896-electron-hiprint\src\set.js
6 | */
7 | "use strict";
8 |
9 | const {
10 | app,
11 | BrowserWindow,
12 | BrowserView,
13 | ipcMain,
14 | dialog,
15 | shell,
16 | } = require("electron");
17 | const path = require("path");
18 | const https = require("node:https");
19 | const fs = require("node:fs");
20 | const { store } = require("../tools/utils");
21 |
22 | /**
23 | * @description: 创建设置窗口
24 | * @return {BrowserWindow} SET_WINDOW 设置窗口
25 | */
26 | async function createSetWindow() {
27 | const windowOptions = {
28 | width: 440, // 窗口宽度
29 | height: 591, // 窗口高度
30 | title: "设置",
31 | useContentSize: true, // 窗口大小不包含边框
32 | center: true, // 居中
33 | alwaysOnTop: true, // 永远置顶
34 | resizable: false, // 不可缩放
35 | webPreferences: {
36 | contextIsolation: false, // 设置此项为false后，才可在渲染进程中使用 electron api
37 | nodeIntegration: true,
38 | },
39 | };
40 |
41 | // 创建设置窗口
42 | SET_WINDOW = new BrowserWindow(windowOptions);
43 |
44 | // 添加加载页面 解决白屏的问题
45 | loadingView(windowOptions);
46 |
47 | // 加载设置渲染进程页面
48 | const setHtmlUrl = path.join("file://", app.getAppPath(), "assets/set.html");
49 | SET_WINDOW.webContents.loadURL(setHtmlUrl);
50 |
51 | // 未打包时打开开发者工具
52 | if (!app.isPackaged) {
53 | SET_WINDOW.webContents.openDevTools();
54 | }
55 |
56 | // 绑定窗口事件
57 | initSetEvent();
58 |
59 | // 监听退出，移除所有事件
60 | SET_WINDOW.on("closed", removeEvent);
61 |
62 | SET_WINDOW.webContents.on("did-finish-load", () => {
63 | const downloadedVersions = getDownloadedVersions();
64 | SET_WINDOW.webContents.send("downloadedVersions", downloadedVersions);
65 | });
66 |
67 | return SET_WINDOW;
68 | }
69 |
70 | /**
71 | * @description: 加载等待页面，解决主窗口白屏问题
72 | * @param {Object} windowOptions 主窗口配置
73 | * @return {void}
74 | */
75 | function loadingView(windowOptions) {
76 | const loadingBrowserView = new BrowserView();
77 | SET_WINDOW.setBrowserView(loadingBrowserView);
78 | loadingBrowserView.setBounds({
79 | x: 0,
80 | y: 0,
81 | width: windowOptions.width,
82 | height: windowOptions.height,
83 | });
84 |
85 | const loadingHtml = path.join(
86 | "file://",
87 | app.getAppPath(),
88 | "assets/loading.html",
89 | );
90 | loadingBrowserView.webContents.loadURL(loadingHtml);
91 |
92 | // 设置窗口 dom 加载完毕，移除 loadingBrowserView
93 | SET_WINDOW.webContents.on("dom-ready", async (event) => {
94 | loadingBrowserView.webContents.destroy();
95 | SET_WINDOW.removeBrowserView(loadingBrowserView);
96 | });
97 | }
98 |
99 | /**
100 | * @description: 渲染进程触发写入配置
101 | * @param {IpcMainEvent} event
102 | * @param {Object} data 配置数据
103 | * @return {void}
104 | */
105 | function setConfig(event, data) {
106 | console.log("==> 设置窗口：保存配置 <==");
107 | // 保存配置前，弹出 dialog 确认
108 | dialog
109 | .showMessageBox(SET_WINDOW, {
110 | type: "question",
111 | title: "提示",
112 | message:
113 | "保存设置需要重启软件，如有正在执行中的打印任务可能会被中断，是否确定要保存并重启？",
114 | buttons: ["确定", "取消"],
115 | })
116 | .then((res) => {
117 | if (res.response === 0) {
118 | try {
119 | let pdfPath = path.join(data.pdfPath, "url_pdf");
120 | fs.mkdirSync(pdfPath, { recursive: true });
121 | pdfPath = path.join(data.pdfPath, "blob_pdf");
122 | fs.mkdirSync(pdfPath, { recursive: true });
123 | pdfPath = path.join(data.pdfPath, "hiprint");
124 | fs.mkdirSync(pdfPath, { recursive: true });
125 | } catch {
126 | dialog.showMessageBox(SET_WINDOW, {
127 | type: "error",
128 | title: "提示",
129 | message: "pdf 保存路径无法写入数据，请重新设置！",
130 | buttons: ["确定"],
131 | noLink: true,
132 | });
133 | return;
134 | }
135 | try {
136 | fs.accessSync(data.logPath, fs.constants.W_OK);
137 | } catch (err) {
138 | dialog.showMessageBox(SET_WINDOW, {
139 | type: "error",
140 | title: "提示",
141 | message: "日志保存路径无法写入数据，请重新设置！",
142 | buttons: ["确定"],
143 | noLink: true,
144 | });
145 | return;
146 | }
147 | store.set(data);
148 | setTimeout(() => {
149 | app.relaunch();
150 | app.exit();
151 | }, 500);
152 | }
153 | });
154 | }
155 |
156 | /**
157 | * @description: 渲染进程触发下载插件
158 | * @param {IpcMainEvent} event
159 | * @param {Object} data 插件版本号
160 | * @return {void}
161 | */
162 | function downloadPlugin(event, data) {
163 | const fileList = ["vue-plugin-hiprint.js", "print-lock.css"];
164 | Promise.all(
165 | fileList.map((url) => {
166 | return new Promise((resolve, reject) => {
167 | https.get(
168 | `https://registry.npmmirror.com/vue-plugin-hiprint/${data}/files/dist/${url}`,
169 | (res) => {
170 | let filePath = "";
171 | if (app.isPackaged) {
172 | filePath = path.join(
173 | app.getAppPath(),
174 | "../",
175 | `plugin/${data}_${url}`,
176 | );
177 | } else {
178 | filePath = path.join(app.getAppPath(), `plugin/${data}_${url}`);
179 | }
180 | const fileStream = fs.createWriteStream(filePath);
181 | res.pipe(fileStream);
182 | res.on("end", () => {
183 | resolve();
184 | });
185 | res.on("error", () => {
186 | reject();
187 | });
188 | },
189 | );
190 | });
191 | }),
192 | )
193 | .then(() => {
194 | dialog.showMessageBox(SET_WINDOW, {
195 | type: "info",
196 | title: "提示",
197 | message: "插件下载成功！",
198 | buttons: ["确定"],
199 | noLink: true,
200 | });
201 | const downloadedVersions = getDownloadedVersions();
202 | SET_WINDOW.webContents.send("downloadedVersions", downloadedVersions);
203 | })
204 | .catch(() => {
205 | dialog.showMessageBox(SET_WINDOW, {
206 | type: "error",
207 | title: "提示",
208 | message: "插件下载失败！",
209 | buttons: ["确定"],
210 | noLink: true,
211 | });
212 | });
213 | }
214 |
215 | /**
216 | * @description: 渲染进程触发设置工作区大小
217 | * @param {IpcMainEvent} event
218 | * @param {Object} data {width, height[, animate]}
219 | * @return {void}
220 | */
221 | function setContentSize(event, data) {
222 | SET_WINDOW.setContentSize(data.width, data.height, data.animate ?? true);
223 | }
224 |
225 | /**
226 | * @description: 渲染进程触发弹出消息框
227 | * @param {IpcMainEvent} event
228 | * @param {Object} data https://www.electronjs.org/zh/docs/latest/api/dialog#dialogshowmessageboxbrowserwindow-options
229 | * @return {void}
230 | */
231 | function showMessageBox(event, data) {
232 | dialog.showMessageBox(SET_WINDOW, { noLink: true, ...data });
233 | }
234 |
235 | /**
236 | * @description: 渲染进程触发选择目录
237 | * @param {IpcMainEvent} event
238 | * @param {Object} data https://www.electronjs.org/zh/docs/latest/api/dialog#dialogshowopendialogbrowserwindow-options
239 | * @return {void}
240 | */
241 | function showOpenDialog(event, data) {
242 | dialog.showOpenDialog(SET_WINDOW, data).then((result) => {
243 | if (!result.canceled) {
244 | try {
245 | fs.accessSync(result.filePaths[0], fs.constants.W_OK);
246 | } catch {
247 | dialog.showMessageBox(SET_WINDOW, {
248 | type: "error",
249 | title: "提示",
250 | message: "路径无法写入，请重新选择！",
251 | buttons: ["确定"],
252 | noLink: true,
253 | });
254 | result.canceled = true;
255 | }
256 | }
257 | event.reply("openDialog", result);
258 | });
259 | }
260 |
261 | /**
262 | * @description: 渲染进程触发打开目录
263 | * @param {IpcMainEvent} event
264 | * @param {Object} data 目录路径
265 | * @return {void}
266 | */
267 | function openDirectory(event, data) {
268 | shell.openPath(data);
269 | }
270 |
271 | /**
272 | * @description: 渲染进程触发测试连接中转服务
273 | * @param {IpcMainEvent} event
274 | * @param {Object} data {url, token}
275 | * @return {void}
276 | */
277 | function testTransit(event, data) {
278 | const { io } = require("socket.io-client");
279 | const socket = io(data.url, {
280 | transports: ["websocket"],
281 | reconnection: false, // 关闭自动重连
282 | query: {
283 | test: true, // 标识为测试连通性
284 | },
285 | auth: {
286 | token: data.token, // 身份令牌
287 | },
288 | });
289 |
290 | // 连接错误
291 | socket.on("connect_error", (err) => {
292 | dialog.showMessageBox(SET_WINDOW, {
293 | type: "error",
294 | title: "提示",
295 | message: `${err.message}，请检查设置！`,
296 | buttons: ["确定"],
297 | noLink: true,
298 | });
299 | socket.close();
300 | });
301 |
302 | // 连接成功
303 | socket.on("connect", () => {
304 | dialog.showMessageBox(SET_WINDOW, {
305 | type: "info",
306 | title: "提示",
307 | message: "连接成功！",
308 | buttons: ["确定"],
309 | noLink: true,
310 | });
311 | });
312 |
313 | // 中转服务信息
314 | socket.on("serverInfo", (data) => {
315 | // TODO: 根据服务器返回信息判断服务器是否满足连接条件
316 | // {
317 | // version: '0.0.4', // 中转服务版本号
318 | // currentClients: 1, // 当前 token client 连接数
319 | // allClients: 1, // 所有 token client 连接数
320 | // webClients: 1, // web client 连接数
321 | // allWebClients: 1, // 所有 web client 连接数
322 | // totalmem: 17179869184, // 总内存
323 | // freemem: 94961664, // 可用内存
324 | // }
325 |
326 | console.log(data);
327 | // 关闭测试连接
328 | socket.close();
329 | });
330 | }
331 |
332 | /**
333 | * @description: 关闭设置窗口
334 | * @return {void}
335 | */
336 | function closeSetWindow() {
337 | SET_WINDOW && SET_WINDOW.close();
338 | }
339 |
340 | /**
341 | * @description: 绑定设置窗口事件
342 | * @return {void}
343 | */
344 | function initSetEvent() {
345 | ipcMain.on("setConfig", setConfig);
346 | ipcMain.on("setContentSize", setContentSize);
347 | ipcMain.on("showMessageBox", showMessageBox);
348 | ipcMain.on("showOpenDialog", showOpenDialog);
349 | ipcMain.on("openDirectory", openDirectory);
350 | ipcMain.on("testTransit", testTransit);
351 | ipcMain.on("closeSetWindow", closeSetWindow);
352 | ipcMain.on("downloadPlugin", downloadPlugin);
353 | ipcMain.on("getPrintersList", getPrintersList);
354 | }
355 |
356 | /**
357 | * @description: 移除所有事件
358 | * @return {void}
359 | */
360 | function removeEvent() {
361 | ipcMain.removeListener("setConfig", setConfig);
362 | ipcMain.removeListener("setContentSize", setContentSize);
363 | ipcMain.removeListener("showMessageBox", showMessageBox);
364 | ipcMain.removeListener("showOpenDialog", showOpenDialog);
365 | ipcMain.removeListener("openDirectory", openDirectory);
366 | ipcMain.removeListener("testTransit", testTransit);
367 | ipcMain.removeListener("closeSetWindow", closeSetWindow);
368 | ipcMain.removeListener("downloadPlugin", downloadPlugin);
369 | ipcMain.removeListener("getPrintersList", getPrintersList);
370 | SET_WINDOW = null;
371 | }
372 |
373 | function getDownloadedVersions() {
374 | let pluginDir = path.join(app.getAppPath(), "plugin");
375 | if (app.isPackaged) {
376 | pluginDir = path.join(app.getAppPath(), "../", "plugin");
377 | }
378 | if (!fs.existsSync(pluginDir)) {
379 | return [];
380 | }
381 | return fs
382 | .readdirSync(pluginDir)
383 | .filter((file) => file.endsWith(".js")) // 假设插件文件以 .js 结尾
384 | .map((file) => file.split("_")[0]); // 提取版本号
385 | }
386 |
387 | /**
388 | * @description: 获取打印机列表并发送给渲染进程
389 | * @param {IpcMainEvent} event
390 | * @return {void}
391 | */
392 | async function getPrintersList(event) {
393 | try {
394 | const printers = await SET_WINDOW.webContents.getPrintersAsync();
395 | let list = printers.map((item) => {
396 | return { value: item.name };
397 | });
398 | SET_WINDOW.webContents.send("getPrintersList", list);
399 | } catch (error) {
400 | console.error("获取打印机列表失败:", error);
401 | SET_WINDOW.webContents.send("getPrintersList", []);
402 | }
403 | }
404 |
405 | module.exports = async () => {
406 | // 创建设置窗口
407 | await createSetWindow();
408 | };
409 |
--------------------------------------------------------------------------------
/assets/printLog.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | 打印日志
7 |
8 |
9 |
10 |
11 |
12 |
49 |
50 |
51 |
52 |
59 |
60 |
61 |
62 |
68 |
75 |
76 |
77 | {{ option.content || option.label }}
78 |
79 |
80 |
81 |
88 | {{ item.content }}
89 |
90 |
91 |
92 |
93 |
94 |
99 | 搜索
100 |
101 |
106 | 清空
107 |
108 |
109 |
111 |
112 |
119 |
124 |
125 |
130 | 重打
131 |
132 |
133 |
134 |
135 |
148 |
60 |
61 |
62 |
63 |
64 |
65 |
72 |
73 |
74 |
75 |
82 |
83 |
84 | {{item.label}}
85 |
86 | {{item.label}}
87 |
88 |
95 |
96 |
97 |
102 |
106 |
107 |
108 |
109 | {{ option.content || option.value }}
110 |
111 |
112 |
113 |
120 | {{ item.content }}
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 | 应用
131 |
132 |
133 |
134 |
135 | 关闭
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
693 |
694 |
695 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # electron-hiprint
2 |
3 | [](https://deepwiki.com/CcSimple/electron-hiprint)
4 |
5 |
6 |
7 | 
8 |
9 |
10 |
11 | 该项目是为 [vue-plugin-hiprint](https://github.com/CcSimple/vue-plugin-hiprint) 配套开发的静默打印解决方案。我们发现部分使用此项目的开发者拥有自定义的设计器或渲染方案，或者仅需要静默打印一段 HTML、PDF。如果您也有类似需求，electron-hiprint 将是您的理想选择。
12 |
13 |
14 |
15 | 
16 |
17 |
18 |
19 | ## 快速开始
20 |
21 | #### 下载发行版
22 |
23 | 1. [github releases](https://github.com/CcSimple/electron-hiprint/releases)
24 | 2. [gitee releases](https://gitee.com/CcSimple/electron-hiprint/releases)
25 |
26 | #### 本地调试与打包
27 |
28 | ```shell
29 | git clone https://github.com/CcSimple/electron-hiprint.git
30 | # or
31 | git clone https://gitee.com/CcSimple/electron-hiprint.git
32 |
33 | # init
34 | cd electron-hiprint
35 | npm install
36 |
37 | # 调试预览
38 | npm run start
39 |
40 | # 打包 win x64，其余平台版本详情见 package.json
41 | npm run build-w-64
42 | ```
43 |
44 | ## 推荐的 Web 打印设计渲染插件
45 |
46 | [vue-plugin-hiprint](https://github.com/CcSimple/vue-plugin-hiprint.git)
47 |
48 | ## 打印原理
49 |
50 | 1. **客户端服务**：通过 socket.io (默认端口 17521)提供服务。
51 |
52 | - 使用 `socket.io-client@4.x` 连接: `http://localhost:17521`
53 |
54 | 2. **发送打印数据**：通过 `socket.emit` 方法发送打印数据
55 |
56 | - 示例:
57 |
58 | ```js
59 | socket.emit("news", { html, templateId, printer, pageSize });
60 | ```
61 |
62 | - 参数说明：
63 | - `html`: HTML 字符串。
64 | - `templateId`: 用于标识成功或失败回调的 ID。
65 | - `printer`: 打印机名称。
66 | - `pageSize`: 打印纸张大小。
67 |
68 | ## 拓扑结构
69 |
70 |
71 |
72 | 
73 |
74 |
75 |
76 | ## 客户端设置
77 |
78 | 在 `v1.0.7` 后续版本中，支持这些设置
79 |
80 |
81 |
82 | 
83 |
84 |
85 |
86 | ```json
87 | {
88 | "mainTitle": "Electron-hiprint",
89 | "nickName": "",
90 | "openAtLogin": true,
91 | "openAsHidden": true,
92 | "port": "17521",
93 | "token": null,
94 | "connectTransit": true,
95 | "transitUrl": "https://v4.printjs.cn:17521",
96 | "transitToken": "hiprint-youcode",
97 | "allowNotify": true,
98 | "closeType": "tray",
99 | "pluginVersion": "0.0.58-fix",
100 | "logPath": "C:\\Users\\Administrator\\AppData\\Roaming\\hiprint\\logs",
101 | "pdfPath": "C:\\Users\\Administrator\\AppData\\Local\\Temp",
102 | "defaultPrinter": "",
103 | "disabledGpu": false,
104 | "rePrint": true
105 | }
106 | ```
107 |
108 | ### 配置项说明
109 |
110 | | 序号 | 字段名 | 类型 | 说明 |
111 | | ---- | ---------------------- | ---------------- | ----------------------------------------------------- |
112 | | 1 | mainTitle[[1]](#tips1) | String | 主标题 |
113 | | 2 | nickName | String | 可设置的便于识别的友好设备名称 |
114 | | 3 | openAtLogin | Boolean | 系统登录时启动 |
115 | | 4 | openAsHidden | Boolean | 启动时隐藏窗口 |
116 | | 5 | connectTransit | Boolean | 连接中转服务 |
117 | | 6 | port | String \| Number | 端口号（10000 - 65535），默认为 17521 |
118 | | 7 | token[[2]](#tips2) | String \| null | 身份验证令牌，支持固定 Token |
119 | | 8 | transitUrl | String | 中转服务地址 |
120 | | 9 | transitToken | String | 中转服务令牌 |
121 | | 10 | closeType | String | 窗口关闭行为（tray 或 quit） |
122 | | 11 | pluginVersion | String | vue-plugin-hiprint 插件版本 |
123 | | 12 | logPath | String | 日志路径 |
124 | | 13 | pdfPath | String | 临时文件路径 |
125 | | 14 | defaultPrinter | String | 默认打印机 |
126 | | 15 | disabledGpu | Boolean | 禁用 GPU 加速，可解决部分设备打印模糊问题，默认 false |
127 | | 16 | rePrint[[1]](#tips1) | Boolean | 是否允许重打，默认 true |
128 |
129 | > [1] `mainTitle` 和 `rePrint` 字段在设置页面中未显式提供设置，方便各位可以在不修改源码二开的情况下通过配置快速实现定制化和高级功能，且不易被客户篡改，详见下方[覆盖默认配置方法](#覆盖默认配置方法)。
130 |
131 | > [2] `vue-plugin-hiprint` 需要使用 ^0.0.55 版本才可使用 `token` 否则请勿设置 `token`。
132 |
133 | ### 覆盖默认配置方法
134 |
135 | 1. 二开项目，直接修改 [项目源码 /tools/utils.js](./tools/utils.js) 并重新打包
136 | 2. win `v1.0.12-beta6` 后续版本可在 `exe` 安装包路径添加 `config.json`,安装包会自动检测并使用该配置
137 |
138 | ```
139 | hiprint_win_x64-1.0.12-beta7.exe
140 | config.json
141 | ```
142 |
143 | ## 中转服务
144 |
145 | 项目支持 `node-hiprint-transit`，可解决跨域问题并实现云打印功能，详见 [node-hiprint-transit](https://github.com/Xavier9896/node-hiprint-transit)
146 |
147 |
148 |
149 | 
150 |
151 |
152 |
153 |
154 |
155 | 
156 |
157 |
158 |
159 | # 与非 `vue-plugin-hiprint` 项目的兼容
160 |
161 | 目标用户：只需要实现 HTML、PDF 静默打印，未使用 `vue-plugin-hiprint` 设计插件。
162 |
163 | ## 客户端连接
164 |
165 | 1. 安装依赖
166 |
167 | ```console
168 | npm install socket.io-client@4 --save
169 | ```
170 |
171 | 2. 连接示例
172 |
173 | ```js
174 | import { io } from "socket.io-client";
175 |
176 | const socket = io("http://localhost:17521", {
177 | transports: ["websocket"],
178 | auth: {
179 | token: "vue-plugin-hiprint",
180 | },
181 | });
182 |
183 | socket.on("connect", () => {
184 | globalThis.connect = true;
185 | // TODO: Do something for your project
186 | });
187 | ```
188 |
189 | 3. 获取客户端信息
190 |
191 |
192 |
193 | 与 electron-hiprint 建立连接
194 |
195 |
196 | - 连接成功后 `electron-hiprint` 会主动发送 `clientInfo`、`printerList` 事件，你只需要监听这两个事件即可获取到客户端信息与打印机列表。
197 |
198 | ```js
199 | socket.on("clientInfo", (clientInfo) => {
200 | globalThis.clientInfo = clientInfo;
201 | });
202 |
203 | socket.on("printerList", (printerList) => {
204 | globalThis.printerList = printerList;
205 | });
206 | ```
207 |
208 | ```js
209 | // clientInfo
210 | {
211 | "hostname": "Admin", // 主机名
212 | "version": "1.0.12-beta9", // 客户端版本
213 | "platform": "win32", // 平台类型
214 | "arch": "x64", // 系统架构
215 | "mac": "d0:46:0c:97:4b:68", // mac 地址
216 | "ip": "192.168.0.114", // 设备 ip
217 | "ipv6": "fe80::2157:4b26:1c2f:c4ca", // 设备 ipv6
218 | "clientUrl": "http://192.168.0.114:17521", // 本地服务地址
219 | "machineId": "0e8b222e-517b-491e-883a-b6283a62e280", // 设备唯一 ID
220 | "nickName": "打印客户端", // 友好昵称
221 | }
222 |
223 | // printerList
224 | [{
225 | description: "",
226 | displayName: "Microsoft Print to PDF",
227 | isDefault: true,
228 | name: "Microsoft Print to PDF",
229 | options: {,
230 | "printer-location": "",
231 | "printer-make-and-model": "Microsoft Print To PDF",
232 | "system_driverinfo": "Microsoft Print To PDF;10.0.19041.3570 (WinBuild.160101.0800);Microsoft® Windows® Operating System;10.0.19041.3570"
233 | },
234 | status: 0
235 | }, {…}, {…}, {…}, {…}, {…}]
236 | ```
237 |
238 | 你也可以主动向 `electron-hiprint` 发送 `getClientInfo`、`refreshPrinterList` 事件，来获取客户端打印机列表。
239 |
240 | ```js
241 | socket.emit("getClientInfo");
242 | socket.emit("refreshPrinterList");
243 | ```
244 |
245 |
246 |
247 |
248 |
249 | 与 node-hiprint-transit 建立连接
250 |
251 |
252 | - 连接成功后 `node-hiprint-transit` 会主动发送 `clients`、`printerList` 事件，你只需要监听这两个事件即可获取到客户端信息与打印机列表。
253 |
254 | ```js
255 | socket.on("clients", (clients) => {
256 | globalThis.clients = clients;
257 | });
258 |
259 | socket.on("printerList", (printerList) => {
260 | globalThis.printerList = printerList;
261 | });
262 | ```
263 |
264 | ```js
265 | // clients
266 | {
267 | "AlBaUCNs3AIMFPLZAAAh": {
268 | "hostname": "Admin", // 主机名
269 | "version": "1.0.12-beta9", // 客户端版本
270 | "platform": "win32", // 平台类型
271 | "arch": "x64", // 系统架构
272 | "mac": "d0:46:0c:97:4b:68", // mac 地址
273 | "ip": "192.168.0.114", // 设备 ip
274 | "ipv6": "fe80::2157:4b26:1c2f:c4ca", // 设备 ipv6
275 | "clientUrl": "http://192.168.0.114:17521", // 本地服务地址
276 | "machineId": "0e8b222e-517b-491e-883a-b6283a62e280", // 设备唯一 ID
277 | "nickName": "打印客户端", // 友好昵称
278 | printerList: [{
279 | description: "",
280 | displayName: "Microsoft Print to PDF",
281 | isDefault: true,
282 | name: "Microsoft Print to PDF",
283 | options: {,
284 | "printer-location": "",
285 | "printer-make-and-model": "Microsoft Print To PDF",
286 | "system_driverinfo": "Microsoft Print To PDF;10.0.19041.3570 (WinBuild.160101.0800);Microsoft® Windows® Operating System;10.0.19041.3570"
287 | },
288 | status: 0
289 | }, {…}, {…}, {…}, {…}, {…}],
290 | version: "1.0.7",
291 | },
292 | "clientid": {…},
293 | ...
294 | }
295 |
296 | // printerList
297 | [{
298 | clientId: "AlBaUCNs3AIMFPLZAAAh",
299 | description: "",
300 | displayName: "Microsoft Print to PDF",
301 | isDefault: true,
302 | name: "Microsoft Print to PDF",
303 | options: {,
304 | "printer-location": "",
305 | "printer-make-and-model": "Microsoft Print To PDF",
306 | "system_driverinfo": "Microsoft Print To PDF;10.0.19041.3570 (WinBuild.160101.0800);Microsoft® Windows® Operating System;10.0.19041.3570"
307 | },
308 | status: 0
309 | }, {…}, {…}, {…}, {…}, {…}]
310 | ```
311 |
312 | 你也可以主动向 `node-hiprint-transit` 发送 `getClients`、`refreshPrinterList` 事件，来获取客户端打印机列表。
313 |
314 | ```js
315 | socket.emit("getClients");
316 |
317 | socket.emit("refreshPrinterList");
318 | // node-hiprint-transit 会将这个请求再转发给所有连接的 electron-hiprint ，以获取最新的打印机列表，但是并没有等待所有 electron-hiprint 响应结束，而是在延迟 2s 后直接返回了缓存及新获取到的打印机列表。并且 node-hiprint-transit 每 10min 都会主动向 electron-hiprint 请求一次 printerList，所以这应该并无大碍。或者你也可以优化这一个功能。
319 |
320 | // https://github.com/Xavier9896/node-hiprint-transit/blob/main/index.js#L139
321 | ```
322 |
323 |
324 |
325 | ## 获取打印机纸张信息
326 |
327 | > [!IMPORTANT]
328 | > 该功能暂时只在 Window 环境下安装的 `electron-hiprint` 中支持，`node-hiprint-transit` 中转暂时也未支持！
329 |
330 |
331 |
332 | 连接为 electron-hiprint
333 |
334 |
335 | ```js
336 | // printerName: 打印机名称 可选值，缺省时返回所有打印机的纸张信息
337 | if (globalThis.connect) {
338 | socket.emit("getPaperSizeInfo", printerName);
339 | } else {
340 | alert("未连接客户端！");
341 | window.open("hiprint://");
342 | }
343 |
344 | socket.on("paperSizeInfo", (paperSizes) => {
345 | console.log(paperSizes);
346 | });
347 | ```
348 |
349 | ```js
350 | [
351 | {
352 | "PrinterName": "Microsoft Print to PDF",
353 | "TaskNumber": 0, // 打印队列任务数
354 | "Status": 0, // 打印机状态码
355 | "StatusMsg": "准备就绪（Ready）", // 打印机状态信息
356 | "PaperSizes": [
357 | {
358 | "Height": 1100,
359 | "Kind": 1,
360 | "PaperName": "信纸",
361 | "RawKind": 1,
362 | "Width": 850
363 | },
364 | {...}, {...}, {...}
365 | ]
366 | }
367 | ]
368 | ```
369 |
370 |
371 |
372 | ## 打印 HTML
373 |
374 |
375 |
376 | 连接为 electron-hiprint
377 |
378 |
379 | ```js
380 | /**
381 | * @description: 打印 html 字符串
382 | * @param {String} html 打印的html字符串
383 | * @param {String|number} templateId vue-plugin-hiprint 中的模板id，你可以自定义传入一个 Id，用于回调 success/error 判断
384 | * @param {String} printer 打印机名称 printer.name 可为空，缺省默认使用设备默认打印机
385 | * @param {pageSize} pageSize 打印纸张大小 { height: 80 * 1000, width: 60 * 1000 } 可为空，缺省默认使用打印机默认纸张
386 | * @description: 其他参数参考 默认打印参数说明
387 | */
388 | if (globalThis.connect) {
389 | socket.emit("news", { html, templateId, printer, pageSize });
390 | } else {
391 | alert("未连接客户端！");
392 | window.open("hiprint://");
393 | }
394 | ```
395 |
396 | [打印回调](#打印回调)
397 |
398 |
399 |
400 |
401 |
402 | 连接为 node-hiprint-transit
403 |
404 |
405 | > [!IMPORTANT]
406 | > 当你连接中转服务时，需要在参数中指定 `client`
407 |
408 | ```js
409 | // 你可以自行在项目中实现一个选择客户端、打印机的功能
410 | const clientId = "AlBaUCNs3AIMFPLZAAAh";
411 | const client = globalThis.clients[clientId];
412 | const printer = globalThis.clients[0].printerList[0];
413 |
414 | if (globalThis.connect) {
415 | socket.emit("news", {
416 | html,
417 | client: clientId,
418 | templateId,
419 | printer,
420 | pageSize,
421 | });
422 | socket.emit("news", {
423 | html,
424 | client: client.clientId,
425 | templateId,
426 | printer: printer.name,
427 | pageSize,
428 | });
429 | } else {
430 | alert("未连接客户端！");
431 | window.open("hiprint://");
432 | }
433 | ```
434 |
435 |
436 |
437 | ### 默认打印参数说明
438 |
439 | ```js
440 | // 详见electron文档: https://www.electronjs.org/zh/docs/latest/api/web-contents
441 | {
442 | silent: data.silent ?? true, // 静默打印
443 | printBackground: data.printBackground ?? true, // 是否打印背景
444 | printer: printer, // 打印机名称
445 | color: data.color ?? true, // 是否打印颜色
446 | margins: data.margins ?? {
447 | marginType: "none",
448 | }, // 边距
449 | landscape: data.landscape ?? false, // 是否横向打印
450 | scaleFactor: data.scaleFactor ?? 100, // 打印缩放比例
451 | pagesPerSheet: data.pagesPerSheet ?? 1, // 每张纸的页数
452 | collate: data.collate ?? true, // 是否排序
453 | copies: data.copies ?? 1, // 打印份数
454 | pageRanges: data.pageRanges ?? {}, // 打印页数
455 | duplexMode: data.duplexMode, // 打印模式 simplex,shortEdge,longEdge
456 | dpi: data.dpi, // 打印机DPI
457 | header: data.header, // 打印头
458 | footer: data.footer, // 打印尾
459 | pageSize: data.pageSize, // 打印纸张 // A0, A1, A2, A3, A4, A5, A6, Legal, Letter, Tabloid
460 | }
461 | // 其中纸张大小参数 pageSize 如果传自定义大小, 需要乘以 1000
462 | { height: 80 * 1000, width: 60 * 1000 }
463 | ```
464 |
465 | ## 使用 pdf 打印功能
466 |
467 | 原理:
468 |
469 | 1. 通过 electron 的 printToPDF 先导出 pdf 文件
470 | 2. 再通过 pdf-to-printer 或 unix-print 打印 pdf 文件
471 |
472 | > 传数据时需要传入: { type:'pdf' }
473 |
474 | > 如果是自定义的纸张大小, 别忘了传自定义的 paperName (纸张名称)
475 |
476 | ```js
477 | {
478 | client?: string; // 客户端id，连接中转服务必填
479 | printer?: string; // 打印机名称
480 | pages?: string; // 打印页数
481 | subset?: string; // 奇偶页 even、odd
482 | orientation?: string; // 纸张方向 portrait、landscape
483 | scale?: string; // 缩放 noscale、shrink、fit
484 | monochrome?: boolean; // 黑白打印 true、false
485 | side?: string; // 单双面 duplex, duplexshort, duplexlong, and simplex
486 | bin?: string; // select tray to print to
487 | paperName?: string; // 纸张大小 A2, A3, A4, A5, A6, letter, legal, tabloid, statement
488 | silent?: boolean; // Silences error messages.
489 | printDialog?: boolean; // 显示打印对话框 true、false
490 | copies?: number; // 打印份数
491 | }
492 |
493 | // vue-plugin-hiprint
494 | hiprint.hiwebSocket.send({ html, client, printer, type: 'pdf'})
495 |
496 | // 非vue-plugin-hiprint
497 | socket.emit("news", { html, client, printer, type: 'pdf'})
498 | ```
499 |
500 | ## 下载网络 pdf 打印
501 |
502 | 原理：
503 |
504 | 1. 通过 node 的 http 或 https 库下载网络 pdf 文件至用户临时目录
505 | 2. 后续内容同使用 pdf 打印功能
506 |
507 | > 因为打印网络 pdf 不存在模板拼接，所以打印时直接如下调用即可
508 |
509 | > 参数同 pdf 打印功能
510 |
511 | ```js
512 | // vue-plugin-hiprint
513 | hiprint.hiwebSocket.send({
514 | client,
515 | printer,
516 | type: "url_pdf",
517 | templateId: "自定义Id，用于判断任务是否成功",
518 | pdf_path: "网络PDF的下载url",
519 | });
520 |
521 | // 非vue-plugin-hiprint
522 | socket.emit("news", {
523 | client,
524 | printer,
525 | type: "url_pdf",
526 | templateId: "自定义Id，用于判断任务是否成功",
527 | pdf_path: "网络PDF的下载url",
528 | });
529 | ```
530 |
531 | ## Blob 打印 PDF (🧪实验性功能)
532 |
533 | > ^1.0.14-beta4
534 |
535 | ```js
536 | // vue-plugin-hiprint
537 | hiprint.hiwebSocket.send({
538 | client,
539 | printer,
540 | type: "blob_pdf",
541 | templateId: "自定义Id，用于判断任务是否成功",
542 | pdf_blob: Blob,
543 | });
544 |
545 | // 非vue-plugin-hiprint
546 | socket.emit("news", {
547 | client,
548 | printer,
549 | type: "blob_pdf",
550 | templateId: "自定义Id，用于判断任务是否成功",
551 | pdf_blob: Blob,
552 | });
553 | ```
554 |
555 | ## 打印回调
556 |
557 | ```js
558 | socket.on("success", (res) => {
559 | console.log(res.templateId);
560 | // TODO: Do something for your project
561 | });
562 |
563 | socket.on("error", (res) => {
564 | console.log(res.templateId);
565 | // TODO: Do something for your project
566 | });
567 | ```
568 |
569 | ## 模板+data 或 html 返回 jpeg、pdf、打印
570 |
571 | > [!TIP]
572 | > 该功能依赖 electron-hiprint@^1.0.12-beta7 版本
573 |
574 | 现在，你可以通过对应 socket 事件，调用 electron-hiprint 生成 jpeg、矢量 pdf 和直接打印了。
575 |
576 | 对于 vue-plugin-hiprint 模板，只需要提供 template(json、jsonString) 和 data(json) 即可。
577 |
578 | 非 vue-plugin-hiprint 模板，你需要提供 html（需要提供完整的样式含 UI、项目内部样式）。
579 |
580 |
581 |
582 | 
583 |
584 |
585 |
586 | | apiName | 参数 | 说明 |
587 | | -------------------- | --------------------------- | -------------------------------------------------- |
588 | | render-jpeg | `template`,`data` / `html` | 调用 electron 生成 jpeg |
589 | | render-jpeg-success | `templateId`,`buffer`,`msg` | 成功回调，返回 templateId 和生成的 jpeg 二进制数据 |
590 | | render-jpeg-error | `templateId`,`msg` | 错误回调，返回 templateId 和错误信息 |
591 | | render-pdf | `template`,`data` / `html` | 调用 electron 生成 pdf |
592 | | render-pdf-success | `templateId`,`buffer`,`msg` | 成功回调，返回 templateId 和生成的 pdf 二进制数据 |
593 | | render-pdf-error | `templateId`,`msg` | 错误回调，返回 templateId 和错误信息 |
594 | | render-print | `template`,`data` / `html` | 调用 electron 打印 |
595 | | render-print-success | `templateId`,`msg` | 成功回调，返回 templateId 和打印成功信息 |
596 | | render-print-error | `templateId`,`msg` | 错误回调，返回 templateId 和错误信息 |
597 |
598 |
599 | vue-plugin-hiprint
600 |
601 | ```js
602 | hiprint.hiwebSocket.socket.emit("render-jpeg", {
603 | template: panel,
604 | data: printData,
605 | html: "heml字符串",
606 | })
607 | socket.on("render-jpeg-success", (data) => {
608 | // data.buffer
609 | });
610 | socket.on("render-jpeg-error", (data) => {
611 | // data.error
612 | });
613 |
614 | hiprint.hiwebSocket.socket.emit("render-pdf", {
615 | template: panel,
616 | data: printData,
617 | html: "heml字符串",
618 | })
619 | socket.on("render-pdf-success", (data) => {
620 | // data.buffer
621 | });
622 | socket.on("render-pdf-error", (data) => {
623 | // data.error
624 | });
625 |
626 | hiprint.hiwebSocket.socket.emit("render-print", {
627 | template: panel,
628 | data: printData,
629 | html: "heml字符串",
630 | printer: "Microsoft Print to PDF",
631 | ...
632 | })
633 | socket.on("render-print-success", (data) => {
634 | // data.templateId
635 | });
636 | socket.on("render-print-error", (data) => {
637 | // data.templateId
638 | });
639 | ```
640 |
641 |
642 |
643 |
644 | node.js demo
645 |
646 | ```node
647 | const io = require("socket.io-client");
648 | const fs = require("fs");
649 |
650 | const panel = require("./panel.json");
651 | const printData = require("./print-data.json");
652 |
653 | const socket = io("http://localhost:17521", {
654 | transports: ["websocket"],
655 | reconnectionAttempts: 5,
656 | auth: {
657 | token: "vue-plugin-hiprint",
658 | },
659 | });
660 | socket.on("connect", () => {
661 | socket.emit("render-jpeg", {
662 | template: panel,
663 | data: printData,
664 | html: "heml字符串",
665 | });
666 | socket.on("render-jpeg-success", (data) => {
667 | fs.writeFile("./capture.jpeg", data.buffer, () => {});
668 | });
669 | // render-pdf 同上
670 | // render-print 同上
671 | });
672 | ```
673 |
674 |
675 |
676 | 打印参数同上 [默认打印参数说明](#默认打印参数说明)
677 |
678 | ## 断开连接
679 |
680 | ```js
681 | socket.on("disconnect", () => {
682 | globalThis.connect = false;
683 | // TODO: Do something for your project
684 | });
685 | ```
686 |
687 | ## 打印记录
688 |
689 | > [!TIP]
690 | > 打印记录功能属于 ^1.0.12-beta1 功能
691 |
692 | 客户端将会记录每一条 `news` ，你可以从这里查询历史打印记录，是否成功，重打操作等。
693 |
694 |
695 |
696 | 
697 |
698 |
699 |
700 | ### 禁用重打
701 |
702 | 1. 通过配置全局禁用重打
703 |
704 | 适合全局禁用重打，只提供日志查询，需在全局配置中设置禁用（设置页面未显式提供设置）
705 |
706 | - [覆盖默认配置方法](#覆盖默认配置方法)
707 |
708 | 2. 通过 api 禁用单条数据重打
709 |
710 | ```js
711 | // socket.io-client
712 | socket.emit("news", {
713 | html,
714 | templateId,
715 | printer,
716 | pageSize,
717 | rePrintAble: false,
718 | });
719 | socket.emit("render-print", { template, data, rePrintAble: false });
720 |
721 | // vue-plugin-hiprint
722 | hiprintTemplate.print2(printData, { printer, title, rePrintAble: false });
723 | hiprint.hiwebSocket.socket.emit("render-print", {
724 | template,
725 | data,
726 | rePrintAble: false,
727 | });
728 | ```
729 |
730 | ## URL Scheme 支持
731 |
732 | 通过 `hiprint://` 协议，可以从 Web 项目中调起 `electron-hiprint` 客户端，以便未建立连接时主动唤起客户端。
733 |
734 | > [!TIP]
735 | > 注意: 安装客户端时需以管理员身份运行。
736 |
737 |
738 |
739 | 
740 |
741 | 
742 |
743 |
744 |
745 | ```js
746 | // js
747 | window.open("hiprint://");
748 |
749 | // element-ui
750 | this.$alert(
751 | `连接【${hiwebSocket.host}】失败！
请确保目标服务器已 下载 并 运行 打印服务！`,
752 | "客户端未连接",
753 | { dangerouslyUseHtmlString: true },
754 | );
755 |
756 | // ant-design v1
757 | this.$error({
758 | title: "客户端未连接",
759 | content: (h) => (
760 |
774 | ),
775 | });
776 | ```
777 |
778 | ## 周边生态项目
779 |
780 | | 项目名称 | 项目地址 | 下载地址 | 描述 |
781 | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------ |
782 | | vue-plugin-hiprint | [github](https://github.com/CcSimple/vue-plugin-hiprint)、[gitee](https://gitee.com/CcSimple/vue-plugin-hiprint) | [npm](https://www.npmjs.com/package/vue-plugin-hiprint) | 打印设计器 |
783 | | electron-hiprint | [github](https://github.com/CcSimple/electron-hiprint)、[gitee](https://gitee.com/CcSimple/electron-hiprint) | [releases](https://github.com/CcSimple/electron-hiprint/releases) | 直接打印客户端 |
784 | | node-hiprint-transit | [github](https://github.com/Xavier9896/node-hiprint-transit)、[gitee](https://gitee.com/Xavier9896/node-hiprint-transit) | [releases](https://github.com/Xavier9896/node-hiprint-transit/releases) | web 与客户端中转服务 Node 实现 |
785 | | hiprint-transporter-java | [github](https://github.com/LyingDoc/hiprint-transit-java)、[gitee](https://gitee.com/dut_cc/hiprint-transporter-java) | - | web 与客户端中转服务 Java 实现 |
786 | | hiprint-transit-java | [github](https://github.com/weaponready/hiprint-transit-java) | - | web 与客户端中转服务 Java 实现 |
787 | | uni-app-hiprint | [github](https://github.com/Xavier9896/uni-app-hiprint) | - | uni-app 项目通过 webview 使用 vue-plugin-hiprint demo |
788 | | node-hiprint-pdf | [github](https://github.com/CcSimple/node-hiprint-pdf) | - | 提供通过 node 对 vue-plugin-hiprint 模板生成 矢量 pdf、image、html |
789 |
790 | ## 参考资源
791 |
792 | - [electron](https://www.electronjs.org/zh/docs/latest/)
793 | - [electron-egg](https://gitee.com/wallace5303/electron-egg/)
794 | - [pdf-to-printer](https://github.com/artiebits/pdf-to-printer)
795 | - [unix-printer](https://github.com/artiebits/unix-print)
796 |
797 | ## 感谢
798 |
799 | logo 设计：[橙色](mailto:tong567@foxmail.com)
800 |
--------------------------------------------------------------------------------