web-dev-qa-db-ja.com

Electronでpreload.jsを適切に使用する方法

次のように、fsプロセスでNodeモジュール（この例ではrenderer）を使用しようとしています。

// main_window.js
const fs = require('fs')

function action() {
    console.log(fs)
}

注：main_windowのボタンを押すと、action関数が呼び出されます。

しかし、これはエラーになります：

Uncaught ReferenceError: require is not defined
    at main_window.js:1

main.jsを初期化するときにこれらの行をmain_windowに追加することで、この問題を解決できます この受け入れられた回答で示唆されているように ：

// main.js
main_window = new BrowserWindow({
    width: 650,
    height: 550,
    webPreferences: {
        nodeIntegration: true
    }
})

しかし、 ドキュメントによると 、これは最善の方法ではありません。代わりに、preload.jsファイルを作成し、これらのNodeモジュールをそこにロードして、次に、すべてのrendererプロセスで使用します。このような：

main.js：

main_window = new BrowserWindow({
    width: 650,
    height: 550,
    webPreferences: {
        preload: path.join(app.getAppPath(), 'preload.js')
    }
})

preload.js：

const fs = require('fs')

window.test = function() {
    console.log(fs)
}

main_window.js：

function action() {
    window.test()
}

そしてそれはうまくいきます！

さて、私の質問は、preload.jsにrendererプロセスのコードのほとんどを書き込む必要があるというのは直観に反することではないですか（preload.jsのみにアクセスできるため、Nodeモジュール）、次に各renderer.jsファイルの関数を呼び出すだけです（たとえば、ここではmain_window.js）？ここで何を理解していませんか？

javascriptnode.jselectron
15
Amir A. Shabani

安全に行うには、このようにすべてを設定する必要があります。これは私の ここにコメント で概説されています。

main.js

const {
  app,
  BrowserWindow,
  ipcMain
} = require("electron");
const path = require("path");
const fs = require("fs");

// Keep a global reference of the window object, if you don't, the window will
// be closed automatically when the JavaScript object is garbage collected.
let win;

async function createWindow() {

  // Create the browser window.
  win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: false, // is default value after Electron v5
      contextIsolation: true, // protect against prototype pollution
      enableRemoteModule: false, // turn off remote
      preload: path.join(__dirname, "preload.js") // use a preload script
    }
  });

  // Load app
  win.loadFile(path.join(__dirname, "dist/index.html"));

  // rest of code..
}

app.on("ready", createWindow);

ipcMain.on("toMain", (event, args) => {
  fs.readFile("path/to/file", (error, data) => {
    // Do something with file contents

    // Send result back to renderer process
    win.webContents.send("fromMain", responseObj);
  });
});

preload.js

const {
    contextBridge,
    ipcRenderer
} = require("electron");

// Expose protected methods that allow the renderer process to use
// the ipcRenderer without exposing the entire object
contextBridge.exposeInMainWorld(
    "api", {
        send: (channel, data) => {
            // whitelist channels
            let validChannels = ["toMain"];
            if (validChannels.includes(channel)) {
                ipcRenderer.send(channel, data);
            }
        },
        receive: (channel, func) => {
            let validChannels = ["fromMain"];
            if (validChannels.includes(channel)) {
                // Deliberately strip event as it includes `sender` 
                ipcRenderer.on(channel, (event, ...args) => func(...args));
            }
        }
    }
);

index.html

<!doctype html>
<html lang="en-US">
<head>
    <meta charset="utf-8"/>
    <title>Title</title>
</head>
<body>
    <script>
        window.api.receive("fromMain", (data) => {
            console.log(`Received ${data} from main process`);
        });
        window.api.send("toMain", "some data");
    </script>
</body>
</html>
8
Zac