1. ホーム
  2. javascript

[解決済み] Electronでpreload.jsを正しく使用する方法

2022-03-10 03:12:57

質問

Nodeモジュールを使おうとしています(この例では。 fs ) の中で renderer のプロセスで、このようにします。

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

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

action 関数が呼び出されるのは、私が自分の main_window .

しかし、これではエラーになる。

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()
}

そして、うまくいくのです


ここで疑問なのですが、自分の書いた renderer のプロセスを preload.js (のみであるため)。 preload.js Nodeモジュールにアクセスすることができます)そして、単にそれぞれの renderer.js ファイル(例えばこちら。 main_window.js )? 私はここで何を理解していないのでしょうか?

どのように解決するのですか?

編集

他のユーザーからの質問ですが、以下に私の回答を説明させてください。

の正しい使い方は preload.js を使用する必要がある場合は、ホワイトリストに登録されたラッパーを公開する必要があります。 require .

セキュリティ的には require で取得したもの、あるいは require の呼び出しは preload.js (参照 コメント を参照してください)。これは、アプリがリモートコンテンツを読み込む場合に特に当てはまります(多くの場合、リモートコンテンツが読み込まれます)。

正しく動作させるためには BrowserWindow をご覧ください。これらのオプションを設定すると、エレクトロンアプリは IPC (プロセス間通信) を介して通信するようになり、2 つの環境は互いに分離されます。このようにアプリをセットアップすることで、電子アプリに含まれるすべての require バックエンドにある 'd モジュールは、クライアントがそれを改ざんすることから解放されます。

以下に、私が話していることと、それがあなたのアプリでどのように見えるかを示す簡単な例を挙げます。もしあなたが新しく始めるのであれば、次のように使用することをお勧めします。 secure-electron-template (私が作者です) は、electronアプリを構築する際に、これらのセキュリティのベストプラクティスをすべて最初から組み込んでいます。

このページ また、preload.js を使用して安全なアプリを作成するために必要なアーキテクチャに関する良い情報もあります。


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);
  });
});

プリロード.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>