Les noms de méthode d'obtention des données

Avertissement: Ce n'est pas très grave question/discussion que j'ai écris... mais je suis prêt à parier que la plupart des développeurs ont réfléchi à ce "problème"...

Toujours voulu obtenir d'autres opinions à l'égard des conventions de nommage pour les méthodes qui est allé et a obtenu des données à partir de quelque part et l'a retourné...

La plupart des noms de méthodes sont un peu simple et évident... SaveEmployee(), DeleteOrder(), UploadDocument(). Bien sûr, avec les cours, vous serait le plus susceptible d'utiliser le formulaire court...Save(), Delete(), Upload() respectivement.

Cependant, j'ai toujours eu du mal avec l'action initiale...comment obtenir les données. Il semble que, pour chaque projet, je finis par sauter entre les différentes conventions de nommage, car je ne suis jamais tout à fait heureux avec le dernier que j'ai utilisé. Aussi loin que je peux voir, ce sont les possibilités -->

  • GetBooks()
  • FetchBooks()
  • RetrieveBooks()
  • FindBooks()
  • LoadBooks()

Quelle est votre pensée?

InformationsquelleAutor Jason | 2010-01-26
  1. 107

    Il est tout au sujet de cohérence la sémantique;

    Dans votre question, le titre vous utilisez l'obtention de données. Ce qui est extrêmement
    général dans un sens que vous devez définir ce que arriver moyens
    du point de vue sémantique de manière significative sans ambiguïté. Je vous offre la suite
    des exemples nous l'espérons, pour vous mettre sur la bonne voie lorsque vous pensez à
    nommant les choses.

    1. getBooks() est quand vous obtenez
      tous les livres associés avec un
      objet, il implique les critères pour l'ensemble est
      déjà définis et d'où ils viennent est un détail caché.
    2. findBooks(criteria)
      c'est quand essaient de trouver un sous-ensemble
      des livres basés sur les paramètres de
      l'appel de la méthode, c'est généralement l'
      être surchargé de recherche différents
      critères
    3. loadBooks(source) , c'est quand vous êtes
      chargement à partir d'une source externe,
      comme un fichier ou une base de données.
    4. Je ne voudrais pas utiliser
      récupérer/récupérer parce qu'ils sont trop vagues et obtenir confondue avec obtenir et il n'est pas sans ambiguïté sémantique associée avec les termes.

    Exemple: fetch implique qu'une certaine entité doit aller chercher quelque chose qui est à distance et de le ramener. Les chiens d'aller chercher un bâton, et récupérer est synonyme de chercher avec l'ajout de sémantique que vous pourriez avoir eu la possession de la chose avant ainsi. get est synonyme de obtenir ainsi ce qui implique que vous avez seul la possession de quelque chose et personne ne peut l'acquérir simultanément.

    La sémantique sont extrêmement importants:

    la branche de la linguistique et de la logique concernés par sens

    Les commentaires sont la preuve que des termes génériques comme obtenir et chercher ont
    pas de sémantique spécifique et sont interprétées différemment par les différents
    personnes. Choisissez une sémantique d'un terme, d'un document à quoi il est destiné à
    implique si la sémantique n'est pas clair et cohérent avec son utilisation.

    mots avec vague ou ambiguë en ce sens sont donnés les différents sémantique par des personnes différentes en raison de leur predjudices et les préjugés fondés sur leurs opinions personnelles et qui ne finissent jamais bien.

    • J'ajouterais que je ne l'utiliserais récupérer/récupérer si les données devaient être récupéré à partir d'une base de données
    • Hmmm. Auriez-vous la distinction entre les critères génériques et des critères spécifiques. Par exemple, vous utilisez FindBooks(éditeur) lors de la recherche pour les livres d'un éditeur spécifique? Ou peut-être GetBooksFromPublisher(éditeur)?
    • publisher.getBooks() serait la préférée manière de faire, où a été l'éditeur d'une instance spécifique d'un Éditeur. De la bibliothèque.getBooks(éditeur), où l'éditeur a mis en œuvre un BookSearchCriteria interface. Même avec de la Bibliothèque.getBooks(auteur), où l'auteur a mis en œuvre un BookSearchCriteria interface. Vous aussi, vous avez logiquement avoir de la Bibliothèque.getPublishers() comme une méthode de fabrique
    • Merci pour cette réponse. Ajoute certainement un peu de clarté. En essence, vous dites que les méthodes d'extraction par un filtre particulier devrait rester avec l'objet. De quelle façon l'interface être utilisé? Par exemple, le BookSearchCriteria interface. Pouvez-vous donner un exemple de code?
    • voici une astuce de conception. vous devez vous efforcer de Couplage Lâche et Serré de Cohésion, google ces théories, mais voici la falaise notes, les Objets doivent s'appuyer sur quelques autres objets que possible et doit faire une chose et une seule chose de vraiment bien. Tout est dans le contexte.
    • lollipop: Belle réponse. Une autre question: d'Après votre réponse, getBooks() et loadBooks() ne semblent pas mutuellement exclusives. Quel nom choisiriez-vous lorsque les deux critères s'appliquent (la série de livres est clairement définie, cependant, ils doivent être récupérées à partir de la base de données)?
    • loadBooks() accès devrait être imbriquées à l'intérieur getBooks()
    • Diriez-vous listBooks() est équivalent à getBooks(), ou est-il une différence?
    • Roberson Comment auriez-vous le nom d'une méthode qui définit les propriétés de l'objet? Dans mon projet j'utilise pour obtenir des méthodes qui renvoient des données, mais il existe aussi des méthodes qui fonctionne à peu près la même chose que vous, mais au lieu de renvoyer des données, ils peuplent les propriétés de l'objet avec les données, et le préfixe de la charge. Quelles sont vos pensées sur cette question?
    • ce qui est terrible effet secondaire de programmation basé sur le C idiomes à partir des années 70. Couramment le Générateur de Pattern est ton ami.
    • généralement des noms comme fetch lorsque les données temps d'accès est faible, c'est à dire sur un même appareil, à partir de la base de données locale, de la mémoire.load, ou download si le temps d'accès est plus, à partir d'Internet, base de données externe, à partir d'un fichier
    • J'ai écrit cela il y a 8 ans et il tient encore bien.
    • Lorsque vous voulez charger un livre avec une certaine critères de votre source externe, utilisez-vous FindBook(criteria, source) ou LoadBook(source, criteria)? Et, ce qui serait un bon nom pour une fonction qui creates un objet dans votre source externe (insertion d'une ligne dans votre base de données). Serait create_and_save être approprié? Edit: une chance que nous pourrions allonger la liste des "bonnes"sémantique?

    InformationsquelleAutor
  2. 9

    Honnêtement, vous devez simplement décider avec votre équipe de convention de nommage. Mais pour le plaisir, permet de voir ce que votre train de pensée serait de décider sur l'un de ces:

    • GetBooks()

    Cette méthode appartient à une source de données, et nous ne se soucient pas comment il est l'obtention d'eux, nous voulons juste Obtenir de la source de données.

    • FetchBooks()

    Vous traiter votre source de données comme un chien de chasse, et c'est son travail pour aller chercher vos livres. Je suppose que vous devez décider vous-même comment beaucoup, il peut tenir dans sa bouche à la fois.

    • FindBooks()

    Votre source de données est un bibliothécaire et d'utiliser la classification Décimale de Dewey pour trouver vos livres.

    • LoadBooks()

    Ces livres appartiennent à une sorte de "livre électronique sac" et doit être chargé. Assurez-vous d'appeler ZipClosed() après le chargement, pour éviter de les perdre.

    • RetrieveBooks()

    Je n'ai rien.

    • L'on a accepté la réponse ne fait pas la distinction entre "get" et "fetch" ainsi que la présente réponse. Fetch implique qu'il doit être fait par quelqu'un d'autre, car il faudra un peu de temps et nécessite une certaine expertise à remplir, alors que d'obtenir implique c'est instantané et disponible en intégralité ou "off the shelf".
    • Moi aussi, je vais avoir des ennuis avec la accepté de répondre aujourd'hui. Pour mon projet (Réaction/Redux-base) je crois qu'il est important de faire la distinction entre les données extraites de la Redux store vs l'application de base de données vs un tiers de l'API. L'obtention de ce droit va certainement aider à la lisibilité de l'avenir. Développeur à l'origine utilisé add pour les deux écrit à une base de données et écrit à la banque. Maintenant, je vais essayer de séparer les personnes, et c'est une douleur.
    InformationsquelleAutor Nick Larsen
  3. 8

    La réponse est juste en tenez à ce que vous êtes à l'aise et d'être cohérent.

    Si vous avez un barnes et nobles site et que vous utilisez GetBooks(), alors si vous avez un autre élément comme un Film entité utilisation GetMovies(). Donc, tout ce que vous et votre équipe aime et être cohérent.

    • Au moins vous êtes cohérent dans la faute d'orthographe cohérente. 😉
    • Très consistante avec consistante...:)
    • Pas offensé du tout...je vous remercie pour ça.
    InformationsquelleAutor JonH
  4. 1

    Il n'est pas clair ce que tu veux dire par "obtenir les données". À partir de la base de données? Un fichier? De mémoire?

    Mon avis sur la méthode de nommage, c'est que son rôle est d'éliminer toute ambiguïté et, idéalement, d'un besoin de chercher de la documentation. Je crois que cela devrait être fait, même au prix de plus les noms de méthode. Selon des études, la plupart des intermédiaires+ les développeurs sont en mesure de lire plusieurs mots chameau cas. Avec l'IDE et l'auto complétion, la rédaction de longs noms de méthode est également pas un problème.

    Donc, quand je vois "fetchBooks", à moins que le contexte est très clair (par exemple, une classe nommée BookFetcherFromDatabase), il est ambigu. Va la chercher où? Quelle est la différence entre chercher et trouver? Vous êtes risquer aussi le problème que certains développeurs qui permettra d'associer une sémantique à certains mots-clés. Par exemple, l'extraction de la base de données (ou de mémoire) par rapport à la charge (à partir du fichier) ou le télécharger à partir du web).

    Je verrais plutôt quelque chose comme "fetchBooksFromDatabase", "loadBookFromFile", "findBooksInCollection", etc. Il est moins sightly, mais une fois que vous obtenez sur la longueur, c'est clair. Tout le monde la lecture de ce serait tout de suite ce qu'il est que vous essayez de faire.

    • Le problème avec fetchBooksFromDatabase, c'est quand vous voulez / facteur de généraliser et fetchBooks pourraient ensuite être certains tirant de données de XML. J'aime les détails, mais aussi vous ensuite de vous trouver séparant les mêmes fonctionnalités sur différents la fonction noms. Et ce monsieur n'est pas cool!
    • Je pense que la différence entre Obtenir versus Trouver tend à être évident, mais je me demande à propos de la question concernant Get par rapport à Récupérer. L'enfer..est-il une différence?
    • Je suis d'accord avec vous sur ce point. Toutefois, si vous saviez à l'avance que vous disposez de plusieurs types de fetch, vous avez encodé que dans le nommage des classes(de sorte que vous pourrait interpréter le sens à partir du contexte, par exemple, DatabaseConnector vs XmlConnector).
    • Parce que des "getters" sont si omniprésents (et qui font partie des cadres comme JavaBeans), de nombreux programmeurs ont tendance à les considérer comme des quasi-transparente de l'accès à un champ de données. "Fetch", d'autre part, indique à quelques programmeurs une plus longue d'accès qui implique le transfert de données d'un endroit à (la CPU extraction) ou de base de l'extraction. Par exemple, Hibernate query language a une Extraction de construire. Les développeurs utilisent souvent des méthodes basées sur leurs attentes de ce nom plutôt que par la lecture de la documentation afin d'éviter d'envoyer le mauvais signal est crucial.
    InformationsquelleAutor Uri
  5. 1

    En OO (C++/Java) j'ai tendance à utiliser getSomething et setSomething parce que très souvent, si pas toujours, je suis soit en obtenant un attribut privé de la classe représentant les données de l'objet ou de le définir - les getter/setter de la paire. En plus, Eclipse génère pour vous.

    J'ai tendance à utiliser la Charge seulement quand je veux dire que les fichiers - comme dans "charger dans la mémoire" et qui implique généralement le chargement dans les primitives, les structures (C) ou des objets. J'ai utiliser envoyer/recevoir pour le web.

    Comme dit ci-dessus, la cohérence est tout et qui comprend des développeurs.

    InformationsquelleAutor