HOWTO · React
console.log() in React
Erfahren Sie, wie Sie mit console.log() JavaScript-Werte, React-Status, Props und Ereignisdaten in der Browserkonsole untersuchen.
Auf dieser Seite
In React sendet console.log() einen Wert an die Entwicklerkonsole des Browsers. Dort können Sie JavaScript-Daten beim Debuggen untersuchen. Platzieren Sie den Aufruf an der Stelle, an der der Wert verfügbar ist: in einer Komponente für Props oder den Status des aktuellen Renderdurchlaufs, in einem Effekt für den übernommenen Status oder in einem Ereignishandler für Benutzereingaben.
Was console.log() in React bewirkt
console.log() ist eine JavaScript-Methode und keine React-Funktion. Sie schreibt die übergebenen Argumente in die Entwicklerkonsole, nicht auf die Seite. Öffnen Sie die Entwicklertools Ihres Browsers und wählen Sie dort den Bereich „Konsole“, um die Meldungen zu sehen. Eine Komponente kann rendern, ohne etwas zu protokollieren; eine Meldung erscheint nur, wenn die Ausführung den entsprechenden Aufruf erreicht.
Eine Referenz zur Console-API und ihren Methoden finden Sie in der MDN-Dokumentation zu console.
Einfache Konsolenausgaben mit JavaScript
Übergeben Sie console.log() eine Zeichenfolge, eine Zahl, ein Objekt, ein Array oder mehrere Werte. Dieses eigenständige JavaScript-Beispiel sendet eine Begrüßung an die Entwicklerkonsole:
console.log("Hello, React!");
Hello, React!
Die Browserkonsole formatiert Objekte so, dass sie sich untersuchen lassen; die genaue Darstellung hängt vom Browser ab. Mit console.log("Benutzer", user) können Sie beispielsweise ein Objekt beschriften. Um eine Meldung hervorzuheben, verwenden Sie den Formatbezeichner %c, etwa mit console.log("%cWichtig", "color: red; font-weight: bold"). %c wendet die folgende Stilzeichenfolge auf den Meldungstext an. console.important() ist keine eingebaute Methode. Ein eigener Wrapper müsste dieses Verhalten daher selbst definieren.
Komponentenstatus protokollieren
Fügen Sie in einer Funktionskomponente console.log(count) in den Komponentenrumpf ein, um den count-Wert dieses Renderdurchlaufs zu untersuchen. Der Rumpf wird bei jedem erneuten Rendern der Komponente ausgeführt; die Meldung kann deshalb häufig erscheinen. Auch das Entwicklungsverhalten, einschließlich Strict Mode, kann zusätzliche Renderdurchläufe verursachen. Gehen Sie daher nicht davon aus, dass pro Benutzeraktion genau eine Meldung ausgegeben wird.
Eine Statusaktualisierung plant einen späteren Renderdurchlauf. Ein unmittelbar auf setCount(count + 1) folgendes console.log(count) liest weiterhin den count-Wert des aktuellen Renderdurchlaufs. Um jeden übernommenen Wert zu beobachten, platzieren Sie console.log(count) in einem Effekt mit [count] als Abhängigkeit. Dieser Effekt läuft auch nach dem ersten Einhängen der Komponente. Wenn Sie eine konkrete Statusänderung nachvollziehen möchten, protokollieren Sie stattdessen das Ereignis oder die Aktion, die die Aktualisierung anfordert. Protokollieren Sie nicht als Seiteneffekt innerhalb einer Statusaktualisierungsfunktion.
Props untersuchen
Protokollieren Sie ein Prop in der Komponente, die es empfängt. Eine untergeordnete Komponente, die user erhält, kann beispielsweise in ihrem Funktionsrumpf console.log("user prop", user) aufrufen. So sehen Sie den für diesen Renderdurchlauf übergebenen Wert und können den Datenfluss von der übergeordneten zur untergeordneten Komponente nachvollziehen. Da der Komponentenrumpf bei erneuten Renderdurchläufen wieder ausgeführt wird, kann dasselbe Prop mehrfach protokolliert werden. Bei verschachtelten Daten hilft es, gezielt das untersuchte Feld auszugeben, damit die Konsole übersichtlich bleibt.
Ereignisdaten protokollieren
Platzieren Sie den Aufruf im Ereignishandler, um Daten bei einer Interaktion zu untersuchen. In einem Handler für Eingabeänderungen liest console.log(event.currentTarget.value) den aktuellen Eingabewert zu dem Zeitpunkt, an dem der Handler ausgeführt wird. Aktualisiert der Handler außerdem den Status, ist der protokollierte Ereigniswert sofort verfügbar; der neue Status wird erst in einem späteren Renderdurchlauf sichtbar. Ein Aufruf im Handler verhindert, dass nicht zusammenhängende erneute Renderdurchläufe dieselbe Meldung erzeugen.
Protokolle sicher verwenden und entfernen
Betrachten Sie Protokollaufrufe als vorübergehende Hilfsmittel beim Debuggen. Suchen Sie vor einer Veröffentlichung nach Aufrufen, die nicht mehr benötigt werden, und entfernen Sie sie. Das gilt besonders für Meldungen mit personenbezogenen Daten, Zugriffstokens oder anderen vertraulichen Werten. Produktions-Builds entfernen console.log()-Aufrufe nicht grundsätzlich; ob sie entfernt werden, hängt von der Build-Konfiguration des Projekts ab. Beabsichtigte betriebliche Protokollierung sollte nur bestehen bleiben, wenn sie den Protokollierungsrichtlinien der Anwendung entspricht.
Um einen Wert zu prüfen, protokollieren Sie ihn dort, wo er verfügbar ist: Komponentendaten im Renderdurchlauf oder in einem Effekt, Interaktionsdaten im Ereignishandler. Für umfangreichere Debugging-Sitzungen können Sie mit Browser-Haltepunkten und den React Developer Tools die Ausführung und Komponentendaten untersuchen, ohne dauerhafte Protokollaufrufe in den Code einzufügen. Mit der Schaltfläche zum Leeren der Browserkonsole oder mit console.clear() können Sie die sichtbaren Meldungen entfernen; die Protokollaufrufe im Code bleiben davon unberührt. Wenn Protokolle aus dem Produktionspaket entfernt werden sollen, prüfen Sie die Build-Konfiguration. Andernfalls entfernen Sie vor der Veröffentlichung die vorübergehenden Aufrufe aus dem Quellcode.