Electron.js

前往官网

使用vite初始化项目

安装

npm init vite // >>Vue >>TypeScript

npm i // 安装依赖

npm i electron -D // 安装Electron

npm i vite-plugin-electron -D // 安装vite-electron 插件 让vite支持electron

npm i cross-env // 让vite支持env

创建electron入口文件

根目录创建 "electron/index.ts" 入口文件

import { app, BrowserWindow } from "electron";
import path from 'path'

const createWindow = () => {
  const win = new BrowserWindow({
    webPreferences: {
      nodeIntegration: true, //node集成，可以调用node语法
      contextIsolation: false,
    },
  });
    // app.isPackaged如果是打包就加载静态文件 但是有bug，所以换另一种方式
    // 因为安装了cross-env 所以改成 process.env.NODE_ENV != 'development'
  if(process.env.NODE_ENV != 'development'){ 
    win.loadFile(path.join(__dirname,"../index.html"))
  }else{ // 如果不是就访问url
    win.loadURL(`${process.env["VITE_DEV_SERVER_URL"]}`);
  }
};
app.whenReady().then(createWindow);

修改 vite.config.ts

引入electron插件配置entry对应electron的文件

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

import electron from 'vite-plugin-electron'


export default defineConfig({
  plugins: [vue(),electron({
    entry: "electron/index.ts" // 配置electron入口文件
  })]
})

修改package.json

运行时会在根目录创建 dist-electron 或 dist/electron文件夹

删除 package.json 文件中的 "type": "module", 换成 "main":"dist-electron/index.js",

打包项目

1.打包需要安装 npm i electron-builder -D

2.修改 package.json 文件的 build 在后面添加 && electron-builder

"build": "vue-tsc && vite build && electron-builder",

{
  "name": "electron-vite-demo",
  "private": true,
  "version": "0.0.0",
  "main": "dist-electron/index.js",
  "scripts": {
    "dev": "vite",
    "build": "vue-tsc && vite build && electron-builder",
    "preview": "vite preview"
  },
  "dependencies": {
    "electron": "^21.2.0",
    "vue": "^3.2.41"
  },
  "devDependencies": {
    "@vitejs/plugin-vue": "^3.2.0",
    "electron-builder": "^23.6.0",
    "typescript": "^4.6.4",
    "vite": "^3.2.0",
    "vite-plugin-electron": "^0.10.2",
    "vue-tsc": "^1.0.9"
  },
  "build": {
    "appId": "com.electron.desktop",
    "productName": "electron",
    "asar": true,
    "copyright": "Copyright © 2022 electron",
    "directories": {
      "output": "release/"
    },
    "files": [
      "dist"
    ],
    "mac": {
      "artifactName": "${productName}_${version}.${ext}",
      "target": [
        "dmg"
      ]
    },
    "win": {
      "target": [
        {
          "target": "nsis",
          "arch": [
            "x64"
          ]
        }
      ],
      "artifactName": "${productName}_${version}.${ext}"
    },
    "nsis": {//应用程序安装过程配置
      "oneClick": false,
      "perMachine": false,
      "allowToChangeInstallationDirectory": true,
      "deleteAppDataOnUninstall": false
    },
    "publish": [
      {
        "provider": "generic",
        "url": "http://127.0.0.1:8080"
      }
    ],
    "releaseInfo": {
      "releaseNotes": "版本更新的具体内容"
    }
  }
}

打包的nsis详细配置

{"oneClick": false, // 创建一键安装程序还是辅助安装程序（默认是一键安装）
    "allowElevation": true, // 是否允许请求提升，如果为false，则用户必须使用提升的权限重新启动安装程序 （仅作用于辅助安装程序）
    "allowToChangeInstallationDirectory": true, // 是否允许修改安装目录 （仅作用于辅助安装程序）
    "installerIcon": "public/timg.ico",// 安装程序图标的路径
    "uninstallerIcon": "public/timg.ico",// 卸载程序图标的路径
    "installerHeader": "public/timg.ico", // 安装时头部图片路径（仅作用于辅助安装程序）
    "installerHeaderIcon": "public/timg.ico", // 安装时标题图标（进度条上方）的路径（仅作用于一键安装程序）
    "installerSidebar": "public/installerSiddebar.bmp", // 安装完毕界面图片的路径，图片后缀.bmp，尺寸164*314 （仅作用于辅助安装程序）
    "uninstallerSidebar": "public/uninstallerSiddebar.bmp", // 开始卸载界面图片的路径，图片后缀.bmp，尺寸164*314 （仅作用于辅助安装程序）
    "uninstallDisplayName": "${productName}${version}", // 控制面板中的卸载程序显示名称
    "createDesktopShortcut": true, // 是否创建桌面快捷方式
    "createStartMenuShortcut": true,// 是否创建开始菜单快捷方式
    "shortcutName": "SHom", // 用于快捷方式的名称，默认为应用程序名称
    "include": "script/installer.nsi",  // NSIS包含定制安装程序脚本的路径，安装过程中自行调用  (可用于写入注册表 开机自启动等操作)
    "script": "script/installer.nsi",  // 用于自定义安装程序的NSIS脚本的路径
    "deleteAppDataOnUninstall": false, // 是否在卸载时删除应用程序数据（仅作用于一键安装程序）
    "runAfterFinish": true,  // 完成后是否运行已安装的应用程序（对于辅助安装程序，应删除相应的复选框）
    "menuCategory": false, // 是否为开始菜单快捷方式和程序文件目录创建子菜单，如果为true，则使用公司名称
}