HOWTO · Java
Sostituisci il metodo toString in Java
Questo articolo spiega come sovrascrivere il metodo toString() in java
In questa pagina
Quando Java stampa un oggetto, chiama il metodo toString() dell’oggetto per ottenere una stringa. La rappresentazione predefinita ereditata di solito identifica la classe dell’oggetto e include un valore basato sull’hash: può aiutare a distinguere le istanze, ma raramente ne descrive il contenuto. Sovrascrivi toString() per fornire una rappresentazione concisa, utile nei log, durante il debug e nell’output ordinario.
Cosa indica l’output predefinito di toString()
Ogni classe Java eredita toString() da Object, a meno che una superclasse o la classe stessa non lo sovrascriva. Chiamate come System.out.println(book) usano la rappresentazione testuale dell’oggetto; la chiamata è implicita, quindi non devi scrivere book.toString().
La rappresentazione predefinita non è un identificatore stabile né garantisce di descrivere i campi dell’oggetto. La parte basata sull’hash può cambiare da un’esecuzione all’altra e non rende leggibile lo stato dell’oggetto. Evita di copiare un valore predefinito d’esempio nella logica dell’applicazione o nei test. Una sovrascrittura personalizzata è utile quando una classe dovrebbe avere una rappresentazione testuale più informativa.
Sovrascrivere toString() con @Override
Dichiara un metodo pubblico con la firma esatta public String toString() e restituisci un String. L’annotazione @Override indica al compilatore che il metodo deve sovrascriverne uno ereditato; aiuta anche a individuare un nome scritto male o un elenco di parametri non corretto. Questo esempio completo memorizza il titolo e l’autore di un libro e ne costruisce la rappresentazione usando questi campi:
Esegui questo esempio:
Il codice e le etichette o gli output visibili in questa sezione restano in inglese.
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 + "'}";
}
}
Compilare ed eseguire l’esempio
Salva il sorgente in un file chiamato BookExample.java, perché la classe pubblica si chiama BookExample. Da quella directory, compilalo con javac BookExample.java e poi eseguilo con java BookExample. L’esecuzione riuscita stampa Book{title='Dune', author='Frank Herbert'}, la rappresentazione restituita da Book.toString().
La distinzione fondamentale è che toString() restituisce una stringa: da solo non stampa nulla. System.out.println(book) richiede la rappresentazione e la scrive sulla console. Puoi usare la stringa restituita anche in un logger o in un altro messaggio, mantenendo fuori dal metodo le decisioni relative alla visualizzazione o alla registrazione nei log.
Scegliere un output utile per toString()
Includi i campi che aiutano a riconoscere l’oggetto e a comprenderne lo stato attuale. Mantieni il formato conciso, indica i valori con etichette quando rende più chiara la lettura e ometti i segreti, come password o token di accesso. La rappresentazione è destinata alle persone: scegli valori stabili e comprensibili invece di affidarti al testo ereditato basato sull’hash.
Il metodo dovrebbe descrivere lo stato senza svolgere attività estranee: evita di modificare i campi, stampare messaggi o eseguire operazioni costose mentre costruisce la stringa. Se una classe ha molti campi, includi quelli più utili per la diagnosi invece di restituire un elenco smisurato. Se una formattazione esatta fa parte di un file pubblico o di un protocollo di rete, definisci e verifica quel formato separatamente; chi usa la classe non dovrebbe dover analizzare una rappresentazione di debug come se fosse un contratto sui dati.