Electron中文手册
  • 文档概述
  • 开发指南目录
  • 构建说明(Linux)
  • 构建说明(macOS)
  • 构建说明(Windows)
  • 构建系统概述
  • 编码规范
  • 在 macOS 中调试
  • 在 Windows 中调试
  • 在C ++代码中使用clang-format
  • 在调试器中设置符号服务器
  • 源代码目录结构
  • Chrome升级清单
  • Chromium 开发指南
  • V8 开发指南
  • 教程目录
    • 关于 Electron
    • Electron 版本说明
    • API弃用说明
    • 快速入门
    • 支持的平台
    • 桌面环境集成
    • 系统通知
    • 离屏渲染
    • 在线/离线事件检测
    • 多线程
    • REPL
    • 键盘快捷键
    • DevTools扩展
    • 使用原生模块
    • 使用 Pepper Flash 插件
    • 使用 Selenium 和 WebDriver
    • 使用 Widevine CDM 插件
    • 应用分发
    • 应用打包
    • 主进程调试
    • 使用 node-inspector 进行主进程调试
    • 使用 VSCode 进行主进程调试
    • Mac App Store应用提交指南
    • Windows App Store应用提交指南
    • 安全,本地功能和你的责任
    • Headless CI Systems 测试
  • API接口目录
    • API接口之公用接口
      • 应用语言
      • 开发概要
      • 专业术语
      • 常见问题
      • 环境变量
      • 快捷键字符串
      • 命令行
      • 客户端请求
      • 剪贴板
      • <File> H5 File文件操作
      • 无框窗口
      • <window.open> window.open打开新窗口或打开时传递消息
      • 沙盒选项
    • API接口之主进程接口
      • 整体控制
      • 全局快捷键
      • 图标创建与应用
      • 屏幕
      • 窗口
      • 菜单
      • 菜单项
      • 系统托盘
      • 网页内容
      • 从主进程到渲染进程的异步通信
      • 对话框
      • 创建和控制视图
      • 会话
      • 会话,缓存和代理等控制
      • 页面请求
      • HTTP/HTTPS请求处理
      • 协议的注册和处理
      • 使用系统默认应用程序管理文件或URL
      • 下载项管理
      • 进程控制
      • Chromium原生网络库
      • 获取系统首选项
      • 电源状态
      • 节能管理
      • 调试工具
      • 奔溃报告
      • 性能数据收集
      • 自动更新
      • TouchBar触摸条
      • TouchBar触摸条按钮
      • TouchBar触摸条拾色器
      • TouchBar触摸条分组
      • TouchBar触摸条scrubber
      • TouchBar触摸条分段控件
      • TouchBar触摸条label标签
      • TouchBar触摸条弹出框
      • TouchBar触摸条滑块
      • TouchBar触摸条间隔符
    • API接口之渲染进程接口
      • 页面渲染
      • <webview> webview标签
      • 渲染进程与主进程通信
      • 从渲染进程到主进程的异步通信
      • 子窗口
      • 捕获桌面资源
  • 结构列表
    • 蓝牙设备对象
    • 证书对象
    • 证书主体对象
    • Cookie对象
    • 崩溃报告对象
    • 桌面捕获源对象
    • 显示器对象
    • 打印机信息对象
    • 文件过滤器对象
    • 最近使用的项目
    • 常用列表项
    • CPU使用率对象即程序占用的CPU资源
    • IO值对象
    • 内存信息对象
    • 进程内存信息对象
    • 内存使用详细信息
    • Mime类型缓冲区
    • 矩形对象
    • 删除客户端证书对象
    • 删除密码对象
    • Scrubber项对象
    • 分段控制对象
    • 快捷方式对象
    • 任务对象
    • 缩略图工具栏按钮对象
    • 上传blob对象
    • 上传数据对象
    • 上传文件系统对象
    • 上传文件对象
    • 上传原始数据对象
Powered by GitBook
On this page
  • 如何安装原生模块?
  • 第一种: 使用 npm
  • 第二种: 下载并重新编译模块
  • 第三种: 手动编译
  • 故障排除
  • prebuild 依赖模块
  • node-pre-gyp 依赖模块

Was this helpful?

  1. 教程目录

使用原生模块

尽管Electron支持Node 原生模块, 但Electron与Node的V8版本可能不同,所以需要在构建原生模块时指定 Electron headers的位置。

如何安装原生模块?

有以下三种方法:

第一种: 使用 npm

只需设置少量的系统环境变量, 你就可以使用 npm直接安装原生模块.

为 Electron 安装所有依赖项的一个例子:

# Electron 的版本.
export npm_config_target=1.2.3
# Electron 的系统架构, 值为 ia32 或 x64.
export npm_config_arch=x64
export npm_config_target_arch=x64
# 下载 Electron 的 headers.
export npm_config_disturl=https://atom.io/download/electron
# 告诉 node-pre-gyp 是为 Electron 构建.
export npm_config_runtime=electron
# 告诉 node-pre-gyp 从源代码构建模块.
export npm_config_build_from_source=true
# 下载所有依赖,并缓存到 ~/.electron-gyp.
HOME=~/.electron-gyp npm install

第二种: 下载并重新编译模块

安装了 electron-rebuild并利用它重建模块的示例:

npm install --save-dev electron-rebuild

# 每次运行"npm install"时,也运行这条命令:
./node_modules/.bin/electron-rebuild

# 在windows下如果上述命令遇到了问题,尝试这个:
.\node_modules\.bin\electron-rebuild.cmd

第三种: 手动编译

如果您是原生模块的作者并希望在Electron中进行测试,那么你可能需要手动重编译该Electron模块。 您可以直接使用 node-gyp来构建Electron:

cd /path-to-module/
HOME=~/.electron-gyp node-gyp rebuild --target=1.2.3 --arch=x64 --dist-url=https://atom.io/download/electron
  • HOME=~/.electron-gyp : 开发时的headers的位置.

  • --target=1.2.3 : Electron的版本.

  • --dist-url=... : Electron 的 headers 的下载地址.

  • --arch=x64: 模块为适配64位操作系统而编译.

故障排除

你安装了原生模块后无法工作时,请尝试检查以下事项:

  • 模块的架构必须与Electron的架构(ia32或x64)相匹配.

  • 当你升级Electron后,通常也需要重编译模块.

  • 有疑问时,先运行 electron-rebuild 试试.

prebuild 依赖模块

如果为 Electron 提供二进制原生模块,请确保删除 --build-from-source 和 npm_config_build_from_source 环境变量来充分利用预编译的二进制文件。

node-pre-gyp 依赖模块

通常这些模块在 Electron 中正常工作,但当 Electron 使用比 Node 更新的 V8 版本时,ABI会被更改并引起错误 。所以一般建议从源代码编译原生模块。

如果你通过 npm 的方式安装模块,默认情况下这就完成了

如果没有,你需要传入 --build-from-source 给 npm, 或者设置 npm_config_build_from_source 环境变量。

PreviousDevTools扩展Next使用 Pepper Flash 插件

Last updated 4 years ago

Was this helpful?

你可以像普通的Node项目一样下载并安装模块, 然后通过 包重新编译原生模块,它帮你自动完成了下载 headers, 编译原生模块等步骤.

为多个版本的 Node 和 Electron 提供了一种简单发布预编译二进制原生模块的方法。

提供一种部署原生 Node 预编译二进制模块的方法,很多常用模块都是使用它。

electron-rebuild
prebuild
node-pre-gyp 工具