基于vue3.0+electron新开窗口|Electron多开窗体|父子模态窗口

时间 2021-02-15

标签 html vue node git github web vue-cli npm windows api 栏目 HTML 繁體版

原文原文链接

最近一直在折腾Vue3+Electron技术结合的实践，今天就来分享一些vue3.x和electron实现开启多窗口功能。html

开始本文以前，先来介绍下如何使用vue3和electron来快速搭建项目。vue

目前electron.js的star高达89.3K+，最新稳定版v11.2.3。node

使用vue开发electron应用，网上有个比较火的脚手架electron-vue，不过里面的版本过低，并且使用的是vue2.x语法。git

今天主要分享的是vue3语法开发electron应用，因此只能手动搭建开发环境。github

安装最新Vue CLI脚手架。

npm install -g @vue/cli web

新建vue3项目

具体的选项配置，你们根据须要勾选。vue-cli

vue create vue3_electron npm

vue3项目中集成electron

安装vue-cli-plugin-electron-builder插件。windows

cd vue3_electron api

vue add electron-builder

以后的安装过程当中会提示安装electron版本，选择最新版安装就行。

开发调试/打包构建

npm run electron:serve

npm run electron:build

很是简单，没有几步就能快速手动搭建vue3+electron项目，下面就能愉快的开发了。

通常项目中须要新建多开窗口的功能，使用Electron来建立也是很是简单的。通常的实现方法是 new BrowserWindow({...}) 窗口，传入参数配置便可快速新建一个窗口。

<body>
    <button id="aaa">打开A窗口</button>
    <button id="bbb">打开B窗口</button>
    <button id="ccc">打开C窗口</button>
</body>

<script>
    import path from 'path'
    import { remote } from 'electron'
    
    let BrowserWindow = remote.BrowserWindow;
    
    let winA = null;
    let winB = null;
    let winC = null;
    
    document.getElementById("aaa").onclick = function(){
        winA = new BrowserWindow ({width: 1000, height:800})
        winA.loadURL("https://aaa.com/");
        winA.on("close", function(){
            winA = null;
        })
    }
    
    document.getElementById("bbb").onclick = function(){
        winB = new BrowserWindow ({width: 900, height:650})
        winB.loadURL("https://bbb.com/");
        winB.on("close", function(){
            winB = null;
        })
    }
    
    document.getElementById("ccc").onclick = function(){
        winC = new BrowserWindow ({width: 500, height:500})
        winC.loadURL(`file://${__dirname}/news.html`);
        winC.on("close", function(){
            winC = null;
        })
    }
</script>

具体的参数配置，你们能够去查阅文档，electron官网中都有很是详细的说明。

https://www.electronjs.org/docs/api/browser-window

可是这种方法每次都要新建一个BrowserWindow，有些挺麻烦的，能不能像下面代码片断这样，直接经过一个函数，而后传入配置参数生成新窗口，显然是能够的。

windowCreate({
      title: '管理页面',
      route: '/manage?id=123',
      width: 750,
      height: 500,
      backgroundColor: '#f9f9f9',
      resizable: false,
      maximize: true,
      modal: true,
})

background.js配置

'use strict'

import { app, BrowserWindow } from 'electron'
const isDevelopment = process.env.NODE_ENV !== 'production'

import { Window } from './windows'

async function createWindow() {
  let window = new Window()
  
  window.listen()
  window.createWindows({isMainWin: true})
  window.createTray()
}

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

app.on('activate', () => {
  if (BrowserWindow.getAllWindows().length === 0) createWindow()
})

app.on('ready', async () => {
  createWindow()
})

if (isDevelopment) {
  if (process.platform === 'win32') {
    process.on('message', (data) => {
      if (data === 'graceful-exit') {
        app.quit()
      }
    })
  } else {
    process.on('SIGTERM', () => {
      app.quit()
    })
  }
}

新建一个 window.js 来处理主进程全部的函数。

import { app, BrowserWindow, ipcMain, Menu, Tray } from "electron";
import { createProtocol } from 'vue-cli-plugin-electron-builder/lib'
import path from 'path'

export const windowsCfg = {
    id: '', //惟一id
    title: '', //窗口标题
    width: '', //宽度
    height: '', //高度
    minWidth: '', //最小宽度
    minHeight: '', //最小高度
    route: '', // 页面路由URL '/manage?id=123'
    resizable: true, //是否支持调整窗口大小
    maximize: false, //是否最大化
    backgroundColor:'#eee', //窗口背景色
    data: null, //数据
    isMultiWindow: false, //是否支持多开窗口 (若是为false，当窗体存在，再次建立不会新建一个窗体 只focus显示便可，，若是为true，即便窗体存在，也能够新建一个)
    isMainWin: false, //是否主窗口(当为true时会替代当前主窗口)
    parentId: '', //父窗口id  建立父子窗口 -- 子窗口永远显示在父窗口顶部 【父窗口能够操做】
    modal: false, //模态窗口 -- 模态窗口是禁用父窗口的子窗口，建立模态窗口必须设置 parent 和 modal 选项 【父窗口不能操做】
}

/**
 * 窗口配置
 */
export class Window {
    constructor() {
        this.main = null; //当前页
        this.group = {}; //窗口组
        this.tray = null; //托盘
    }

    // 窗口配置
    winOpts(wh=[]) {
        return {
            width: wh[0],
            height: wh[1],
            backgroundColor: '#f00',
            autoHideMenuBar: true,
            titleBarStyle: "hidden",
            resizable: true,
            minimizable: true,
            maximizable: true,
            frame: false,
            show: false,
            webPreferences: {
                contextIsolation: false, //上下文隔离
                // nodeIntegration: true, //启用Node集成（是否完整的支持 node）
                nodeIntegration: process.env.ELECTRON_NODE_INTEGRATION,
                // devTools: false,
                webSecurity: false,
                enableRemoteModule: true, //是否启用远程模块（即在渲染进程页面使用remote）
            }
        }
    }

    // 获取窗口
    getWindow(id) {
        return BrowserWindow.fromId(id)
    }

    // 获取所有窗口
    getAllWindows() {
        return BrowserWindow.getAllWindows()
    }

    // 建立窗口
    createWindows(options) {
        console.log('------------开始建立窗口...')

        console.log(options)

        let args = Object.assign({}, windowsCfg, options)
        console.log(args)

        // 判断窗口是否存在
        for(let i in this.group) {
            if(this.getWindow(Number(i)) && this.group[i].route === args.route && !this.group[i].isMultiWindow) {
                this.getWindow(Number(i)).focus()
                return
            }
        }

        let opt = this.winOpts([args.width || 800, args.height || 600])
        if(args.parentId) {
            console.log('parentId：' + args.parentId)
            opt.parent = this.getWindow(args.parentId)
        } else if(this.main) {
            console.log(666)
        }

        if(typeof args.modal === 'boolean') opt.modal = args.modal
        if(typeof args.resizable === 'boolean') opt.resizable = args.resizable
        if(args.backgroundColor) opt.backgroundColor = args.backgroundColor
        if(args.minWidth) opt.minWidth = args.minWidth
        if(args.minHeight) opt.minHeight = args.minHeight

        console.log(opt)
        let win = new BrowserWindow(opt)
        console.log('窗口id：' + win.id)
        this.group[win.id] = {
            route: args.route,
            isMultiWindow: args.isMultiWindow,
        }
        // 是否最大化
        if(args.maximize && args.resizable) {
            win.maximize()
        }
        // 是否主窗口
        if(args.isMainWin) {
            if(this.main) {
                console.log('主窗口存在')
                delete this.group[this.main.id]
                this.main.close()
            }
            this.main = win
        }
        args.id = win.id
        win.on('close', () => win.setOpacity(0))

        // 打开网址（加载页面）
        /**
         * 开发环境: http://localhost:8080
         * 正式环境: app://./index.html
         */
        let winURL
        if (process.env.WEBPACK_DEV_SERVER_URL) {
            // Load the url of the dev server if in development mode
            // win.loadURL(process.env.WEBPACK_DEV_SERVER_URL)
            winURL = args.route ? `http://localhost:8080${args.route}` : `http://localhost:8080`
            // 打开开发者调试工具
            // if (!process.env.IS_TEST) win.webContents.openDevTools()
        } else {
            createProtocol('app')
            // Load the index.html when not in development
            // win.loadURL('app://./index.html')
            winURL = args.route ? `app://./index.html${args.route}` : `app://./index.html`
        }
        win.loadURL(winURL)

        win.once('ready-to-show', () => {
            win.show()
        })

        // 屏蔽窗口菜单（-webkit-app-region: drag）
        win.hookWindowMessage(278, function(e){
            win.setEnabled(false)
            setTimeout(() => {
                win.setEnabled(true)
            }, 100)

            return true
        })
    }

    // 关闭全部窗口
    closeAllWindow() {
        for(let i in this.group) {
            if(this.group[i]) {
                if(this.getWindow(Number(i))) {
                    this.getWindow(Number(i)).close()
                } else {
                    console.log('---------------------------')
                    app.quit()
                }
            }
        }
    }

    // 建立托盘
    createTray() {
        console.log('建立托盘')
        const contextMenu = Menu.buildFromTemplate([
            {
                label: '显示',
                click: () => {
                    for(let i in this.group) {
                        if(this.group[i]) {
                            // this.getWindow(Number(i)).show()
                            let win = this.getWindow(Number(i))
                            if(!win) return
                            if(win.isMinimized()) win.restore()
                            win.show()
                        }
                    }
                }
            }, {
                label: '退出',
                click: () => {
                    app.quit()
                }
            }
        ])
        console.log(__dirname)
        const trayIco = path.join(__dirname, '../static/logo.png')
        console.log(trayIco)
        this.tray = new Tray(trayIco)
        this.tray.setContextMenu(contextMenu)
        this.tray.setToolTip(app.name)
    }


    // 开启监听
    listen() {
        // 关闭
        ipcMain.on('window-closed', (event, winId) => {
            if(winId) {
                this.getWindow(Number(winId)).close()
                if(this.group[Number(winId)]) delete this.group[Number(winId)]
            } else {
                this.closeAllWindow()
            }
        })

        // 隐藏
        ipcMain.on('window-hide', (event, winId) => {
            if(winId) {
                this.getWindow(Number(winId)).hide()
            } else {
                for(let i in this.group) if(this.group[i]) this.getWindow(Number(i)).hide()
            }
        })

        // 显示
        ipcMain.on('window-show', (event, winId) => {
            if(winId) {
                this.getWindow(Number(winId)).show()
            } else {
                for(let i in this.group) if(this.group[i]) this.getWindow(Number(i)).show()
            }
        })

        // 最小化
        ipcMain.on('window-mini', (event, winId) => {
            if(winId) {
                this.getWindow(Number(winId)).minimize()
            } else {
                for(let i in this.group) if(this.group[i]) this.getWindow(Number(i)).minimize()
            }
        })

        // 最大化
        ipcMain.on('window-max', (event, winId) => {
            if(winId) {
                this.getWindow(Number(winId)).maximize()
            } else {
                for(let i in this.group) if(this.group[i]) this.getWindow(Number(i)).maximize()
            }
        })

        // 最大化/最小化
        ipcMain.on('window-max-min-size', (event, winId) => {
            if(winId) {
                if(this.getWindow(winId).isMaximized()) {
                    this.getWindow(winId).unmaximize()
                }else {
                    this.getWindow(winId).maximize()
                }
            }
        })

        // 还原
        ipcMain.on('window-restore', (event, winId) => {
            if(winId) {
                this.getWindow(Number(winId)).restore()
            } else {
                for(let i in this.group) if(this.group[i]) this.getWindow(Number(i)).restore()
            }
        })

        // 从新加载
        ipcMain.on('window-reload', (event, winId) => {
            if(winId) {
                this.getWindow(Number(winId)).reload()
            } else {
                for(let i in this.group) if(this.group[i]) this.getWindow(Number(i)).reload()
            }
        })

        // 建立窗口
        ipcMain.on('window-new', (event, args) => this.createWindows(args))
    }
}

而后新建一个 plugins.js 文件，用来封装一些调用方法。

/**
 * 建立窗口
 */
export function windowCreate(args) {
    console.log(args)
    ipcRenderer.send('window-new', args)
}

/**
 * 关闭窗口
 */
export function windowClose(id) {
    console.log('窗口id：' + id)
    ipcRenderer.send('window-closed', id)
}

// ...

在.vue页面引入plugins.js，执行建立窗口方法。

<template>
    <div class="app">
        <h1>This is an new page</h1>
        <img src="@assets/v3-logo.png" width="100" alt="">
        <p class="mt-10"><a-button type="primary" @click="handleNewWin1">新窗口1</a-button></p>
        <p class="mt-10"><a-button type="primary" @click="handleNewWin2">新窗口2</a-button></p>
    </div>
</template>

<script>
import {windowClose, windowCreate} from '@/plugins'

export default {
    setup() {
        const handleNewWin1 = () => {
            windowCreate({
                title: '管理页面',
                route: '/manage',
                width: 1000,
                height: 750,
                backgroundColor: '#f9f9f9',
                resizable: true,
                modal: true,
                maximize: true,
            })
        }
        
        const handleNewWin2 = () => {
            windowCreate({
                title: '关于页面',
                route: '/about?id=13',
                width: 750,
                height: 450,
                backgroundColor: '#f90',
                resizable: false,
            })
        }
        
        ...

        return {
            handleNewWin1,
            handleNewWin2,
            ...
        }
    }
}
</script>

一些小踩坑记录

一、建立托盘图标，一开始图标一直不显示，觉得__dirname指向src目录，最后调试发现原来是指向dist_electron

console.log(__dirname)
let trayIco = path.join(__dirname, '../static/logo.png')
console.log(trayIco)

let trayIco = path.join(__dirname, '../static/logo.png')
let tray = new Tray(trayIco)

这样就能加载本地图片，显示托盘图标了。

二、设置自定义拖拽 -webkit-app-region: drag 没法响应点击事件，没法禁用右键菜单。

当窗体设置frame: false后，能够经过-webkit-app-region: drag来实现自定义拖动，设置后的拖动区域没法响应其它事件，能够给须要点击的连接或者按钮设置-webkit-app-region: no-drag来实现。

不过还有一个问题，设置-webkit-app-region: drag后，会出现以下图系统右键菜单。

最后通过一番调试，能够经过下面这个方法简单禁用掉，亲测有效~~

win.hookWindowMessage(278, function(e){
    win.setEnabled(false)
    setTimeout(() => {
        win.setEnabled(true)
    }, 150)
    
    return true
})

ok，以上就是基于vue3.x+electron实现多开窗口的思路，但愿对你们有些帮助！😃

最后附上一个vite2开发的vue3+vant3.x短视频实例项目

http://www.javashuo.com/article/p-syjvfacu-ve.html