手把手教你如何新建一个vue3+electron项目

参考文章

手把手教你如何新建一个vue3+electron项目_搭建一个vue3+electron的项目-CSDN博客

安装 | electron-egg (kaka996.com)

其中遇到问题,特记录如下。

ES6模式报错

App threw an error during load

ReferenceError: require is not defined in ES module scope, you can use import instead

This file is being treated as an ES module because it has a '.js' file extension and 'D:\vs2024proj\electron_vite_ts_demo_sunny\electron-vite-demo-sunny\package.json' contains "type": "module". To treat it as a CommonJS script, rename it to use the '.cjs' file extension.

ES6模式下不能使用require。解决办法更改package.json,删除 "type": "module".

引入main.js后报错



ES6模式下不能使用require。解决办法更改package.json,删除 "type": "module".


引入electon

屏蔽告警信息

参考 Electron Security Warning (Insecure Content-Security-Policy) 告警解决-CSDN博客

使用了方法一和方法二。

方式一:index.html文件里设置安全策略

在HTML主文件的头部引入安全策略的设置,采用如下设置,Electron的控制台就不会显示告警了:

<meta http-equiv="Content-Security-Policy" content="default-src 'self' 'unsafe-inline';">

方式二:main.js文件里屏蔽安全告警

在Electron工程启动文件main.js的头部设置以下内容,也可以屏蔽安全告警在console控制台的显示:

process.env['ELECTRON_DISABLE_SECURITY_WARNINGS'] = 'true';

至此第二步完成。

三、加入electron预加载脚本,并通过其进行electron和vue的交互

通讯


主进程与渲染进程通讯

/preload/index.js文件代码如下:

-------------------------------

const { contextBridge, ipcRenderer } = require('electron')

const handleSend = async (vue_params) => {

  let fallback = await ipcRenderer.invoke('sent-event', vue_params)

  return fallback

}

 // 暴漏函数,能暴露的不仅仅是函数,我们还可以暴露变量

contextBridge.exposeInMainWorld('myApi', {

  handleSend: handleSend,

  setTitle: (title) => ipcRenderer.send('set-title', title) ,

  openFile: () => ipcRenderer.invoke('dialog:openFile')

})

-----------------------------------

主进程main.js源码

-------------------------


const { app, BrowserWindow,ipcMain,dialog } = require('electron')

const path = require('path');

process.env['ELECTRON_DISABLE_SECURITY_WARNINGS'] = 'true'; //屏蔽安全告警

const createWindow = () => {

  const win = new BrowserWindow({

    width: 800,

    height: 600,

    webPreferences: {

      preload: path.join(__dirname, './preload/index.js')

    }


  })

  // win.loadFile('index.html')


  // 下面的url为自己启动vite项目的url。

  win.loadURL('http://127.0.0.1:5173/')

  // 打开electron的开发者工具

  win.webContents.openDevTools({ mode: 'detach' })

}

ipcMain.handle('sent-event', (event,params) => {

  console.log(params)

  return '1111'

})

// 渲染进程中更改标题

const handleSetTitle = (event, title) => {

  const webContents = event.sender

  const win = BrowserWindow.fromWebContents(webContents)

  win.setTitle(title)

}

ipcMain.on('set-title', handleSetTitle)

//打开文件

async function handleFileOpen() {

  const { canceled, filePaths } = await dialog.showOpenDialog()

  if (canceled) {

    return

  } else {

    return filePaths[0] // 返回文件名给渲染进程

  }

}

ipcMain.handle('dialog:openFile', handleFileOpen)

app.whenReady().then(() => {

  createWindow()

  app.on('activate', () => {

    if (BrowserWindow.getAllWindows().length === 0) createWindow()

  })

})

app.on('window-all-closed', () => {

  if (process.platform !== 'darwin') {

    app.quit()

  }

})

------------------------

vue中调用方法

----------------------------------

<template>

<div class="ipc-test-view">    

    <button @click="onSendTile">进程通讯测试</button>

    <button @click="onOpenFile">打开文件</button>  

    <div>{{fileName}}</div>  

</div>

</template>

<script setup>

 import { ref, reactive } from 'vue'

 const fileName=ref('')

const onSendTile = ()=>{

    const title ='11111'

    window.myApi?.setTitle(title)

}

   async function onOpenFile () {

    const filePath = await window.myApi?.openFile()

  console.log(filePath);

  fileName.value = filePath;

}

</script>

<style scoped>

.ipc-test-view{

    border:solid 1px pink;

    width: 300px;

    height: 300px;;

}

</style>


--------------------------------------

四、优化开发体验

1. 安装nodemon依赖

2. 更改启动配置,在package.json中的scripts添加这句进行启动electron项目,nodemon在检测到有以.js,.html结尾文件发生变动时,就会重启窗口。

"start": "nodemon --exec electron . --watch ./ --ext .js,.html"




热启动测试


五 vite + vue3 + Antd 搭建后台管理系统

npm install ant-design-vue --save

更改 /src/main.ts

-------------------------------------

import './assets/main.css'

import { createApp } from 'vue'

import { createPinia } from 'pinia'

import App from './App.vue'

import router from './router'

import Antd from "ant-design-vue";

import 'ant-design-vue/dist/antd.css';

const app = createApp(App)

app.use(Antd)

app.use(createPinia())

app.use(router)

app.mount('#app')

------------------------------------------

七、自定义窗口(不使用原生的窗口)

八、项目打包

--------------------------------------------------

"build": {

    "appId": "com.zm666.desktop",//包名 

    "productName": "electron测试", //项目名 这也是生成的exe文件的前缀名

    "asar": true,

    "copyright": "Copyright © 2023 electron",//版权  信息

    "publish": {

      "provider": "generic",// 服务器提供商 也可以是GitHub等等

      "url": ""// 服务器地址

    },

    "directories": { // 输出文件夹

      "output": "electron-build/"

    },

    "extraResources": [

      {

        "from": "./public",

        "to": "./public"

      }

    ],

    "files": [ // 打包的electron需要包含的文件,一般就是与electron的有关的打包进去

      "main.js", // electron主入口文件

      "controller", // 也是主入口文件,只不过拆成了两个文件

      "preload" //预加载文件

    ],

    "mac": {

      "artifactName": "${productName}_${version}.${ext}",

      "target": [

        "dmg"

      ]

    },

    "win": {

      "icon": "public/logoTemplate.ico",

      "target": [

        {

          "target": "nsis",

          "arch": [

            "ia32"

          ]

        }

      ],

      "artifactName": "${productName}_${version}.${ext}"

    },

    "nsis": {

      "oneClick": false,// 是否一键安装

      "perMachine": false,

      "allowToChangeInstallationDirectory": true,// 允许修改安装目录

      "deleteAppDataOnUninstall": false,

      "installerIcon": "public/favicon.ico",// 安装图标

      "uninstallerIcon": "public/favicon.ico",// 创建桌面图标

      "createDesktopShortcut": true,// 创建桌面图标

      "createStartMenuShortcut": true,// 创建开始菜单图标

      "shortcutName": "zm666测试平台" // 图标名称

    },

    "releaseInfo": {

      "releaseNotes": "版本更新的具体内容"

    }

  }

------------------------------------------------------

• downloading url=https://registry.npmmirror.com/-/binary/electron/28.2.0/electron-v28.2.0-win32-ia32.zip

size=94 MB parts=8

  • downloaded      url=https://registry.npmmirror.com/-/binary/electron/28.2.0/electron-v28.2.0-win32-ia32.zip

duration=2.113s

第一次下载包报错了。

然后我使用这个网络连接https://registry.npmmirror.com/-/binary/electron/28.2.0/electron-v28.2.0-win32-ia32.zip下载了这个包,但是不知道往哪里放。

最后想到一个方法,打开优途加速器,连接快速通道,包就下载成功了。



本地路径


打包成功了。


打包成功
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容