electron-builder 教程

electron 说明

如果不明白electron 是做什么的可以先看官网介绍，或者百度查找资料。

个人认为electron 就是个打包工具，把普通的html网页打包成window、mac或linux应用。 所以可以先写好网页，然后用electron 命令打包。

electron 技术选型

有很多开源项目提供了把electron作为插件放到项目里的用法。
github上比较排前的有 electron-vue, 和 electron-builder 两个项目（比较适合vue项目），百度了比较多的博客，
发现用electron-builder 的比较多，所以选择用electron-builder。

环境安装

node下载地址

首页确定所需环境已经安装：node、 npm 或 yarn、vue-cli、 electron

全局安装vue-cli： 

npm install -g @vue/cli
# or
yarn global add @vue/cli


全局安装electron：
npm install electron -g

创建项目脚手架

在某个文件夹下打开cmd， 输入vue create electro-app , 先创建好vue项目，
（注意这里会有很多配置，选择项目里需不需要这些东西，如css预处理器， vuex, vue-router, esling,prettier。
不熟悉可以在第一步直接选default 按回车 ）， 然后就会得到一个基本的vue项目目录。如下图

运行项目

在目录下打开cmd 运行 yarn run serve  等待项目跑起来，在浏览器里打开地址，正常vue项目已经跑起来了。

这时候可以打开目录下的 package.json 文件， 如下图所示

上图是还没有使用 electron-builder 之前的依赖。 现在在目录下cmd里输入 vue add electron-builder 等待安装依赖， 途中会要我们选择版本

选择^13.0.0， 等待依赖安装完， 安装完后项目目录如下

会发现目录里多了一个background.js 的文件，并且package.json 里多了依赖和执行命令
其中这个 “main”: “background.js” 是electron的入口文件

background.js文件里生成了窗口，然后在窗口里加载了一个html地址， 把这个地址的内容渲染了出来

运行到桌面

运行 npm run electron:serve 命令

会出现下面这个，根据提示可知，它一直在尝试请求扩展，比较影响速度

这是因为 background.js 里会打开vue devtools （vue 开发工具）
可以把 await installExtension(VUEJS_DEVTOOLS) 这一句代码注释掉，下一次就能很快跑起来了。
运行起来的界面如下

到此我们已经成功的运行起来了。接下来需要把代码打包成exe应用。

打包

执行 npm run electron:build 打包命令，  需要等待一会

最终结果如上图： 可以看到绿色安装目录和 exe文件 都打包出来了。

但是应用的名称和图标需要更换掉，所以还需要一些配置。

网上很多说在package.json 增加build 配置， 但是发现没有作用，最终解决方案是在目录下增加了vue.config.js 文件，也就是vue配置文件，

vue.config.js

module.exports = {
  publicPath: './', // 公共路径 如果放在服务器下的 admin 目录下 就配置 './admin'
  // outputDir: 'chain', // 打包后的目录名
  productionSourceMap: false, // 打包后不要sourcemap
  chainWebpack: config => {
    config.plugins.delete('prefetch')
    config.plugins.delete('preload');
  },
  css: {
    loaderOptions: {
      sass: {
        // prependData: `@import "@/assets/style/base.scss";`
      },
    },
  },
  devServer: {
    port: 80,
    open: false,
    overlay: {
      warnings: false,
      errors: true
    },
    // https: true,
    disableHostCheck: true,
    proxy: {
      '/api': {
        target: 'https://s.jiu-guo.com',
        changeOrigin: true,
        ws: true,
        https: true,
        pathRewrite: {
          '^/api': '/api'
        }
      }
    }
  },
  // 上面的配置都是普通网页的配置， 这里只是顺便也贴了出来
  // https://blog.csdn.net/Assassin_EZI0/article/details/107144377 // 这是一篇打包配置教程
  pluginOptions: {
    electronBuilder: {
      builderOptions: {
        publish: [
          {
            provider: 'generic',
            url: 'https://s.jiu-guo.com/upload/app/' // 放置安装包和latest.yml的服务器地址
          }
        ],
        asar: true,
        nsis: {
          oneClick: false, // 是否一键安装
          allowElevation: true, // 允许请求提升。 如果为false，则用户必须使用提升的权限重新启动安装程序。
          allowToChangeInstallationDirectory: true, // 允许修改安装目录
          // installerIcon: '', // 安装图标
          // uninstallerIcon: '', //卸载图标
          // installerHeaderIcon: '', // 安装时头部图标
          // shortcutName: '', // 图标名称
          createDesktopShortcut: true,
          createStartMenuShortcut: true
        },
        win: {
          icon: './public/favicon.ico', // 打包后的应用图标 public 目录下的图标  注意图标最小255 * 255，否则打包会报错
          artifactName: '测试_${version}.${ext}', // 打包后的执行文件名称
          // artifactName: 'chain-desktop_setup_${version}.${ext}', // 打包后的安装包名称
          target: ['nsis', 'zip'] // 打包成安装包和免安装版
        },
        mac: {
          icon: './public/app.jpg'
        },
        productName: '测试应用' // 应用名称
      }
    }
  }
}

再次运行打包命令 npm run electron:build 等待打包成功后， 图标已经变了

到此打包已经完成，打包具体配置有很多，如有额外需求需要网上自己查找。

更新 electron-updater

接下来还有一个问题，客户安装应用以后，如果有新功能更新，那客户那边如何更新？ 有开源解决方案 electron-updater

先安装依赖 必须安装为运行依赖，否则运行会出错
npm i electron-updater --save

介绍一下原理： 使用electron-updater， 打包后会生成一个latest.yml 的文件，里面包含了版本号等描述信息，
并且 electron-updater 提供了一系列监听事件，允许应用向服务器检测当前版本是否可以更新，
如果可以更新，在对应的监听事件里做了相关处理（下载最新版本，下载完成后退出并重新安装）

流程图如下

接下来把更新的代码加入进去， 在目录下新增一个目录 _main, 里面有两个文件，events.js（定义了事件名称） 和 updater.js （处理接收）

展示下代码：

events.js

// ipc通信事件, main 和 render都会用

export default {
  downLoadUpdate: 'downLoadUpdate', // 手动下载更新
  checkUpdate: 'checkUpdate', // 请求检查更新
  startCheckUpdate: 'startCheckUpdate', // 开始检查更新
  checkUpdateError: 'checkUpdateError', // 检查更新出错
  checkingUpdate: 'checkingUpdate', // 正在检查更新
  updateAvailable: 'updateAvailable', // 有新版本更新
  updateNotAvailable: 'updateNotAvailable', // 没有新版本更新
  updateDownloading: 'updateDownloading', // 正在下载中
  updateDownloaded: 'updateDownloaded' // 下载完成
}

updater.js

import { autoUpdater } from 'electron-updater'
import { ipcMain } from 'electron'
import Events from '@/__main/events'

// 主进程接收渲染进程（页面）派发过来的 检测更新事件
ipcMain.on(Events.checkUpdate, () => {
  // 向服务端查询现在是否有可用的更新。在调用这个方法之前，必须要先调用 setFeedURL
  autoUpdater.checkForUpdates()
})

// 主进程接收渲染进程（页面）派发过来的 下载更新事件
ipcMain.on(Events.downLoadUpdate, () => {
  autoUpdater.downloadUpdate()
})

export function listenUpdater(mainWindow, feedUrl) {
  autoUpdater.autoDownload = false
  autoUpdater.setFeedURL(feedUrl)

  // 当更新发生错误的时候触发
  autoUpdater.on('error', function(error) {
    mainWindow.webContents.send(Events.checkUpdateError, JSON.stringify(error))
  })
  // 当开始检查更新的时候触发
  autoUpdater.on('checking-for-update', function() {
    mainWindow.webContents.send(Events.checkingUpdate)
  })
  // 当发现一个可用更新的时候触发，更新包下载会自动开始
  autoUpdater.on('update-available', function(info) {
    mainWindow.webContents.send(Events.updateAvailable, info)
  })
  // 当没有可用更新的时候触发
  autoUpdater.on('update-not-available', function(info) {
    mainWindow.webContents.send(Events.updateNotAvailable, info)
  })

  // 更新下载进度事件
  autoUpdater.on('download-progress', function(progressObj) {
    mainWindow.webContents.send(Events.updateDownloading, progressObj)
  })

  // 下载完成
  autoUpdater.on('update-downloaded', function() {
    mainWindow.webContents.send(Events.updateDownloaded)
    autoUpdater.quitAndInstall()
  })
}

在background.js 里执行监听

页面收到可更新事件后需要在页面上体现出来， 所以给了一个更新弹出框

每次更新时只需把 exe文件和 latest.yml 文件放到服务器上就行了， 到此更新也已经完成了，具体详情请查阅官网或百度

QA

q： 为什么接入接口会跨越
a： 因为electron 实际上也是浏览器环境，并且有安全检测， 需要在background.js 里 new BrowserWindow 时把 webSecurity 设为false

  const win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: true, // 设置为true 页面可以使用electron api， 如果主进程和渲染进程要通信，必须要设为true
      contextIsolation: false,
      webSecurity: false // 为true时打包后会跨域， 所以设置为false
    }
  })
  
  
q： 页面里使用不了electron api
a： 需要配置  nodeIntegration: true  具体看上面一个问题

总结

执行以下命令
vue create electron-app
vue add electron-builder
npm i electron-updater --save

把配置文件配好，更新逻辑写好，基本上就ok了。（业务逻辑不在教程范围内）