Electron+Vue3+Vite的产品级模板项目

1. electron-vue3-template

基于Vue3 + Electron + TypeScript的客户端程序模板，使用Vite和Electron Forge构建和打包。

真正做到开箱即用，面向跨平台客户端设计，产品级的项目模板。

项目地址：
https://github.com/winsoft666/electron-vue3-template

请添加图片描述

1.1 特性

  • 使用ViteJS构建和驱动前端页面，支持热加载（HMR），使开发和调试变得更加高效 ⚡
  • 支持Vue3多页面，提供页面创建指令，适合客户端开发场景 💖
  • 支持Electron窗口创建指令，并且可隔离不同窗口的IPC事件 💖
  • 封装简化了IPC的调用方式，并提供了IPC函数快速创建指令，主进程与渲染进程的相互调用从未如此简单 👍
  • 主进程和渲染进程支持热加载 ⚡
  • 精选依赖包，提升项目稳定性
  • 代码简洁，易掌控，可定制性强
  • 日志文件，主进程和渲染进程可以直接写文件日志
  • 配置文件
  • 文件下载（含哈希校验、进度反馈），渲染进程可直接异步调用 👍
  • 功能完善的无边框窗口
  • 托盘图标和右键菜单，窗口关闭时程序最小化到托盘
  • 客户端程序单实例
  • 基于ESLint的代码规范和自动格式化
  • 使用Electron官方推荐的Electron Forge进行客户端构建和打包
  • 支持NSIS安装包 😎
  • …

1.2 快速开始 🌈

点击右上角绿色的 Use this template 按钮，使用该模板创建一个新的仓库并克隆到本地。

或者…

直接克隆该项目: git clone https://github.com/winsoft666/electron-vue3-template.git

Visual Studio Code

推荐使用Visual Studio Code进行项目开发，并安装如下插件：

  • ESLint
  • Vue Language Features (Volar)

安装依赖 ⏬

yarn install

开发 ⚒️

yarn run dev

其他命令

yarn run dev # 启动应用并支持热加载
yarn run build # 构建应用，可发布的包位于"out\make"目录# 或者
yarn run build:win32 # 构建Windows平台 32位应用
yarn run build:win64 # 构建Windows平台 64位应用
yarn run build:mac # 构建macOS平台应用
yarn run build:linux # 构建Linux平台应用yarn run new:page  # 创建新的Vue页面
yarn run new:window # 创建新的Electron窗口

更多的可选配置项可以参考 Electron Forge CLI docs。

NSIS安装包 🪟

需要先手动下载和安装NSIS：
https://nsis.sourceforge.io/Download

使用如下命令构建Windows平台 32位应用（如需构建64位应用，则需要手动修改win-setup-x86.nsi脚本）：

yarn run build:win32

运行NSIS安装目录内的makensisw.exe。

依次点击File -> Load Script...，选择并加载本项目的setup\NSIS\win-setup-x86.nsi脚本。

最后，执行Recompile命令即可编译生成安装包。

请添加图片描述

2. 项目介绍

2.1 工程结构 🌳

- scripts/         # 该目录中的脚本用构建应用程序和驱动前端页面
- screenshots      # 本文档中用到的截图
- setup/            # 存储编译和构建相关文件- NSIS/                # NSIS安装包脚本- exe.ico             # 构建后的可执行文件图标（非安装包图标）- install.ico        # NSIS安装包图标- uninstall.ico      # NSIS卸载程序图标
- src/- lib/            # 公共库，为了方便修改，未做成独立的包- file-download/    # 文件下载库- main                 # 仅供主进程使用- renderer            # 仅供渲染进程使用- shared               # 主进程和渲染进程都可以使用- utils/            # 公共代码库- main/           # 主进程的代码 (Electron)- static/          # 静态资源- windows/         # 多窗口文件夹 (每个子目录表示一个窗口)- primary/          # 主窗口（客户端通常都会有一个主窗口）- frameless/        # 无边框示例窗口- ...- renderer/      # 渲染进程的代码 (VueJS)- public           # 静态资源- pages/           # 多页面目录 (强制约定：每个子目录代表一个页面)- primary/          # 主窗口页面- frameless/        # 无边框示例窗口的页面- ...- typings/         # ts声明文件

2.2 使用静态文件

  • src/main/static目录存放主进程使用的静态文件。
  • src/renderer/public目录存放渲染进程使用的静态文件。
在主进程中引用静态文件
// 假设 src/main/static/tray.ico 文件存在
// 使用 appState.mainStaticPath 属性获取主进程的静态文件存储目录
import path from "path";
import appState from "./app-state";const iconPath = path.join(appState.mainStaticPath, "tray.ico");

2.3 AppState对象

为了方便在主进程中跨模块访问某些对象（如primaryWindow、tray、cfgStore等）和应用配置（如onlyAllowSingleInstance等），我们定义了单实例对象AppState来存储这些数据。

使用方法如下：

import appState from "./app-state";appState.primaryWindow?.show();

2.4 快速创建Vue页面

执行如下命令，输入页面名称后将自动在renderer/pages目录创建子页面，每个子页面的相关代码位于单独的目录中，目录名为我们指定的页面名称（小写）。

yarn run new:page

创建的子页面在代码中通过以下方式访问：

// 开发环境
const rendererPort = process.argv[2];
primaryWindow.loadURL(`http://localhost:${rendererPort}/pages/<PAGE-NAME>/index.html`);// 非开发环境
primaryWindow.loadFile(path.join(app.getAppPath(), "build/renderer/pages/<PAGE-NAME>/index.html"));

2.5 快速创建Electron窗口

虽然直接构造Electron的BrowerWindow对象就可以创建新的Electron窗口，但为了方便代码管理和ipcMain消息隔离，本模板中的每个窗口都继承自WindowBase对象，每个窗口的相关代码位于src\main\windows\的不同子目录中，目录名为我们指定的窗口名称（小写）。

yarn run new:window

创建的子窗口默认会访问同名的子页面，可以手动修改代码访问其他页面：

if(process.env.NODE_ENV === "development"){const rendererPort = process.argv[2];primaryWindow.loadURL(`http://localhost:${rendererPort}/pages/primary/index.html`);
}else{primaryWindow.loadFile(path.join(app.getAppPath(), "build/renderer/pages/primary/index.html"));
}

创建窗口后，需要在registerIpcMainHandler方法中注册该窗口的ipcMain事件及处理函数。

如果多个窗口注册了同名的事件，当渲染进程发送该名称的事件到主进程时，所有窗口对象都会收到该事件，为了避免这种情况，我们可以在事件处理函数中使用isIpcMainEventBelongMe方法来过滤非本窗口的事件。

ipcMain.on("message", (event, message) => {if(!this.isIpcMainEventBelongMe(event))return;console.log(message);
});

2.6 快速创建IPC函数

在src\renderer\pages\primary\App.vue中获取文件MD5的代码如下：

async function onGetFileMd5(){const result = await utils.showOpenDialog({properties: [ "openFile" ],filters: [{ name: "All Files", extensions: [ "*" ] }]});if(result.filePaths.length > 0){utils.getFileMd5(result.filePaths[0]).then((md5) => {message.success(md5);}).catch((e) => {message.error(GetErrorMessage(e));});}
}

上述代码通过调用Utils库的showOpenDialog、getFileMd5函数轻松实现了通知主进程选择文件、计算文件MD5并获取相应结果的操作，代码非常简洁。

但是Utils只预置了部分常用的功能，预置功能肯定无法满足我们产品开发的所有需求。在此情况下，我们可以向Utils库中添加自定义的功能函数，该如何添加了？

不用担心，本模板已经提供了IPC函数快速创建指令：

yarn run new:ipc

执行上面指令后，会出现如下提示：

Create syntax: CallWay,FunctionName,FunctionType
Call Way:rm = Renderer process call the function of main processmr = Main process call the function of renderer process (Ignore FunctionType)
Function Name:xxx-xxx-xxx
Function Type:a = Asynchronous call without resultap = Asynchronous call with promise results = Synchronous call with result

参数1（CallWay）表示函数调用方向：

  • rm 表示渲染进程调用主进程的函数，可以支持同步调用、异步调用，并且可以返回Promise结果。
  • mr 表示主进程调用渲染进程的函数，该方向只能是异步调用，而且不支持返回结果，会忽略第三个参数（FunctionType）。

参数2（FunctionName）表示函数名称，函数名称的单词间使用-分隔，如GetFileSha256需要指定为get-file-sha256。

参数3（FunctionType）函数类型：

  • a 表示不返回结果的异步函数
  • ap 表示返回Promise结果的异步函数
  • s 表示同步函数

示例

依次输入如下命令：

yarn run new:ipcInput:
rm,get-file-sha256,ap

命令执行成功后，会自动在src\lib\utils\renderer\index.ts生成Utils.getFileSha256函数：

public async getFileSha256(){return await (window as any).__ElectronUtils__.getFileSha256();
}

自动生成的函数都没有指定参数和返回值，需要我们手动添加，如修改后的函数如下：

public async getFileSha256(filePath: string) : string {return await (window as any).__ElectronUtils__.getFileSha256(filePath) as string;
}

在渲染进程中（如App.vue）中可以直接调用该函数：

import utils from "../../../lib/utils/renderer";const sha256 = await utils.getFileSha256("file-path.txt");

IPC函数创建指令只会创建函数骨架，不会为我们实现具体的功能，我们还需要在主进程ipcMain处理函数中实现计算文件SHA256的具体功能。

自动生成的主进程ipcMain处理函数如下：

ipcMain.handle("electron-utils-get-file-sha256", async(event) => {
});

手动添加参数、返回值，及具体的功能代码（此处省略）：

ipcMain.handle("electron-utils-get-file-sha256", async(event, filePath: string) : Promise<string> => {// .....
});

3. 代码规范

本项目使用ESLint进行代码检查和格式化，没有使用Prettier进行代码格式化。

原因大体如下：

  1. 需要额外的插件和配置来避免ESLint和Prettier的规则冲突。

  2. Prettier的printWidth配置项会损害代码和Git Diff的可读性。
    请添加图片描述
    请添加图片描述

在线演示

4. 依赖包 🎈

4.1 基本原则

一个构建在众多不稳定性因素下的项目，是没有稳定性可言的。

为了保证项目的稳定性，本模板项目只使用具有知名度、稳定性强的依赖包（库），如electron-log等。

对于作者自己写的库（如file-download等），统一以源码形式提供在src\lib\目录，方便模板使用者进行bug修复和功能扩充，在使用时直接采用相对路径进行导入即可。

4.2 dependencies和devDependencies的区别

由于Electron Forge会将dependencies中的所有依赖项都进行打包，因此为了减少安装包的体积，我们只将主进程需要使用的依赖安装到dependencies项下，而其他的依赖均安装到devDependencies。

如将vue作为开发依赖进行安装：

yarn add -D vue

4.3 依赖包说明

作为开发者，应知晓每个依赖包的用途，避免node_modules黑洞的产生。

  • unplugin-vue-components
    实现自动按需引入AntDesign-Vue组件。

  • electron-log
    提供本地日志文件的打印和输出。

  • electron-store
    提供本地配置文件的读取和写入功能。

  • @fortawesome-*
    提供对FontAwesome图标字体的支持。

  • uuid
    使用uuid字符串，在file-download库中使用。

  • chalk
    用于在命令行终端输出带颜色样式的字符串，仅在scripts\*.js中使用。

  • chokidar
    轻量级的文件监控组件，用于实现热加载，仅在scripts\*.js中使用。

  • @electron-forge/*
    与Electron Forge构建和打包相关的依赖包，除了@electron-forge/cli是必须的，其他的可以根据forge.config.js -> makers的配置按需引用。

5. 客户端版本号

使用package.json文件的version字段标识客户端的版本号，在主进程内可以通过appState.appVersion属性获取。

💡 不需要设置forge.config.js文件的appVersion字段。

在渲染进程可以直接使用utils.getAppVersion()获取版本号。

import utils from "../../../lib/utils/renderer";console.log(utils.getAppVersion());

6. 期待你的反馈 🥳

个人能力有限，代码不免有错误和不足之处，欢迎提交issue和PR。

如果这个项目对你有帮助，无需捐助，点击右上角Star ⭐让我知道就可以了。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/449437.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

最短路径 ( floyd) 算法

最短路径 ( floyd) 算法

Floyd算法又称为插点法&#xff0c;是一种用于寻找给定的加权图中多源点之间最短路径的算法。 算法思想: https://upimg.baike.so.com/doc/5450540-5688910.html 图演示: 代码实现: public void floyd() {int[] vertex graph.getVertex();int[][] edges graph.getEdges()…
阅读更多...
京东广告算法架构体系建设--大规模稀疏场景高性能训练方案演变

京东广告算法架构体系建设--大规模稀疏场景高性能训练方案演变

一、前言 京东广告训练框架随着广告算法业务发展的特点也在快速迭代升级&#xff0c;回顾近几年大致经历了两次大版本的方案架构演变。第一阶段&#xff0c;随着2016年Tensorflow训练框架的开源&#xff0c;业界开始基于Tensorflow开源框架训练更复杂的模型。模型对特征规模和…
阅读更多...
jsp粉丝社区系统Myeclipse开发mysql数据库web结构java编程计算机网页项目

jsp粉丝社区系统Myeclipse开发mysql数据库web结构java编程计算机网页项目

一、源码特点 JSP 粉丝社区系统是一套完善的java web信息管理系统&#xff0c;对理解JSP java编程开发语言有帮助&#xff0c;系统具有完整的源代码和数据库&#xff0c;系统主要采用B/S模式开发。开发环境为 TOMCAT7.0,Myeclipse8.5开发&#xff0c;数据库为Mysql5.0&…
阅读更多...
鸿蒙ArkUI实现开关switch组件

鸿蒙ArkUI实现开关switch组件

鸿蒙ArkUI官方提供的toggle组件实现了开关的样式&#xff0c;但在使用过程中还是非常的不方便。 DIY可视化对鸿蒙ArkUI实现开关switch组件扩展后满足基本的switch需求&#xff0c;支持绑定值、设置标题文本、整个背景样式等。 /*** 开关*/ Component export default struct Di…
阅读更多...
conda虚拟环境基础

conda虚拟环境基础

【一文搞定最新版Anaconda】Win11 安装 Anaconda&#xff08;2023.9&#xff09;详解&#xff08;不删除旧版情况下下载、安装、注册、登录、设置环境变量、迁移旧环境、配置修改换源等&#xff09;连接Pycharm_win11安装anaconda-CSDN博客 conda命令大全&#xff08;create/in…
阅读更多...
Linux内存管理：(十一)页面分配之慢速路径

Linux内存管理：(十一)页面分配之慢速路径

文章说明&#xff1a; Linux内核版本&#xff1a;5.0 架构&#xff1a;ARM64 参考资料及图片来源&#xff1a;《奔跑吧Linux内核》 Linux 5.0内核源码注释仓库地址&#xff1a; zhangzihengya/LinuxSourceCode_v5.0_study (github.com) 1. 水位管理和分配优先级 页面分配…
阅读更多...
小程序支付类型接入京东支付

小程序支付类型接入京东支付

一、情景描述 当前项目想在微信小程序付款时添加上京东支付支付类型&#xff0c;效果如下 普通的付款方式可以直接付款就能完成支付&#xff0c;但京东支付无法在小程序上直接付款&#xff0c;他需要复制生成的链接&#xff0c;然后打开京东app然后在京东平台上付款。 所以&…
阅读更多...
网络异常案例六_IP冲突

网络异常案例六_IP冲突

问题现象 同一个局域网下&#xff0c;一个路由器带几十台终端设备&#xff0c;存在终端设备获取到了相同IP的场景。该路由器也是DHCP Server。 有两个设备终端&#xff0c;都显示获取到了192.168.11.177这个ip。 抓包分析 抓包过程中&#xff0c;看到的一些问题。 ps&#x…
阅读更多...
使用ngrok内网穿透

使用ngrok内网穿透

没有服务器和公网IP&#xff0c;想要其他人访问自己做好的网站&#xff0c;使用这款简单免费的内网穿透小工具——ngrok&#xff0c;有了它轻松让别人访问你的项目~ 一、下载ngrok 官网地址&#xff1a;ngrok | Unified Application Delivery Platform for Developers&#x…
阅读更多...
[N-137]基于springboot,vue运动会报名管理系统

[N-137]基于springboot,vue运动会报名管理系统

开发工具&#xff1a;IDEA 服务器&#xff1a;Tomcat9.0&#xff0c; jdk1.8 项目构建&#xff1a;maven 数据库&#xff1a;mysql5.7 项目采用前后端分离 前端技术&#xff1a;vueAvueElementUI 服务端技术&#xff1a;springbootmybatis 本项目分为用户和管理员两种角…
阅读更多...
07 SB3之@HttpExchange(TBD)

07 SB3之@HttpExchange(TBD)

HttpExchange是SpringBoot3的新特性. Spring Boot3 提供了新的 HTTP 的访问能力&#xff0c;封装了Http底层细节. 通过接口简化 HTTP远程访问&#xff0c;类似 Feign 功能。 SpringBoot 中定义接口提供 HTTP 服务 --> 框架生成的代理对象实现此接口 --> 框架生成的代理…
阅读更多...
Docker 阿里云镜像仓库CR使用实践

Docker 阿里云镜像仓库CR使用实践

一、使用容器镜像&#xff0c;查看镜像&#xff0c;创建&#xff0c;推送&#xff0c;拉取阿里云镜像 CR镜像管理&#xff08;阿里云容器镜像服务&#xff08;Container Registry&#xff09;&#xff09; 登录实例 未创建的镜像名称也可以push、docker的私有仓库需要提起创建…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023