初识Electron

July 02, 2022 4465

Electron是一个使用JavaScript、HTML、CSS构建桌面应用程序的框架。

初识Electron

​ Electron是一个JavaScript、HTML、CSS构建桌面应用程序的框架。通过将Chromium和Node.js嵌入到它的二进制文件中，Electron允许维护一个JavaScript代码库并创建可在Windows、macOS、Linux上运行的跨平台应用程序——无需本地开发经验。

本质上为浏览器内置了Node环境，从而可以控制本地文件

PS：Visual Studio Code = TypeScript + Electron

准备工作

检查Node.js以及包管理器npm是否正确安装

1
2
node -v
npm -v

PS：若没有安装的话可以在官网根据文档介绍安装

创建一个应用程序

  • 直接通过git clone https://github.com/electron/electron-quick-start
  • npm创建
  • 手动创建

git创建

输入命令

1
git clone https://github.com/electron/electron-quick-start

PS：也可以直接下载项目压缩包

得到文件electron-quick-start

输入命令

1
2
3
cd electron-quick-start
npm install 
npm start

运行结果

image-20211101170519553

npm创建

输入命令

1
2
3
npx create-electron-app@latest my-app
cd my-app
npm start

执行上述命令后，会得到如下文件结构：

运行结果：

打包

1
npm run make

手动创建

输入命令

1
2
3
mkdir my-electron-app  //创建文件夹
cd my-electron-app   //进入文件夹
npm init  //初始化命令

将electron包安装到应用的开发依赖中

1
npm install --save-dev electron

在配置文件packge.json中添加启动命令

1
2
3
4
5
{
  "script":{
     "start":"electron ."
  }
}

在根目录下创建

  • 空文件main.js（控制主进程）

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    // main.js

    // 控制应用生命周期和创建原生浏览器窗口的模组
    const { app, BrowserWindow } = require('electron')
    const path = require('path')

    function createWindow () {
      // 创建浏览器窗口
      const mainWindow = new BrowserWindow({
        width: 800,
        height: 600,
        webPreferences: {
          preload: path.join(__dirname, 'preload.js')
        }
      })

      // 加载 index.html
      mainWindow.loadFile('index.html')

      // 打开开发工具
      // mainWindow.webContents.openDevTools()
    }

    // 这段程序将会在 Electron 结束初始化
    // 和创建浏览器窗口的时候调用
    // 部分 API 在 ready 事件触发后才能使用。
    app.whenReady().then(() => {
      createWindow()

      app.on('activate', function () {
        // 通常在 macOS 上，当点击 dock 中的应用程序图标时，如果没有其他
        // 打开的窗口，那么程序会重新创建一个窗口。
        if (BrowserWindow.getAllWindows().length === 0) createWindow()
      })
    })

    // 除了 macOS 外，当所有窗口都被关闭的时候退出程序。 因此，通常对程序和它们在
    // 任务栏上的图标来说，应当保持活跃状态，直到用户使用 Cmd + Q 退出。
    app.on('window-all-closed', function () {
      if (process.platform !== 'darwin') app.quit()
    })

    // 在这个文件中，你可以包含应用程序剩余的所有部分的代码，
    // 也可以拆分成几个文件，然后用 require 导入。

  • 预加载脚本preload.js

    预加载脚本在渲染器进程进程加载之前加载，并有权访问两个渲染器全局（window和document）和Node.js环境

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    //访问Node.js process.version 对象，并运行一个基本的 replaceText 辅助函数将版本号插入到HTML中
    //所有的Node.js API 都可以在预加载过程中使用
    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])
      }
    })

  • 页面index.html（加载进窗口的内容）

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    <!--index.html-->

    <!DOCTYPE html>
    <html>
      <head>
        <meta charset="UTF-8">
        <!-- https://developer.mozilla.org/zh-CN/docs/Web/HTTP/CSP -->
        <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
        <meta http-equiv="X-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>.

        <！-- 您也可以此进程中运行其他文件 -->
        <script src="./renderer.js"></script>
      </body>
    </html>

运行效果图：

image-20211101170519553

在渲染进程中调用Node接口(点击按钮写入文件)

在主进程(main.js)createWindow中添加

1
2
3
4
5
webPreferences:{
   //浏览器的js可以支持node接口
   nodeIntegration:true,
   contextIsolation: false    
}

在页面中添加按钮并引用渲染进程

1
2
<button id="add-file">添加文件</button>
<script src="./js/render.js"></script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
//render.js
let fs=require("fs");
let btn = document.querySelector('button');
let i=0;
btn.onclick = function(){
    i++;
    fs.writeFile(`input${i}.txt`,'点击按钮写入的内容',(err)=>{
        if(err){
            console.log(err);
        }else{
            console.log('写入完毕');
        }
    })
}

执行后点击按钮会生成一个.txt文件：

查看评论