HOWTO · Java
Überschreiben Sie die toString-Methode in Java
Dieser Artikel erklärt, wie man die toString() Methode in Java überschreibt
Auf dieser Seite
Wenn Java ein Objekt ausgibt, ruft es dessen Methode toString() auf, um einen Text zu erhalten. Die geerbte Standarddarstellung nennt üblicherweise die Klasse des Objekts und einen Hash-basierten Wert. Das kann helfen, Instanzen zu unterscheiden, sagt aber selten etwas über deren Inhalt aus. Überschreiben Sie toString(), um eine knappe Darstellung bereitzustellen, die für Protokolle, die Fehlersuche und gewöhnliche Ausgaben nützlich ist.
Bedeutung der Standardausgabe von toString()
Jede Java-Klasse erbt toString() von Object, sofern weder eine Oberklasse noch die Klasse selbst die Methode überschreibt. Aufrufe wie System.out.println(book) verwenden die String-Darstellung des Objekts. Der Aufruf erfolgt implizit; Sie müssen also nicht selbst book.toString() schreiben.
Die Standarddarstellung ist weder ein stabiler Bezeichner noch eine Zusage über die Felder eines Objekts. Der Hash-basierte Teil kann sich zwischen Ausführungen ändern und macht den Zustand des Objekts nicht lesbar. Übernehmen Sie daher keinen beispielhaften Standardwert in die Anwendungslogik oder in Tests. Ein eigenes Override ist sinnvoll, wenn eine Klasse eine aussagekräftigere Textdarstellung liefern soll.
toString() mit @Override überschreiben
Deklarieren Sie eine öffentliche Methode mit der exakten Signatur public String toString(), die einen String zurückgibt. Die Annotation @Override weist den Compiler darauf hin, dass die Methode eine geerbte Methode überschreiben soll. Sie hilft außerdem dabei, einen falsch geschriebenen Namen oder eine falsche Parameterliste zu erkennen. Das vollständige Beispiel speichert Titel und Autor eines Buches und erstellt aus diesen Feldern dessen Darstellung:
Führen Sie dieses Beispiel aus:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
public class BookExample {
public static void main(String[] args) {
Book book = new Book("Dune", "Frank Herbert");
System.out.println(book);
}
}
class Book {
private final String title;
private final String author;
Book(String title, String author) {
this.title = title;
this.author = author;
}
@Override
public String toString() {
return "Book{title='" + title + "', author='" + author + "'}";
}
}
Beispiel kompilieren und ausführen
Speichern Sie den Quellcode in einer Datei namens BookExample.java, da die öffentliche Klasse BookExample heißt. Kompilieren Sie ihn in diesem Verzeichnis mit javac BookExample.java und starten Sie ihn anschließend mit java BookExample. Bei erfolgreicher Ausführung wird Book{title='Dune', author='Frank Herbert'} ausgegeben – die von Book.toString() zurückgegebene Darstellung.
Wichtig ist der Unterschied: toString() gibt einen String zurück, gibt selbst aber nichts aus. System.out.println(book) fordert die Darstellung an und schreibt sie in die Konsole. Sie können den zurückgegebenen String auch in einem Logger oder einer anderen Nachricht verwenden. Entscheidungen über die Anzeige oder Protokollierung sollten außerhalb der Methode getroffen werden.
Eine nützliche Ausgabe für toString() wählen
Nehmen Sie Felder auf, anhand derer Leser das Objekt erkennen und seinen aktuellen Zustand verstehen können. Halten Sie das Format knapp, beschriften Sie Werte, wenn das die Verständlichkeit verbessert, und lassen Sie Geheimnisse wie Passwörter oder Zugriffstoken weg. Die Darstellung ist für Menschen gedacht. Verwenden Sie daher stabile, verständliche Werte, statt sich auf den geerbten Hash-basierten Text zu verlassen.
Die Methode sollte den Zustand wiedergeben und keine sachfremden Aufgaben erledigen: Ändern Sie beim Erstellen des Strings keine Felder, geben Sie keine Nachrichten aus und führen Sie keine aufwendigen Operationen aus. Bei Klassen mit vielen Feldern sollten Sie die für die Diagnose nützlichsten auswählen, statt eine unübersichtliche Gesamtausgabe zurückzugeben. Gehört ein genau festgelegtes Format zu einem öffentlichen Datei- oder Netzwerkprotokoll, definieren und testen Sie dieses Format separat. Aufrufer sollten eine Debugging-Darstellung nicht als Datenvertrag parsen müssen.