【Electron实战开发】HelloWorld入门实战

头像
Tammy
    阅读 5 分钟
    3

    此为【Electron开发实战】的第一项目，HelloWorld快速入门。

    项目地址为 https://github.com/lingshanju...

    创建工程目录

    从开发的角度来看, Electron application 本质上是一个 Node. js 应用程序。 应用启动的入口是一个与 Node.js 模块相同的 package.json 文件。 一个最基本的 Electron 应用一般来说会有如下的目录结构：

    your-app/
  ├── package.json
  ├── main.js
  └── index.html

    首先，为你的新Electron应用创建一个新的空文件夹。 打开你的命令行工具，然后从该文件夹运行npm init

    npm init

    npm 会帮助你创建一个基本的 package.json 文件。 其中的 main 字段所表示的脚本为应用的启动脚本，它将会在主进程中执行。 如下片段是一个 package.json 的示例：

    {
    "name": "your-app",
    "version": "0.1.0",
    "main": "main.js"
}

    注意：如果 main 字段没有在 package.json 中出现，那么 Electron 将会尝试加载 index.js 文件（就像 Node.js 自身那样）。

    接着，你需要添加一个 start 脚本来指引 electorn去执行当前的 package：

    {
    "name": "your-app",
    "version": "0.1.0",
    "main": "main.js",
    "scripts": {
      "start": "electron ."
    }
}

    安装 Electron

    npm install --save-dev electron

    我们推荐的安装方法是把它作为您 app 中的开发依赖项，这使您可以在不同的 app 中使用不同的 Electron 版本。

    注意，用npm安装electron，由于其非常大，有50M左右，即时翻墙，也很容易安装失败。所以，最好全局更改其镜像地址为淘宝镜像地址：

    npm config set ELECTRON_MIRROR http://npm.taobao.org/mirrors/electron/ -g

    这样，再重新运行安装electron命令，你就会发现速度很快。

    当然，也可用cnpm替换npm，有你决定。

    开发一个简易的 Electron

    在main.js文件中添加如下代码

      const {app, BrowserWindow} = require('electron')
  const path = require('path')
  const url = require('url')
  
  // 保持一个对于 window 对象的全局引用，如果你不这样做，
  // 当 JavaScript 对象被垃圾回收， window 会被自动地关闭
  let win
  
  function createWindow () {
    // 创建浏览器窗口。
    win = new BrowserWindow({width: 800, height: 600})
  
    // 然后加载应用的 index.html。
    win.loadURL(url.format({
      pathname: path.join(__dirname, 'index.html'),
      protocol: 'file:',
      slashes: true
    }))
  
    // 打开开发者工具。
    win.webContents.openDevTools()
  
    // 当 window 被关闭，这个事件会被触发。
    win.on('closed', () => {
      // 取消引用 window 对象，如果你的应用支持多窗口的话，
      // 通常会把多个 window 对象存放在一个数组里面，
      // 与此同时，你应该删除相应的元素。
      win = null
    })
  }
  
  // Electron 会在初始化后并准备
  // 创建浏览器窗口时，调用这个函数。
  // 部分 API 在 ready 事件触发后才能使用。
  app.on('ready', createWindow)
  
  // 当全部窗口关闭时退出。
  app.on('window-all-closed', () => {
    // 在 macOS 上，除非用户用 Cmd + Q 确定地退出，
    // 否则绝大部分应用及其菜单栏会保持激活。
    if (process.platform !== 'darwin') {
      app.quit()
    }
  })
  
  app.on('activate', () => {
    // 在macOS上，当单击dock图标并且没有其他窗口打开时，
    // 通常在应用程序中重新创建一个窗口。
    if (win === null) {
      createWindow()
    }
  })

    然后编辑你想展示的 index.html：

    <!DOCTYPE html>
  <html>
    <head>
      <meta charset="UTF-8">
      <title>Hello World!</title>
    </head>
    <body>
      <h1>Hello World!</h1>
      We are using node <script>document.write(process.versions.node)</script>,
      Chrome <script>document.write(process.versions.chrome)</script>,
      and Electron <script>document.write(process.versions.electron)</script>.
    </body>
  </html>

    启动你的应用

    在工程目录下运行

    npm start

    可看到效果如下
    image

    打包应用程序

    接下来就是打包应用程序了，以便分发应用，在其他机器上安装使用。这里我们使用第三方打包工具来做这项工作。

    通常有三种打包工具可供选择：

    这里我们使用electron-packager来打包。

    安装electon-packager

    你可以本地安装或全局安装

    # for use in npm scripts
npm install electron-packager --save-dev

# for use from cli
npm install electron-packager -g

    修改package.json

    修改npm scripts，添加打包任务

    "scripts": {
    "start": "electron .",
    "package": "electron-packager ."
},

    同时添加productName字段，用于设置打包后的app名称。

     "productName": "HelloWorld",

    electron-packager .命令，表示将当前目录文件打包生成应用程序HelloWorld.app。

    运行打包命令

    运行

    npm run package

    则可看到在当前项目目录下生成了一个文件夹HelloWorld-darwin-x64，打开可看到
    image
    双击HelloWorld.app，即可运行该app，其效果和上面npm start一样。

    这样此HelloWorld.app就可以在任何地方运行了。

    有关electorn-packager详细使用，请参考官方文档electron-packager

    生成分发安装包

    有很多工具可供选择，用于将打包好的应用生成分发安装包，以便于在其他机器下载安装。

    Windows:

    OS X:

    Linux:

    此处我使用electron-installer-dmg。
    首先，我选择全局安装electron-installer-dmg

    npm i electron-installer-dmg -g

    然后，生成将上面生成的HelloWorld.app生成安装包

    electron-installer-dmg HelloWorld-darwin-x64/HelloWorld.app/ helloworld

    你会看到，在项目目录下新生产了一个helloworld.dmg安装包。
    image
    双击此安装包，会弹出对话框，将其拖拽到Applications文件夹下，就可在应用程序列表中找到该应用了。
    image

    到此，一个使用Electron开发的快速入门应用就完成了。

    后续还会有一系列Electron应用实战开发的文章，实战项目会从简单到复杂渐进，敬请期待！
    打包实战hello-worldelectron
    Tammy
    111 声望14 粉丝

    不易匠心方得始终

    « 上一篇
    webpack-dev-server的刷新模式inline和iframe详解

    引用和评论

    推荐阅读
    头像
    Tauri 2.0 发布，Electron 迎来强劲对手？

    白水赞 2阅读 940

    头像
    使用 uni-app 开发 APP 并上架 IOS 全过程

    Link阅读 1.8k

    头像
    [oeasy]python0010_hello_world_unix_c历史迷因

    oeasy阅读 1.1k

    头像
    Electron32-Vue3OS：基于vite5+electron32+arcoDesign仿win/mac桌面os模板

    xiaoyan2017阅读 409

    头像
    electron中采用配置文件，打包后路径变化的问题

    热饭班长阅读 352

    头像
    记录react+electron开发单页应用SPA遇到的路由问题

    sAkuraOfficial阅读 240

    头像
    「零基础到实战」：如何在 Electron 中实现本地化日志系统

    Sean阅读 149

    0 条评论
    得票最新