web-dev-qa-db-fra.com

Comment utiliser correctement preload.js dans Electron

J'essaie d'utiliser Node modules (dans cet exemple, fs) dans mes processus renderer, comme ceci:

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

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

Remarque: la fonction action est appelée lorsque j'appuie sur un bouton de mon main_window.

Mais cela donne une erreur:

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

Je peux résoudre ce problème, comme suggéré par cette réponse acceptée , en ajoutant ces lignes à mon main.js lors de l'initialisation du main_window:

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

Mais, selon les documents , ce n'est pas la meilleure chose à faire, et je devrais plutôt créer un preload.js fichier et charge ces modules Node là-bas et ensuite l'utiliser dans tous mes processus renderer. Comme ceci:

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

Et il fonctionne!

Maintenant, ma question est, n'est-ce pas contre-intuitif que je devrais écrire la plupart du code de mes processus renderer dans preload.js (Parce que seulement dans preload.js J'ai accès à Node modules), puis j'appelle simplement les fonctions de chaque renderer.js fichier (par exemple ici, main_window.js)? Qu'est-ce que je ne comprends pas ici?

javascriptnode.jselectron
15
Amir A. Shabani

Pour le faire en toute sécurité, vous voudrez tout configurer comme ça. Ceci est décrit dans mon commentaire ici .

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