Node.js lapseprotsessid: kõik, mida peate teadma

Kuidas kasutada kudemist (), exec (), execFile () ja kahvlit ()

Uuendus: see artikkel on nüüd osa minu raamatust “Node.js Beyond The Basics”.

Selle sisu uuendatud versiooni ja lisateavet Node'i kohta leiate aadressilt jscomplete.com/node-beyond-basics .

Üheahelaline, mitteblokeeriv jõudlus Node.js-s töötab suurepäraselt ühe protsessi jaoks. Kuid lõpuks ei piisa ühest protsessorist ühes protsessoris teie rakenduse suureneva töökoormuse käsitlemiseks.

Ükskõik kui võimas teie server ka poleks, saab üks lõim toetada ainult piiratud koormust.

See, et Node.js töötab ühes lõimes, ei tähenda, et me ei saaks ära kasutada mitut protsessi ja muidugi ka mitut masinat.

Mitme protsessi kasutamine on parim viis sõlme rakenduse skaleerimiseks. Node.js on loodud paljude sõlmedega hajutatud rakenduste loomiseks. Seetõttu on selle nimi Node . Mastaapsus küpsetatakse platvormi sisse ja see pole midagi, mille peale hakkate hiljem rakenduse elu jooksul mõtlema.

See artikkel on osa minu Pluralsighti kursusest Node.js. Ma kajastan seal sarnast sisu videoformaadis.

Pange tähele, et enne selle artikli lugemist peate Node.js-i sündmustest ja voogudest hästi aru saama . Kui te pole seda veel teinud, soovitan teil enne selle artikli lugemist lugeda veel kaks artiklit:

Node.js sündmuspõhise arhitektuuri mõistmine

Enamik Node'i objekte - näiteks HTTP-päringud, vastused ja voogud - rakendavad moodulit EventEmitter, et nad saaksid…

Vood: kõik, mida peate teadma

Node.js voogudel on maine, et nendega on raske töötada ja neid on veelgi raskem mõista. Mul on häid uudiseid ...

Lapse protsesside moodul

Lapseprotsessi saame hõlpsalt keerutada Node child_processmooduli abil ja need alamprotsessid saavad üksteisega sõnumsidesüsteemiga hõlpsasti suhelda.

child_processMoodul võimaldab juurdepääsu Operatsioonisüsteemi funktsioone käivitades tahes süsteemi käsu sees, noh, lapse protsessi.

Saame seda lapseprotsessi sisendvoogu juhtida ja selle väljundvoogu kuulata. Saame kontrollida ka aluseks olevale OS-i käsule edastatavaid argumente ja saame selle käsu väljundiga teha mida iganes tahame. Võime näiteks sisestada ühe käsu väljundi sisendina teise (täpselt nagu me teeme Linuxis), kuna nende käskude kõiki sisendeid ja väljundeid saab meile esitada Node.js voogude abil.

Pange tähele, et selles artiklis kasutatavad näited on kõik Linux-põhised. Windowsis peate vahetama käske, mida ma nende Windowsi alternatiividega kasutan.

Seal on neli erinevat võimalust luua lapse protsessi Sõlme: spawn(), fork(), exec(), ja execFile().

Vaatame nende nelja funktsiooni erinevusi ja seda, millal neid kasutada.

Kudenud lapse protsessid

spawnFunktsioon käivitab käsu uue protsessi ja saame kasutada seda läbida, et käsk ühtegi argumenti. Näiteks siin on pwdkäsku sooritava uue protsessi tekitamise kood .

const { spawn } = require('child_process'); const child = spawn('pwd');

Me lihtsalt hävitame spawnfunktsiooni child_processmoodulist välja ja täidame selle esimese argumendina käsuga OS.

spawnFunktsiooni ( childülaltoodud objekti) täitmise tulemus on ChildProcesseksemplar, mis rakendab EventEmitteri API-d. See tähendab, et saame registreerida selle lapse objekti sündmuste haldurid otse. Näiteks saame midagi ette võtta, kui lapseprotsess väljub, registreerides exitüritusele käitleja :

child.on('exit', function (code, signal) { console.log('child process exited with ' + `code ${code} and signal ${signal}`); });

Ülaltoodud käitleja annab meile väljapääsu codelapseprotsessist ja selle signalvõimaliku kasutamisest lapse protsessi lõpetamiseks. See signalmuutuja on null, kui lapseprotsess väljub normaalselt.

Teised sündmused, et saame registreeru masinad koos ChildProcessjuhtudel on disconnect, error, closeja message.

  • disconnectSündmus kostuva emaprotsessi käsitsi helistab child.disconnectfunktsiooni.
  • errorJuhul eraldub, kui protsess ei saa sünnitanud või tapetud.
  • closeJuhul eraldub, kui stdiovoolu alamprotsessina saada suletud.
  • messageJuhul on kõige olulisem. See eraldub siis, kui lapsprotsess kasutab process.send()funktsiooni sõnumite saatmiseks. Nii saavad vanema / lapse protsessid omavahel suhelda. Selle näeme allpool.

Iga laps protsessi saab ka kolm standard stdioojad, mida me saame kasutades child.stdin, child.stdoutja child.stderr.

Kui need voogud suletakse, kiirgab neid kasutanud lapseprotsess closesündmust. See closesündmus erineb exitsündmusest, kuna mitmel alamprotsessil võivad olla samad stdiovoogud ja seega ei tähenda üks lapseprotsessist väljumine voogude sulgemist.

Kuna kõik voogud on sündmuste kiirgajad, saame nende stdiovoogude kaudu kuulata erinevaid sündmusi, mis on seotud iga lapseprotsessiga. Erinevalt tavalisest protsessist on lapsprotsessis stdout/ stderrvooged loetavad voogud, samas kui stdinvoog on kirjutatav. See on põhimõtteliselt nende tüüpide pöördprotsess, nagu on leitud põhiprotsessis. Sündmused, mida saame nende voogude jaoks kasutada, on standardsed. Kõige tähtsam on see, et loetavates voogudes saame kuulata datasündmust, millel on käsu väljund või mis tahes käsu täitmisel ilmnenud viga:

child.stdout.on('data', (data) => { console.log(`child stdout:\n${data}`); }); child.stderr.on('data', (data) => { console.error(`child stderr:\n${data}`); });

Kaks ülaltoodud käitlejat logivad mõlemad juhtumid põhiprotsessi stdoutja stderr. Kui täidame spawnülaltoodud funktsiooni, pwdprinditakse käsu väljund ja lapsprotsess väljub koodiga 0, mis tähendab, et viga ei tekkinud.

spawnFunktsiooni täidetavale käsule saame edastada argumendid, kasutades funktsiooni teist argumenti spawn, mis on kõigi käsklusele edastatavate argumentide massiiv. Näiteks findkäsu täitmiseks praeguses kataloogis -type fargumendiga (ainult failide loendis) saame teha järgmist.

const child = spawn('find', ['.', '-type', 'f']);

Kui käsu täitmisel ilmneb viga, näiteks kui me leiame ülalt vale sihtkoha, child.stderrdatakäivitatakse exitsündmuse käitleja ja sündmuse käitleja teatab väljumiskoodist 1, mis tähendab, et viga on toimunud. Vea väärtused sõltuvad tegelikult host-OS-ist ja vea tüübist.

Lapse protsess stdinon kirjutatav voog. Me saame seda kasutada käsule sisendi saatmiseks. Täpselt nagu iga kirjutatav voog, on selle tarbimiseks lihtsaim viis pipefunktsiooni kasutamine. Lihtsalt sisestame loetava voo kirjutatavasse voogu. Kuna põhiprotsess stdinon loetav voog, saame selle viia lapse protsessivoogu stdin. Näiteks:

const { spawn } = require('child_process'); const child = spawn('wc'); process.stdin.pipe(child.stdin) child.stdout.on('data', (data) => { console.log(`child stdout:\n${data}`); });

In the example above, the child process invokes the wc command, which counts lines, words, and characters in Linux. We then pipe the main process stdin (which is a readable stream) into the child process stdin (which is a writable stream). The result of this combination is that we get a standard input mode where we can type something and when we hit Ctrl+D, what we typed will be used as the input of the wc command.

We can also pipe the standard input/output of multiple processes on each other, just like we can do with Linux commands. For example, we can pipe the stdout of the find command to the stdin of the wc command to count all the files in the current directory:

const { spawn } = require('child_process'); const find = spawn('find', ['.', '-type', 'f']); const wc = spawn('wc', ['-l']); find.stdout.pipe(wc.stdin); wc.stdout.on('data', (data) => { console.log(`Number of files ${data}`); });

I added the -l argument to the wc command to make it count only the lines. When executed, the code above will output a count of all files in all directories under the current one.

Shell Syntax and the exec function

By default, the spawn function does not create a shell to execute the command we pass into it. This makes it slightly more efficient than the exec function, which does create a shell. The exec function has one other major difference. It buffers the command’s generated output and passes the whole output value to a callback function (instead of using streams, which is what spawn does).

Here’s the previous find | wc example implemented with an exec function.

const { exec } = require('child_process'); exec('find . -type f | wc -l', (err, stdout, stderr) => { if (err) { console.error(`exec error: ${err}`); return; } console.log(`Number of files ${stdout}`); });

Since the exec function uses a shell to execute the command, we can use the shell syntax directly here making use of the shell pipe feature.

Note that using the shell syntax comes at a security risk if you’re executing any kind of dynamic input provided externally. A user can simply do a command injection attack using shell syntax characters like ; and $ (for example, command + ’; rm -rf ~’ )

The exec function buffers the output and passes it to the callback function (the second argument to exec) as the stdout argument there. This stdout argument is the command’s output that we want to print out.

The exec function is a good choice if you need to use the shell syntax and if the size of the data expected from the command is small. (Remember, exec will buffer the whole data in memory before returning it.)

The spawn function is a much better choice when the size of the data expected from the command is large, because that data will be streamed with the standard IO objects.

We can make the spawned child process inherit the standard IO objects of its parents if we want to, but also, more importantly, we can make the spawn function use the shell syntax as well. Here’s the same find | wc command implemented with the spawn function:

const child = spawn('find . -type f | wc -l', { stdio: 'inherit', shell: true });

Because of the stdio: 'inherit' option above, when we execute the code, the child process inherits the main process stdin, stdout, and stderr. This causes the child process data events handlers to be triggered on the main process.stdout stream, making the script output the result right away.

Because of the shell: true option above, we were able to use the shell syntax in the passed command, just like we did with exec. But with this code, we still get the advantage of the streaming of data that the spawn function gives us. This is really the best of both worlds.

There are a few other good options we can use in the last argument to the child_process functions besides shell and stdio. We can, for example, use the cwd option to change the working directory of the script. For example, here’s the same count-all-files example done with a spawn function using a shell and with a working directory set to my Downloads folder. The cwd option here will make the script count all files I have in ~/Downloads:

const child = spawn('find . -type f | wc -l', { stdio: 'inherit', shell: true, cwd: '/Users/samer/Downloads' });

Another option we can use is the env option to specify the environment variables that will be visible to the new child process. The default for this option is process.env which gives any command access to the current process environment. If we want to override that behavior, we can simply pass an empty object as the env option or new values there to be considered as the only environment variables:

const child = spawn('echo $ANSWER', { stdio: 'inherit', shell: true, env: { ANSWER: 42 }, });

The echo command above does not have access to the parent process’s environment variables. It can’t, for example, access $HOME, but it can access $ANSWER because it was passed as a custom environment variable through the env option.

One last important child process option to explain here is the detached option, which makes the child process run independently of its parent process.

Assuming we have a file timer.js that keeps the event loop busy:

setTimeout(() => { // keep the event loop busy }, 20000);

We can execute it in the background using the detached option:

const { spawn } = require('child_process'); const child = spawn('node', ['timer.js'], { detached: true, stdio: 'ignore' }); child.unref();

The exact behavior of detached child processes depends on the OS. On Windows, the detached child process will have its own console window while on Linux the detached child process will be made the leader of a new process group and session.

If the unref function is called on the detached process, the parent process can exit independently of the child. This can be useful if the child is executing a long-running process, but to keep it running in the background the child’s stdio configurations also have to be independent of the parent.

The example above will run a node script (timer.js) in the background by detaching and also ignoring its parent stdio file descriptors so that the parent can terminate while the child keeps running in the background.

The execFile function

If you need to execute a file without using a shell, the execFile function is what you need. It behaves exactly like the exec function, but does not use a shell, which makes it a bit more efficient. On Windows, some files cannot be executed on their own, like .bat or .cmd files. Those files cannot be executed with execFile and either exec or spawn with shell set to true is required to execute them.

The *Sync function

The functions spawn, exec, and execFile from the child_process module also have synchronous blocking versions that will wait until the child process exits.

const { spawnSync, execSync, execFileSync, } = require('child_process');

Those synchronous versions are potentially useful when trying to simplify scripting tasks or any startup processing tasks, but they should be avoided otherwise.

The fork() function

The fork function is a variation of the spawn function for spawning node processes. The biggest difference between spawn and fork is that a communication channel is established to the child process when using fork, so we can use the send function on the forked process along with the global process object itself to exchange messages between the parent and forked processes. We do this through the EventEmitter module interface. Here’s an example:

The parent file, parent.js:

const { fork } = require('child_process'); const forked = fork('child.js'); forked.on('message', (msg) => { console.log('Message from child', msg); }); forked.send({ hello: 'world' });

The child file, child.js:

process.on('message', (msg) => { console.log('Message from parent:', msg); }); let counter = 0; setInterval(() => { process.send({ counter: counter++ }); }, 1000);

In the parent file above, we fork child.js (which will execute the file with the node command) and then we listen for the message event. The message event will be emitted whenever the child uses process.send, which we’re doing every second.

To pass down messages from the parent to the child, we can execute the send function on the forked object itself, and then, in the child script, we can listen to the message event on the global process object.

When executing the parent.js file above, it’ll first send down the { hello: 'world' } object to be printed by the forked child process and then the forked child process will send an incremented counter value every second to be printed by the parent process.

Let’s do a more practical example about the fork function.

Let’s say we have an http server that handles two endpoints. One of these endpoints (/compute below) is computationally expensive and will take a few seconds to complete. We can use a long for loop to simulate that:

const http = require('http'); const longComputation = () => { let sum = 0; for (let i = 0; i  { if (req.url === '/compute') { const sum = longComputation(); return res.end(`Sum is ${sum}`); } else { res.end('Ok') } }); server.listen(3000);

This program has a big problem; when the the /compute endpoint is requested, the server will not be able to handle any other requests because the event loop is busy with the long for loop operation.

There are a few ways with which we can solve this problem depending on the nature of the long operation but one solution that works for all operations is to just move the computational operation into another process using fork.

We first move the whole longComputation function into its own file and make it invoke that function when instructed via a message from the main process:

In a new compute.js file:

const longComputation = () => { let sum = 0; for (let i = 0; i  { const sum = longComputation(); process.send(sum); });

Now, instead of doing the long operation in the main process event loop, we can fork the compute.js file and use the messages interface to communicate messages between the server and the forked process.

const http = require('http'); const { fork } = require('child_process'); const server = http.createServer(); server.on('request', (req, res) => { if (req.url === '/compute') { const compute = fork('compute.js'); compute.send('start'); compute.on('message', sum => { res.end(`Sum is ${sum}`); }); } else { res.end('Ok') } }); server.listen(3000);

When a request to /compute happens now with the above code, we simply send a message to the forked process to start executing the long operation. The main process’s event loop will not be blocked.

Once the forked process is done with that long operation, it can send its result back to the parent process using process.send.

Vanemate protsessis kuulame messagesündmust kahvliga lapse enda protsessis. Selle sündmuse saamisel on meil sumväärtus, mis on meil taotluse esitanud kasutajale http-i kaudu saadetav.

Ülalolev kood on loomulikult piiratud protsesside arvuga, mida saame hargneda, kuid kui me selle täidame ja taotleme pikka arvutamise lõpp-punkti üle httpi, pole põhiserver üldse blokeeritud ja võib vastu võtta täiendavaid taotlusi.

Node clustermoodul, mis on minu järgmise artikli teema, põhineb sellel ideel, et lapseprotsesside hargnemine ja taotluste koormuse tasakaalustamine on paljude kahvlite hulgas, mida saame igas süsteemis luua.

See on kõik, mis mul selle teema jaoks on. Täname lugemast! Järgmise korrani!

Reaktsiooni või sõlme õppimine? Vaadake minu raamatuid:

  • React.js saate teada, ehitades mänge
  • Node.js põhitõdedest kaugemale