Electron-Vite-Vue 项目中实现多窗口不同预加载脚本的解决方案

背景介绍

在 Electron 应用开发中，预加载脚本(preload)是一个非常重要的概念。它允许我们在主进程和渲染进程之间建立安全的通信桥梁。然而，当我们需要为应用中的不同窗口配置不同的预加载脚本时，可能会遇到一些挑战。

问题核心

许多开发者在使用 Electron-Vite-Vue 构建多窗口应用时，希望为每个窗口指定不同的预加载脚本。这在实际业务场景中很常见，比如：

• 主窗口需要一套特定的 API 暴露给渲染进程
• 设置窗口可能需要另一组不同的 API
• 某些特殊功能窗口需要特定的预加载逻辑

解决方案

基础实现方式

在 Electron 中，我们可以通过为每个 BrowserWindow 实例单独指定 preload 路径来实现这一需求：

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

// 创建第一个窗口，使用 preload1.js
function createMainWindow() {
  const mainWin = new BrowserWindow({
    webPreferences: {
      preload: path.join(__dirname, 'preload/main.js')
    }
  })
  mainWin.loadFile('index.html')
}

// 创建第二个窗口，使用 preload2.js
function createSettingsWindow() {
  const settingsWin = new BrowserWindow({
    webPreferences: {
      preload: path.join(__dirname, 'preload/settings.js')
    }
  })
  settingsWin.loadFile('settings.html')
}

app.whenReady().then(() => {
  createMainWindow()
  createSettingsWindow()
})

结合 Vite 的配置

在使用 Electron-Vite-Vue 时，我们需要确保 Vite 能够正确打包这些预加载脚本。在 vite.config.ts 中，我们可以这样配置：

import { defineConfig } from 'vite'
import electron from 'vite-plugin-electron'

export default defineConfig({
  plugins: [
    electron({
      entry: {
        main: 'src/main.ts',
        preload: {
          main: 'src/preload/main.ts',
          settings: 'src/preload/settings.ts'
        }
      }
    })
  ]
})

项目结构建议

为了实现清晰的代码组织，建议采用以下目录结构：

src/
├── main/
│   └── main.ts        # 主进程入口
├── preload/
│   ├── main.ts        # 主窗口预加载脚本
│   └── settings.ts    # 设置窗口预加载脚本
├── renderer/
│   ├── main/          # 主窗口前端代码
│   └── settings/      # 设置窗口前端代码

最佳实践

1. 类型安全：为不同的预加载脚本创建对应的类型定义文件，确保 API 调用的类型安全。

2. 代码复用：将公共逻辑提取到单独的模块中，避免在不同预加载脚本中重复代码。

3. 安全考虑：确保每个预加载脚本只暴露必要的 API，遵循最小权限原则。

4. 性能优化：预加载脚本应尽量保持精简，避免复杂的初始化逻辑。

常见问题处理

1. 热重载问题：在开发环境下，确保修改预加载脚本后能够正确触发窗口重载。

2. 路径问题：使用 path.join 或 import.meta.url 来确保跨平台路径的正确性。

3. 上下文隔离：注意 Electron 的上下文隔离设置，确保预加载脚本能按预期工作。

总结

在 Electron-Vite-Vue 项目中实现多窗口不同预加载脚本需要同时考虑 Electron 的窗口创建机制和 Vite 的构建配置。通过合理的项目结构和配置，我们可以灵活地为每个窗口定制专属的预加载逻辑，同时保持代码的整洁和可维护性。这种方法不仅适用于 Vue，也适用于其他前端框架与 Electron 的集成开发。