JQiue's notes

Electron

发布于 2021-06-28

::: tip 前置知识

  • HTML，CSS，JavaScript
  • Node.js :::

Electron 是一个使用 JavaScript、HTML 和 CSS 构建桌面应用程序的框架，基于Chromium 和 Node.js 实现的，这就使得前端程序员可以使用 JavaScript、HTML 和 CSS 轻松构建跨平台的桌面应用。为了弥补 Node.js 和前端技术访问系统 API 方面的不足，Electron 对系统 API 做了封装，比如系统对话框、系统托盘、系统菜单、剪切板等。开发者基于 Electron 开发应用时，可以直接使用 JavaScript 访问这些 API

创建项目

yarn init初始化项目，pacakge.json 配置如下

{
  "name": "my-app",
  "version": "0.0.1",
  "description": "Hello World!",
  "main": "main.js",
  "author": "JQiue",
  "license": "MIT",
  "scripts": {
    "start": "electron ."
  }
}

安装 Electron 依赖

::: caution 一定要先给.npmrc添加electron_mirror="https://npm.taobao.org/mirrors/electron/" :::

yarn add --dev electron

创建main.js主进程文件，内容如下：

const path = require('path')
const { app, BrowserWindow } = require('electron')

const createWindow = () => {
  const win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js')
    }
  })
  win.loadFile('index.html')
}

app.whenReady().then(() => {
  createWindow()
})

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') app.quit()
})

创建index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP -->
    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
    <title>Hello World!</title>
  </head>
  <body>
    <h1>Hello World!</h1>
    We are using Node.js <span id="node-version"></span>,
    Chromium <span id="chrome-version"></span>,
    and Electron <span id="electron-version"></span>.
  </body>
</html>

创建预加载文件preload.js

window.addEventListener('DOMContentLoaded', () => {
  const replaceText = (selector, text) => {
    const element = document.getElementById(selector)
    if (element) element.innerText = text
  }

  for (const dependency of ['chrome', 'node', 'electron']) {
    replaceText(`${dependency}-version`, process.versions[dependency])
  }
})

然后运行yarn run start即可运行

结合 Vue

先安装 Vue 脚手架

npm i @vue/cli -g

创建项目：

vue create electron-vue

进入项目中，添加插件

vue add electron-builder

主进程和渲染进程

主进程负责完成监听应用程序的生命周期事件、启动第一个窗口、加载index.html页面、应用程序关闭后回收资源、退出程序等工作。渲染进程负责完成渲染界面、接收用户输入、响应用户的交互等工作

一个Electron应用只有一个主进程，但可以有多个渲染进程。一个BrowserWindow实例就代表着一个渲染进程。当BrowserWindow实例被销毁后，渲染进程也跟着终结

主进程负责管理所有的窗口及其对应的渲染进程。每个渲染进程都是独立的，它只关心所运行的Web页面。在开启nodeIntegration配置后，渲染进程也有能力访问Node.js的API

在Electron中，GUI相关的模块仅在主进程中可用。如果想在渲染进程中完成创建窗口、创建菜单等操作，可以让渲染进程给主进程发送消息，主进程接到消息后再完成相应的操作；也可以通过渲染进程的remote模块来完成相应操作。这两种方法背后的实现机制是一样的

主进程和渲染进程之间的通信通常使用ipcRender和ipcMain

构建应用

安装 Electron Forge

yarn add --dev @electron-forge/cli

并执行npx electron-forge import

然后使用make命令发布程序

参考资料

  • Electron 实战