vue-cli3+Electron


注意:我这里使用的是vuecli3。之前的版本可以参考electron-vue 起步。

一、 创建项目

  1. 创建vue项目。
    参考我之前的文章vue 之 vue-cli3,创建项目。这里我创建的项目是electron-vue-test
  2. 安装electron,自动安装和手动安装任选其一。
    2.1 自动安装,进入到项目根目录,执行:vue add electron-builder,然后选择electron版本。

    这时候我们会发现src目录下多了以下两个文件:

    package.json多了以下命令行

    2.2 手动安装 。
    修改package.json,参考自动安装package.json截图,添加以下命令行:
"scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint",
    "electron:build": "vue-cli-service electron:build", //添加
    "electron:serve": "vue-cli-service electron:serve", //添加
    "postinstall": "electron-builder install-app-deps", //添加
    "postuninstall": "electron-builder install-app-deps" //添加
},
"main": "background.js", //添加

src目录下新建`background.js·,复制以下代码:

'use strict'
import { app, protocol, BrowserWindow } from 'electron'
import { createProtocol } from 'vue-cli-plugin-electron-builder/lib'
import installExtension, { VUEJS_DEVTOOLS } from 'electron-devtools-installer'
const isDevelopment = process.env.NODE_ENV !== 'production'

// Scheme must be registered before the app is ready
protocol.registerSchemesAsPrivileged([
  { scheme: 'app', privileges: { secure: true, standard: true } }
])

async function createWindow() {
  // Create the browser window.
  const win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {

      // Use pluginOptions.nodeIntegration, leave this alone
      // See nklayman.github.io/vue-cli-plugin-electron-builder/guide/security.html#node-integration for more info
      nodeIntegration: process.env.ELECTRON_NODE_INTEGRATION,
      contextIsolation: !process.env.ELECTRON_NODE_INTEGRATION
    }
  })

  if (process.env.WEBPACK_DEV_SERVER_URL) {
    // Load the url of the dev server if in development mode
    await win.loadURL(process.env.WEBPACK_DEV_SERVER_URL)
    if (!process.env.IS_TEST) win.webContents.openDevTools()
  } else {
    createProtocol('app')
    // Load the index.html when not in development
    win.loadURL('app://./index.html')
  }
}

// Quit when all windows are closed.
app.on('window-all-closed', () => {
  // On macOS it is common for applications and their menu bar
  // to stay active until the user quits explicitly with Cmd + Q
  if (process.platform !== 'darwin') {
    app.quit()
  }
})

app.on('activate', () => {
  // On macOS it's common to re-create a window in the app when the
  // dock icon is clicked and there are no other windows open.
  if (BrowserWindow.getAllWindows().length === 0) createWindow()
})

// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs.
app.on('ready', async () => {
  if (isDevelopment && !process.env.IS_TEST) {
    // Install Vue Devtools
    try {
      await installExtension(VUEJS_DEVTOOLS)
    } catch (e) {
      console.error('Vue Devtools failed to install:', e.toString())
    }
  }
  createWindow()
})

// Exit cleanly on request from parent process in development mode.
if (isDevelopment) {
  if (process.platform === 'win32') {
    process.on('message', (data) => {
      if (data === 'graceful-exit') {
        app.quit()
      }
    })
  } else {
    process.on('SIGTERM', () => {
      app.quit()
    })
  }
}

3.background.js中关于electron一些api方法的使用,参考我之前文章Electron开发跨平台桌面应用。

  1. electron安装完成后,重新安装依赖npm i或者cnpm i

二、编译运行
运行npm run electron:serve;


如图,会先运行编译vue,然后编译electron,编译electron时间比较常会提示几次失败,内心等候即可。编译完成效果图:

三、打包

  1. 设置APP窗口图标。
    1.1 准备windows和macOS两版图标。
    windows: app.ico 最小尺寸:256x256
    macOS: app.png或app.icns 最小尺寸:512x512


    app.png

    1.2 把图标文件放到public/目录下,项目结构如下:



    1.3 修改background.js,让APP窗口应用图标:
async function createWindow() {
  // Create the browser window.
  const win = new BrowserWindow({
    // ...其他代码
    // 添加这行代码
    icon: `${__static}/app.ico`
  })
 // ...其他代码
}
效果图

Windows系统上直接在开发环境可以看到APP窗口图标已经生效了(macOS图标参照下面设置APP及安装包图标,并且需要在build后才能生效)。

  1. 设置APP窗口标题栏名称。
    修改public/index.html中的title标签。

electron-vue
效果图
  1. 设置APP安装包图标、名称、平台。
    修改vue.config.js:如下:
module.exports = {
  // ...其他代码
  pluginOptions: {
    electronBuilder: {
      builderOptions: {
        // 设置app名称
        productName: 'electron-vue',
        mac: {
          // 设置mac平台app图标
          icon: './public/app.png'
        },
        win: {
          // 设置win平台app图标
          icon: './public/app.ico',
          target: [
            {
              target: 'nsis',//利用nsis制作安装程序
              arch: [
                'x64',//64位
                'ia32'//32位
              ]
            }
          ],
        },
        nsis: {
          // oneClick: false, // 是否一键安装
          // allowElevation: true, // 允许请求提升。 如果为false,则用户必须使用提升的权限重新启动安装程序。
          // allowToChangeInstallationDirectory: true, // 允许修改安装目录
          // installerIcon: "./public/logo.ico",// 安装图标
          // uninstallerIcon: "./public/logo.ico",//卸载图标
          // installerHeaderIcon: "./public/logo.ico", // 安装时头部图标
          // createDesktopShortcut: true, // 创建桌面图标
          // createStartMenuShortcut: true,// 创建开始菜单图标
          // shortcutName: "taskmanage", // 图标名称
        },
      }
    }
  },
  // ...其他代码
}
  1. 打包。
    运行npm run electron:build,运行完成以后会生成下面的文件:

    其中win-ia32-unpacked为32位免安装版,win-unpacked为64位免安装版。
    32位免安装版目录
    32位免安装版运行效果
    64位免安装版目录
    64位免安装版运行效果
可以发现64位的exe图标不对,这个后期会发布修复方法。

参考文章:
vue 之 vue-cli3
Electron开发跨平台桌面应用
手把手教你使用Electron5+vue-cli3开发跨平台桌面应用

你可能感兴趣的:(vue-cli3+Electron)