Electron-Forge配置macOS/Linux文件关联及事件监听技术问询

一、配置文件关联（forge.config.js） #

文件关联的配置核心在forge.config.js中，需要同时在packagerConfig和对应平台的maker配置中设置，确保macOS和Linux都能识别：

基础配置（packagerConfig） #

在packagerConfig里定义文件关联规则，这是所有平台的基础配置：

module.exports = {
  packagerConfig: {
    fileAssociations: [
      {
        ext: 'txt', // 关联的文件后缀
        name: 'Text File', // 文件类型名称
        role: 'Editor', // macOS下的角色，可选Viewer/Editor
        icon: './assets/icon' // 图标路径，无需加后缀，Electron会自动匹配对应平台格式（macOS用.icns，Linux用.png）
      }
    ]
  },
  // 其他配置...
};

Linux平台补充（maker-deb/maker-rpm） #

对于Linux的deb/rpm包，需要在maker配置中添加桌面条目（desktopEntry），声明MIME类型：

makers: [
  {
    name: '@electron-forge/maker-deb',
    config: {
      options: {
        desktopEntry: {
          MimeType: 'text/plain;application/x-txt;', // 覆盖所有txt相关MIME类型
          Keywords: 'text;editor;note;',
          Actions: 'open'
        }
      }
    }
  },
  // 如果用rpm包，对应配置maker-rpm即可
  // {
  //   name: '@electron-forge/maker-rpm',
  //   config: { /* 类似deb的desktopEntry配置 */ }
  // }
]

macOS平台补充 #

macOS下不需要额外maker配置，packagerConfig中的fileAssociations已经足够，但要确保图标是.icns格式，安装包后可能需要注销系统才能让关联生效。

二、实现文件处理的事件监听 #

在主进程（main.js）中监听Electron的系统事件，处理文件打开请求，兼容macOS和Linux：

1. 监听open-file事件（macOS核心） #

macOS下用户通过文件关联打开文件时，会触发open-file事件：

const { app, BrowserWindow } = require('electron');
let mainWindow;

function createWindow() {
  mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      contextIsolation: true,
      preload: './preload.js' // 推荐用preload做IPC通信，避免直接开启nodeIntegration
    }
  });
  mainWindow.loadFile('index.html');
}

// 监听macOS的open-file事件
app.on('open-file', (event, filePath) => {
  event.preventDefault(); // 阻止系统默认行为
  handleFileOpen(filePath);
});

// 统一处理文件打开逻辑
function handleFileOpen(filePath) {
  console.log('打开的文件路径:', filePath); // 打印文件路径
  if (!mainWindow) {
    createWindow();
    // 等待窗口加载完成后传递文件路径到渲染进程
    mainWindow.webContents.once('did-finish-load', () => {
      mainWindow.webContents.send('file-opened', filePath);
    });
  } else {
    mainWindow.webContents.send('file-opened', filePath);
    mainWindow.show(); // 激活窗口
  }
}

2. 处理Linux的命令行参数与多实例 #

Linux下，文件路径会作为命令行参数传入应用，且多实例打开文件时需要处理second-instance事件：

app.whenReady().then(() => {
  // 处理启动时的命令行参数（应用未启动时打开文件）
  const args = process.argv.slice(1);
  const targetFile = args.find(arg => arg.endsWith('.txt'));
  if (targetFile) {
    handleFileOpen(targetFile);
  } else {
    createWindow();
  }

  // 处理Linux下多实例打开文件的情况
  app.on('second-instance', (event, argv) => {
    const targetFile = argv.slice(1).find(arg => arg.endsWith('.txt'));
    if (targetFile) {
      handleFileOpen(targetFile);
      // 恢复窗口（如果最小化）
      if (mainWindow.isMinimized()) mainWindow.restore();
      mainWindow.focus();
    }
  });

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

3. 渲染进程接收文件路径（可选） #

推荐用preload脚本做IPC通信，避免直接暴露Node.js API到渲染进程：

// preload.js
const { contextBridge, ipcRenderer } = require('electron');
contextBridge.exposeInMainWorld('electronAPI', {
  onFileOpened: (callback) => ipcRenderer.on('file-opened', callback)
});

<!-- index.html -->
<script>
  window.electronAPI.onFileOpened((event, filePath) => {
    console.log('渲染进程收到文件:', filePath);
    // 这里可以实现读取文件、显示内容等逻辑
  });
</script>

注意事项 #

• 图标准备：macOS用.icns，Linux准备不同尺寸的.png（如16x16、32x32、128x128），放在同一目录下，Electron会自动识别。
• 测试生效：macOS安装包后可能需要注销系统；Linux安装deb/rpm包后，系统会自动更新文件关联。
• 安全问题：避免在渲染进程中直接开启nodeIntegration，推荐用preload脚本做IPC通信。

内容的提问来源于stack exchange，提问作者Vandervidi