Quel est le meilleur style standard pour un toString mise en œuvre?

Nous avons beaucoup d'objets pour lesquels nous aimons à mettre en œuvre un simple toString à la sortie des attributs de l'objet. Certains de ces attributs peut être complexe des objets eux-mêmes.

Est-il un standard, ou tout simplement l'une des meilleures pratiques pour un style? Je suis en train de penser à quelque chose comme:

[SimpleClassName] { prop1:value, prop2:value }

Dans ce cas, un imbriquée valeur ressemblerait à:

[SimpleClassName] { prop1:value, prop2:[NestedObject] { prop3:value}}

Nous sommes à l'aide de Java, mais je me surprends à poser la même question dans la plupart des langues!

  • Astuce: un IDE comme Eclipse pouvez générer un toString(). Explorez le menu Source. Gain de temps!
  • Je pense qu'un réel gain de temps serait d'utiliser un débogueur. Vous pouvez simplement forcer l'exécution en tout point, puis impression de toutes les informations dont vous avez besoin sur les objets disponibles, obtenir une pile de piste, effectuer les modifications nécessaires, puis de continuer. Tous, sans ballonnements votre code avec toString méthodes et des traces. Pourquoi s'embêter alors le débogueur fait tout pour vous, pour chaque objet?
InformationsquelleAutor Nicole | 2010-10-15
  1. 26

    Personnellement, je trouve le mélange de [] et {} pas si facile d'obtenir une vue immédiate de la hiérarchie.

    J'aime ce format (et je l'ai vu utilisé dans un certain nombre de places):

    SimpleClassName[prop1=value, prop2=value]
SimpleClassName[prop1=value, prop2=NestedObject[prop3=value]]

    Il y a également la possibilité d'ajouter un identifiant avec @, par exemple le style par défaut pour la commons-lang ToStringBuilder fait que (à l'aide de son propre exemple):

    Person@182f0db[name=John Doe,age=33,smoker=false]
    • Je l'aime, mais aucune idée de comment ces mailles avec toString utilisés par les différents cadres et d'autres projets open source?
    • +1 Bon de savoir que eclipse par défaut génère toString méthode dans ce format.
    • Je l'aime, mais une variante que je préfère est comme le Java Tutoriel où ils ne pas mettre des espaces après les virgules. Alors qu'il est de plus en plus dense, il a l'avantage d'être en mesure de voir les chaînes sans avoir à ajouter de devis caractères, si cela fait sens. Classe.getSimpleName() est utile au lieu de coder en dur, comme des Tableaux.toString() de la matrice de base de variables.
    InformationsquelleAutor Wouter Coekaerts
  2. 31

    Je pense que le format produit par Goyave's MoreObjects.toStringHelper() est assez sympa, mais c'est surtout juste bon d'avoir une certaine cohérence dans le format que vous utilisez:

    public String toString() {
  return Objects.toStringHelper(this)
      .add("prop1", prop1)
      .add("prop2", prop2)
      .toString();
}

//Produces "SimpleClassName{prop1=foo, prop2=bar}"
    InformationsquelleAutor ColinD
  3. 4

    json syntaxe semble correspondre assez bien car il a été conçu spécifiquement pour représenter des objets complexes comme des chaînes

    Person = {
    "firstName": "John",
    "lastName": "Smith",
    "age": 25,
    "address": 
    {
        "streetAddress": "21 2nd Street",
        "city": "New York",
        "state": "NY",
        "postalCode": "10021"
    },
    "phoneNumber": 
    [
        {
            "type": "home",
            "number": "212 555-1234"
        },
        {
            "type": "fax",
            "number": "646 555-4567"
        }
    ]
}
    • Je pense que toString devrait vraiment viser pour retourner une seule ligne, donc quelque chose comme json peut être trop verbeux.
    • il n'y a aucune raison que vous ne pouvait pas se condenser en une seule ligne
    • Droit, mais il serait encore assez détaillé sur les grands objets imbriqués.
    InformationsquelleAutor Brad Mace
  4. 3

    Pas une réponse directe à la question, cependant ci-dessous serait un gain de temps au cours du développement initial:

    Avertissement: Apache Commons bibliothèque est utilisée.

    1. Ajouter un nouveau Eclipse modèle appelé xreflect dans Java > Editor > Templates; Ajouter ci-dessous dans son modèle textarea:
    //---------- template start ----------- //
${:import(org.apache.commons.lang.builder.EqualsBuilder,org.apache.commons.lang.builder.HashCodeBuilder,org.apache.commons.lang.builder.ReflectionToStringBuilder)}
/*
 * (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
 */
@Override
public boolean equals(
        final Object pObj) {
    return EqualsBuilder.reflectionEquals(this, pObj);
}

/*
 * (non-Javadoc)
 * @see java.lang.Object#toString()
 */
@Override
public String toString() {
    return ReflectionToStringBuilder.toString(this);
}

/*
 * (non-Javadoc)
 * @see java.lang.Object#hashCode()
 */
@Override
public int hashCode() {
    return HashCodeBuilder.reflectionHashCode(this);
}
//---------- template end ----------- //
    1. Donner OK, OK
    2. Il suffit d'aller à la fin d'une classe Java, type xreflect et appuyez sur Ctrl + Espace pour la saisie automatique equals(), toString() et hashCode() méthodes automatiquement.
    InformationsquelleAutor KrishPrabakar
  5. 2

    Est-il un standard, ou tout simplement l'une des meilleures pratiques pour un style?

    Pas. Le "meilleur" de sortie pour un toString() méthode est déterminée par ce que vous voulez l'utiliser pour. Est-il pour la sérialisation de l'état de l'objet dans une forme qui lui permet d'être désérialisé? Est-il pour la création de messages de débogage? Est-il pour le rendu de l'objet d'affichage pour les utilisateurs finaux?

    Si vous souhaitez développer un style de la maison pour votre debug de journalisation/toString() méthodes, c'est bien. Mais s'il y avait une exigence pour cela, je ne serais pas la peine. IMO, c'est l'effort qui pourrait être mieux dépensé ailleurs.

    InformationsquelleAutor Stephen C
  6. 0

    Si vos objets ont quelque chose qui pourrait être utile comme un identifiant, j'aimerais mettre en place quelque chose comme votre deuxième exemple:

    [SimpleClassName:id] { prop1:value, prop2:[NestedObject:id] { prop3:value }}

    Où la id est tout ce qui fait sens pour que l'objet doit être un identificateur est le nom de l'canonique Person objet, une clé primaire pour un objet à partir d'une base de données, etc.

    InformationsquelleAutor zigdon
  7. 0

    Puisque vous m'avez demandé ce que d'autres projets open source pour, voici comment jEdit t-il, qui est similaire à Wouter de l':

    BufferChanging[what=BUFFER_CHANGING,source=org.gjt.sp.jedit.EditPane[active,global]]
    InformationsquelleAutor
  8. 0

    découvrez phps print_r($obj, true)
    ou aussi la fonction serialize (), pourrait travailler, ne sais pas exactement ce que son besoin pour.
    jsons est également une solution propre, surtout si tu veux importer les données en javascript environbments

    InformationsquelleAutor rthrwht