Electron-Vue.js集成SerialPort监听COM端口运行报错问题咨询
Electron-Vue 场景下SerialPort串口功能运行报错解决
报错根因
这个问题的核心是SerialPort属于依赖C++原生绑定的Node模块,无法被Webpack正常打包进Vue渲染进程,和普通Node环境的运行逻辑存在冲突:
- 串口逻辑本身是纯Node原生能力,依赖对应系统平台的二进制绑定文件,本身不经过Webpack转译打包
- 当这段代码被放在Electron-Vue的渲染进程业务代码里时,Webpack会尝试把serialport模块打包进前端静态bundle,错误篡改原生模块的引用路径,最终导致bindings模块找不到Electron的原生模块上下文,抛出
TypeError: Cannot read property 'modules' of undefined的报错 - 普通Node环境能正常运行,是因为没有Webpack的打包拦截,可直接加载对应平台的原生二进制文件。
具体修复步骤
把所有串口逻辑迁移到Electron主进程
所有涉及串口初始化、读、写的代码,全部移到Electron的主进程入口文件(一般是项目根目录的background.js/main/index.js),绝对不能放在Vue的src目录下的渲染进程业务代码中。调整Webpack与Electron打包配置,排除serialport的打包流程
在vue.config.js中添加配置,让Webpack把serialport相关模块标记为外部CommonJS依赖,不参与前端bundle打包:module.exports = { configureWebpack: { externals: { 'serialport': 'commonjs serialport', '@serialport/bindings': 'commonjs @serialport/bindings' } }, pluginOptions: { electronBuilder: { // 告诉electron-builder这些模块是外部原生依赖,不要打包进前端资源 externals: ['serialport', '@serialport/bindings'], // 不建议开启nodeIntegration,保持安全配置 nodeIntegration: false } } }通过Electron IPC通信打通渲染进程与主进程的串口交互
渲染进程(Vue页面)没有直接操作主进程串口的权限,需要靠IPC传递消息实现读写、数据接收:- 主进程侧定义串口逻辑,监听渲染进程的请求,同时把串口读到的数据推回渲染进程,示例代码:
// 主进程入口文件(background.js) const { ipcMain } = require('electron') const SerialPort = require('serialport') const Readline = SerialPort.parsers.Readline let activePort = null // 响应渲染进程的串口打开请求 ipcMain.on('open-serial', (event, portConfig) => { activePort = new SerialPort(portConfig.path, { baudRate: portConfig.baudRate }) const parser = activePort.pipe(new Readline()) // 串口收到数据时,实时推给对应的渲染页面 parser.on('data', (line) => { event.sender.send('serial-data-receive', line) }) // 串口异常时通知页面 activePort.on('error', (err) => { event.sender.send('serial-error', err.message) }) }) // 响应渲染进程的串口写入请求 ipcMain.on('serial-write', (event, writeContent) => { if (activePort?.isOpen) { activePort.write(writeContent) } }) - 渲染进程侧的Vue业务代码里,通过IPC触发主进程的串口操作、接收数据:
// Vue组件内的逻辑 const { ipcRenderer } = window.require('electron') // 发送指令打开COM3,波特率9600 ipcRenderer.send('open-serial', { path: 'COM3', baudRate: 9600 }) // 监听主进程推回来的串口数据 ipcRenderer.on('serial-data-receive', (event, line) => { console.log('读取到串口数据:', line) }) // 向串口发送数据 ipcRenderer.send('serial-write', 'Sended Data !')
- 主进程侧定义串口逻辑,监听渲染进程的请求,同时把串口读到的数据推回渲染进程,示例代码:
重编译serialport原生模块适配Electron运行环境
普通npm安装的serialport是适配系统Node.js版本的,和Electron内置的Node版本不匹配,需要执行重编译命令:npx electron-rebuild -f -w serialport执行完成后重启项目,即可正常加载串口模块。
注意:不要通过开启渲染进程的nodeIntegration来直接require serialport,这种方式不仅存在安全风险,Webpack依然会出现打包错误,必须遵循主进程承载原生模块、渲染进程走IPC交互的Electron标准架构。
内容的提问来源于stack exchange,提问作者SefaUn
相关产品推荐
相关产品推荐

