Este es un práctico tutorial de cómo depurar tus aplicaciones hechas en Node.js. Con esto aprenderás a hacer esta tarea por completo y de la mejor manera. Esta guía lo ayudará a comenzar a depurar tus aplicaciones y Skripte Node.js. Continúa leyendo y entérate de mas.
Aktivieren Sie einen Inspektor
Beim Start mit dem Schalter --prüfen Ein Node.js-Prozess wartet über WebSockets auf Diagnosebefehle, die standardmäßig vom Inspector-Protokoll auf dem Host und dem Port definiert werden 127.0.0.1:9229. Jedem Prozess wird außerdem eine eindeutige UUID zugewiesen (z. B.) 0f2c936f-b1cd-4ac9-aab3-f63b0f33d55e).
Los clientes de Inspector deben conocer y especificar la dirección de host, el puerto y el UUID para conectarse a la interfaz de WebSocket. La Url Komplett ws://127.0.0.1:9229/0f2c936f-b1cd-4ac9-aab3-f63b0f33d55e Dies hängt natürlich vom tatsächlichen Host und Port sowie von der richtigen UUID für die Instanz ab.
El Inspector también incluye un punto final HTTP para servir Metadaten sobre el depurador, incluida su URL de WebSocket, UUID y la URL de Chrome DevTools. Obtén estos metadatos enviando una solicitud HTTP a http: // [Host: Port] / json / list. Dies gibt ein JSON-Objekt wie das folgende zurück; Verwenden Sie die Eigenschaft webSocketDebuggerUrl als URL, um eine direkte Verbindung zum Inspector herzustellen.
{"description": "node.js instance", "devtoolsFrontendUrl": "chrome-devtools: //devtools/bundled/inspector.html? experiment = true & v8only = true & ws = 127.0.0.1: 9229 / 0f2c936f-b1cd -4ac9-aab3 -f63b0f33d55e "," faviconUrl ":" https://nodejs.org/static/favicon.ico "," id ":" 0f2c936f-b1cd-4ac9-aab3-f63b0f33d55e "," title ":" node "," type ":" node "," url ":" file: // "," webSocketDebuggerUrl ":" ws: //127.0.0.1: 9229 / 0f2c936f-b1cd-4ac9-aab3-f63b0f33d55e "}
Sie können auch einen gestarteten Node.js-Prozess anweisen ohne –inspektion um Debug-Nachrichten abzuhören, indem Sie sie mit signalisieren SIGUSR1 (en Linux y OS X). A partir del Node 7, esto activa la API de depuración heredada; en el Node 8 y posterior activará la API Inspector.
Sicherheit ist involviert
Da der Debugger vollen Zugriff auf die Laufzeit von Node.js hat, kann ein böswilliger Akteur, der eine Verbindung zu diesem Port herstellen kann, im Namen des Knotenprozesses beliebigen Code ausführen. Es ist wichtig, die Sicherheitsauswirkungen des Offenlegens des Debug-Ports in öffentlichen und privaten Netzwerken zu verstehen.
Das öffentliche Offenlegen des Debug-Ports ist nicht sicher
Si el depurador está vinculado a una IP Adresse pública, o 0.0.0.0, irgendein Klient que pueda acceder a su dirección IP podrá conectarse al depurador sin ninguna restricción y podrá ejecutar código arbitrario.
Standardmäßig ist node –inspect an 127.0.0.1 gebunden. Sie müssen explizit eine öffentliche IP-Adresse oder 0.0.0.0 usw. angeben, wenn Sie externe Verbindungen zum Debugger zulassen möchten. Dies kann Sie einer potenziell erheblichen Sicherheitsbedrohung aussetzen. Wir empfehlen, dass Sie geeignete Firewalls und Zugriffskontrollen sichern, um Sicherheitsrisiken zu vermeiden.
Lokale Anwendungen haben vollen Zugriff auf den Inspektor.
Auch wenn Sie den Inspector-Port an binden 127.0.0.1 (Standardeinstellung) Alle Anwendungen, die lokal auf Ihrem PC ausgeführt werden, haben uneingeschränkten Zugriff. Dies ist beabsichtigt, damit lokale Debugger bequem eine Verbindung herstellen können.
Browser, websockets y política del mismo origen.
Los sitios Netz abiertos en un Browser web pueden hacer solicitudes WebSocket y HTTP bajo el modelo de seguridad del navegador. Es necesaria una conexión HTTP inicial para obtener un Id de sesión de depurador único. La misma política de origen impide que los sitios web puedan realizar esta conexión HTTP.
Para mayor seguridad contra los ataques de reencuadernación de DNS, Node.js verifica que las cabeceras del ‘Host’ para la conexión especifiquen una dirección IP o localhost o localhost6 con precisión.
Estas políticas de seguridad no permiten conectarse a un Server de depuración remoto especificando el nombre del host. Puedes evitar esta restricción especificando la dirección IP o utilizando túneles ssh como se describe a continuación.
Inspektor-Kunden
Varias herramientas comerciales y de Open Source pueden conectarse al Inspector de nodos. A continuación se ofrece información básica sobre estos temas:
- Node-Inspect
- Von der Node.js Foundation unterstützter CLI-Debugger, der das Inspector-Protokoll verwendet.
- Eine Version ist in Node enthalten und kann mit dem Knoten inspect myscript.js verwendet werden.
- Die neueste Version kann auch eigenständig installiert werden (z. B. npm install -g node-inspect) und mit node-inspect myscript.js verwendet werden.
- Chrome DevTools 55+
- Option 1: Öffnen Sie chrome: // inspect in einem Chromium-basierten Browser. Klicken Sie auf die Schaltfläche Konfigurieren und stellen Sie sicher, dass der Zielhost und der Zielport aufgelistet sind.
- Option 2: Kopieren Sie devtoolsFrontendUrl aus der Ausgabe von / json / list (siehe oben) oder dem Hinweistext –inspect und fügen Sie ihn in Chrome ein.
- Opción 3: Instale Chrome Extension NIM (Administrador del Inspector de Nodos): https://chrome.google.com/webstore/detail/nim-node-inspector-manage/gnhhdgbaldcilmgcpfddgdbkhjohddkj
- Visual Studio Code 1.10+
- Klicken Sie im Debugging-Bereich auf das Einstellungssymbol, um .vscode / launch.json zu öffnen. Wählen Sie "Node.js" für die Erstkonfiguration.
- Visual Studio 2017
- Wählen Sie "Debug> Debugging starten" aus dem Menü oder drücken Sie F5.
- JetBrains WebStorm 2017.1+ und andere JetBrains-IDEs
- Erstellen Sie eine neue Node.js-Debug-Konfiguration und klicken Sie auf Debug. –Inspect wird standardmäßig für Node.js 7+ verwendet. So deaktivieren Sie js.debugger.node.use.inspect in der IDE-Registrierung.
- Chrome Remote-Schnittstelle
- Verfügt über eine Bibliothek zur Erleichterung der Verbindungen zu Inspector-Protokollendpunkten
Befehlszeilenoptionen
In der folgenden Tabelle sind die Auswirkungen verschiedener Laufzeitflags auf das Debuggen aufgeführt:
- -Prüfen:
- Aktivieren Sie den Inspektionsagenten
- Lauschen Sie der Standardadresse und dem Standardport (127.0.0.0.1: 9229).
- –Inspect = [Host: Port]:
- Aktivieren Sie den Inspektionsagenten
- An Hostname Adresse oder Host binden (Standard: 127.0.0.0.1)
- Port abhören (Standard: 9229)
- –Inspect-brk
- Aktivieren Sie den Inspektionsagenten
- Lauschen Sie der Standardadresse und dem Standardport (127.0.0.1:9229).
- Pausa antes de que comience el código de Nutzername
- –Inspect-brk =[Host: Port]
- Aktivieren Sie den Inspektionsagenten
- An Hostname Adresse oder Host binden (Standard: 127.0.0.0.1)
- Port abhören (Standard: 9229)
- Pause, bevor der Benutzercode startet
- Knoten inspizieren script.js
- Untergeordneten Prozess erzeugen, um das Benutzerskript unter dem Flag –inspect auszuführen. Verwenden Sie den Hauptprozess, um den CLI-Debugger auszuführen.
- node inspect –port = xxxx script.js
- Untergeordneten Prozess erzeugen, um das Benutzerskript unter dem Flag –inspect auszuführen. Verwenden Sie den Hauptprozess, um den CLI-Debugger auszuführen.
- Port abhören (Standard: 9229)
Aktivieren von Remote-Debugging-Szenarien
Ich empfehle, dass Sie den Debugger niemals dazu bringen, eine öffentliche IP-Adresse abzuhören. Wenn Sie Remote-Debugging-Verbindungen zulassen müssen, empfehle ich stattdessen die Verwendung von SSH-Tunneln. Das folgende Beispiel dient nur zur Veranschaulichung. Bitte haben Sie Verständnis für das Sicherheitsrisiko, den Remotezugriff auf einen privilegierten Dienst zuzulassen, bevor Sie fortfahren.
Angenommen, Sie führen Node.js auf einem Remotecomputer aus. remote.example.com, Sie möchten debuggen können. Auf diesem Computer sollten Sie den Knotenprozess so starten, dass der Inspektor nur localhost abhört (Standardeinstellung).
$-Knoten --inspect server.js [php] Jetzt können Sie auf Ihrem lokalen Computer, von dem aus Sie eine Debug-Client-Verbindung starten möchten, einen SSH-Tunnel konfigurieren: [PHP] $ SSH -L 9221: localhost: 9229 @ user_sample. remote.com
Dadurch wird eine SSH-Tunnelsitzung gestartet, in der eine Verbindung zu Port 9221 Ihres lokalen Computers an Port 9229 von remote.example.com weitergeleitet wird. Jetzt können Sie einen Debugger wie Chrome DevTools oder Visual Studio Code an localhost: 9221 anhängen, der debuggen kann, als ob die Anwendung Node.js lokal ausgeführt würde.
