Erstellen Sie Ihren eigenen Nodemon in wenigen Codezeilen

Inhaltsverzeichnis

1. Einführung
2. Einrichten des Projekts
3. Server
4. Beobachter
5. Die Teile zusammenfügen
6. Referenzen

Quellcode finden Sie hier: https://github.com/aelassas/watcher

Einführung

Wenn Sie an Node.js-Anwendungen arbeiten, müssen Sie Ihren Server nach einigen Änderungen häufig neu starten. Nun, das wäre ärgerlich, wenn Sie Ihren Server jedes Mal manuell neu starten müssten, wenn Sie Änderungen an Ihrem Quellcode vornehmen. Zum Glück gibt es einige Dienstprogramme, mit denen Sie Ihren Server automatisch neu starten können, wenn Änderungen erkannt werden. Und das bekannteste ist Nodemon. nodemon ist ein Tool, das bei der Entwicklung von Node.js-basierten Anwendungen hilft, indem es die Node-Anwendung automatisch neu startet, wenn Dateiänderungen im Verzeichnis erkannt werden. Der Zweck dieses Tipps besteht nicht darin, das Rad neu zu erfinden, sondern Ihnen zu zeigen, wie Sie Ihr eigenes Dienstprogramm erstellen können, das alle Änderungen in Ihrer Node.js-Anwendung überwacht und den Server in nur wenigen Codezeilen automatisch neu startet.

Einrichten des Projekts

Der erste Schritt besteht darin, unser Node.js-Projekt zu initialisieren:

npm init

Dann müssen wir package.json aktualisieren, um die Unterstützung von ES6 hinzuzufügen, indem wir das Modul als Typ festlegen:

{
  "name": "watcher",
  "type": "module",
  "version": "1.0.0",
  "author": "Akram El Assas"
}

Dann installieren wir Entwicklungsabhängigkeiten:

npm i -D @types/node

• @types/node: Für automatische Vervollständigung in Visual Studio Code

Server

Wir erstellen einen einfachen Webserver server.js wie folgt:

import { createServer } from 'http'

const PORT = 8888

createServer((_, res) => {
    res.writeHead(200, { 'Content-Type': 'text/plain' })
    res.write('Hello World!')
    res.end()
}).listen(PORT)

console.log('HTTP server is running on Port', PORT)

Dann erstellen wir mit dem folgenden Befehl einen Watcher, um den Server jedes Mal neu zu starten, wenn Änderungen im übergeordneten Ordner des Servers und in seinen Unterordnern erkannt werden:

node watcher.js server.js

Beobachter

Der Watcher startet den Server jedes Mal neu, wenn Änderungen erkannt werden.

Zuallererst müssen wir die Befehlszeilenargumente abrufen. In Node.js können wir über „process.argv“ auf Befehlszeilenargumente zugreifen. Die Eigenschaft „process.argv“ gibt ein Array mit den Befehlszeilenargumenten zurück, die beim Start des Node.js-Prozesses übergeben wurden. Das erste Element ist execPath. Das zweite Element ist der Pfad zur ausgeführten JavaScript-Datei. Die restlichen Elemente sind alle zusätzlichen Befehlszeilenargumente.

Wenn wir den folgenden Befehl ausführen:

node watcher.js server.js

process.argv sieht wie folgt aus:

[
  'C:\Program Files\nodejs\node.exe',
  'C:\dev\watcher\src\watcher.js',
  'server.js'
]

Das erste Element ist der Pfad zur ausführbaren Datei von Node.j. Das zweite Element ist der Pfad zu watcher.js. Und das letzte Element ist server.js. Daher können wir unseren Code beginnen, indem wir das erste und dritte Element wie folgt deklarieren:

npm init

Wir müssen dann eine Funktion erstellen, die einen untergeordneten Prozess startet, der Node.js mit der angegebenen Datei als Argument startet, in unserem Fall server.js. Dazu verwenden wir die Spawn-Methode aus dem Modul child_process. Die Methode child_process.spawn() erzeugt mit dem angegebenen Befehl einen neuen Prozess mit Befehlszeilenargumenten in args. Der Vorteil der Verwendung der Spawn-Methode besteht darin, dass wir stdout und stderr des untergeordneten Prozesses mithilfe der Pipe-Methode an den übergeordneten Prozess umleiten können. Die Pipe-Methode wird verwendet, um einen beschreibbaren Stream an einen lesbaren Stream anzuhängen, sodass dieser daraufhin in den Fließmodus wechselt und dann alle Daten, die er hat, an den angehängten beschreibbaren Stream überträgt. Der Quellcode unserer Funktion wird wie folgt aussehen:

{
  "name": "watcher",
  "type": "module",
  "version": "1.0.0",
  "author": "Akram El Assas"
}

Zuerst erzeugen wir einen untergeordneten Node.js-Prozess mit dem angegebenen Dateiargument. Anschließend leiten wir stdout und stderr des untergeordneten Prozesses mithilfe der Pipe-Methode an den übergeordneten Prozess um. Wenn dann der untergeordnete Prozess geschlossen wird, verlassen wir den übergeordneten Prozess mit demselben Exit-Code. Die Methode „process.exit()“ weist Node.js an, den Prozess synchron mit einem Exit-Status des Codes zu beenden. Wenn der Code weggelassen wird, verwendet Exit entweder den Erfolgscode 0 oder den Wert von „process.exitCode“, sofern dieser festgelegt wurde. Node.js wird erst beendet, wenn alle Exit-Ereignis-Listener aufgerufen wurden. Und schließlich geben wir den untergeordneten Prozess zurück.

Jetzt müssen wir Änderungen im übergeordneten Ordner der Datei und ihren Unterordnern erkennen. Und jedes Mal, wenn eine Änderung in Bezug auf eine JavaScript-Datei erkannt wird, beenden wir den untergeordneten Prozess und erzeugen den untergeordneten Prozess erneut. Dazu verwenden wir die Watch-Methode aus dem Modul fs/promises. Die Methode fs/promises.watch() gibt einen asynchronen Iterator zurück, der auf Änderungen am Dateinamen überwacht, wobei Dateiname entweder eine Datei oder ein Verzeichnis ist. Wir erstellen einen Watcher für den übergeordneten Ordner der Datei. Dann werden wir den Watcher durchlaufen. Wir ignorieren den Ordner node_modules und jedes Mal, wenn eine Änderung an einer JavaScript-Datei erkannt wird, beenden wir den untergeordneten Prozess und erzeugen ihn wie folgt erneut:

npm i -D @types/node

Die Methode subprocess.kill() sendet ein Signal an den untergeordneten Prozess. Wenn kein Argument angegeben wird, wird dem Prozess das SIGTERM-Signal gesendet. Das SIGKILL-Signal kann nicht abgefangen, blockiert oder ignoriert werden und zwingt den untergeordneten Prozess zum Stoppen. Eine Liste der verfügbaren Signale finden Sie unter signal(7).

Das ist es! Wir haben unseren eigenen Nodemon in nur wenigen Codezeilen fertiggestellt.

Zu guter Letzt müssen wir die Start- und Entwicklungsskripte wie folgt zu unserem package.json hinzufügen:

import { createServer } from 'http'

const PORT = 8888

createServer((_, res) => {
    res.writeHead(200, { 'Content-Type': 'text/plain' })
    res.write('Hello World!')
    res.end()
}).listen(PORT)

console.log('HTTP server is running on Port', PORT)

Um unsere Anwendung zu starten, geben Sie einfach den folgenden Befehl ein:

node watcher.js server.js

Wenn wir nun unsere Anwendung ausführen und Änderungen an server.js vornehmen, wird der Server automatisch neu gestartet. Wir müssen den Server nicht mehr manuell stoppen und starten.

Die Teile zusammenbringen

Wir richten unseren eigenen Nodemon in nur wenigen Codezeilen ein. Nun sieht der gesamte Quellcode unseres watcher.js wie folgt aus:

npm init

Dies ist nur ein einfaches Beispiel, aber Sie können sich auch andere Situationen vorstellen, in denen Sie Änderungen an Videodateien überwachen und jedes Mal, wenn eine Änderung erkannt wird, ein untergeordneter Konvertierungsprozess (ffmpeg) gestartet wird.

Sie können auch andere Optionen implementieren, wie zum Beispiel:

• Bestimmte Dateien oder Verzeichnisse ignorieren
• Bestimmte Verzeichnisse ansehen
• Überwachung mehrerer Verzeichnisse
• Erweiterungsüberwachungsliste angeben
• Verzögerter Neustart
• Ausführung anderer ausführbarer Dateien als Node.js wie Python, Ruby, make usw.
• und so weiter...

Referenzen

• nodemon
• child_process.spawn(command[, args][, options])
• process.exit([code])
• fsPromises.watch(Dateiname[, Optionen])
• process.kill(pid[, signal])
• Signal(7)

Das obige ist der detaillierte Inhalt vonErstellen Sie Ihren eigenen Nodemon in wenigen Codezeilen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!