Nomi dei metodi per l'acquisizione dei dati [chiuso]

Attenzione: questa è una domanda / discussione non molto seria che sto postando ... ma sono pronto a scommettere che la maggior parte degli sviluppatori ha riflettuto su questo "problema" ...

Ho sempre voluto ottenere altre opinioni sulle convenzioni di denominazione per metodi che andavano e ricevevano dati da qualche parte e li restituivano ...

La maggior parte dei nomi dei metodi sono alquanto semplici e ovvi ... SaveEmployee (), DeleteOrder (), UploadDocument (). Ovviamente con le classi useresti molto probabilmente la forma abbreviata ... rispettivamente Save (), Delete (), Upload ().

Tuttavia, ho sempre lottato con l'azione iniziale ... come ottenere i dati. Sembra che per ogni progetto finisca per saltare tra diverse convenzioni di denominazione perché non sono mai abbastanza soddisfatto dell'ultima che ho usato. Per quanto ne so, queste sono le possibilità ->

• GetBooks ()
• FetchBooks ()
• Recupera libri ()
• FindBooks ()
• LoadBooks ()

Qual è il tuo pensiero?

Si tratta di semantica coerente ;

Nel titolo della tua domanda usi il recupero dei dati . Questo è estremamente generale, nel senso che è necessario definire cosa significa ottenere in modo semanticamente significativo e non ambiguo. Offro i seguenti esempi per sperare di metterti sulla strada giusta quando pensi di dare un nome alle cose.

1. getBooks() è quando ricevi tutti i libri associati a un oggetto, significa che i criteri per il set sono già definiti e la loro provenienza è un dettaglio nascosto.
2. findBooks(criteria) èquando si sta tentando di trovare un sottoinsieme di libri in base ai parametri della chiamata al metodo, questo di solito sarà sovraccaricato con criteri di ricerca diversi
3. loadBooks(source) è quando stai caricando da una fonte esterna, come un file o db.
4. Non userei fetch / retrieve perché sono troppo vaghi e vengono confusi con get e non vi è alcuna semantica univoca associata ai termini.

Esempio: fetch implica che qualche entità deve andare a prendere qualcosa che è remoto e riportarlo indietro. I cani prendono un bastone e recuperare è un sinonimo di recupero con la semantica aggiunta che potresti aver avuto anche il possesso della cosa prima. ottenere è anche un sinonimo di ottenere , il che implica che hai il possesso esclusivo di qualcosa e nessun altro può acquisirlo contemporaneamente.

La semantica è estremamente importante:

il ramo della linguistica e della logica che si occupa del significato

I commenti sono la prova che termini generici come get e fetch non hanno una semantica specifica e sono interpretati in modo diverso da persone diverse. Scegli una semantica per un termine, documenta ciò che si intende implicare se la semantica non è chiara ed essere coerente con il suo utilizzo.

parole con significati vaghi o ambigui ricevono una semantica diversa da persone diverse a causa dei loro pregiudizi e preconcetti basati sulle loro opinioni personali e questo non finirà mai bene.

Onestamente dovresti decidere con il tuo team quale convenzione di denominazione usare. Ma per divertimento, vediamo quale sarebbe la tua linea di pensiero per decidere su uno di questi:

• GetBooks ()

Questo metodo appartiene a un'origine dati e non ci interessa come ottenerli, vogliamo solo ottenerli dall'origine dati.

• FetchBooks ()

Tratti la tua fonte di dati come un segugio ed è suo compito recuperare i tuoi libri. Immagino che dovresti decidere da solo quanti può metterne in bocca contemporaneamente.

• FindBooks ()

La tua fonte dati è un bibliotecario e utilizzerà il sistema decimale Dewey per trovare i tuoi libri.

• LoadBooks ()

Questi libri appartengono a una sorta di "borsa per libri elettronici" e devono essere caricati al suo interno. Assicurati di chiamare ZipClosed () dopo il caricamento per evitare di perderli.

• Recupera libri ()

Non ho niente.

La risposta è semplicemente attenersi a ciò con cui ti senti a tuo agio ed essere coerente.

Se hai un sito web di barnes and nobles e usi GetBooks (), se hai un altro elemento come un'entità Movie usa GetMovies (). Quindi qualunque cosa piaccia a te e al tuo team e sii coerente.

In OO (C ++ / Java) tendo a usare getSomething e setSomething perché molto spesso, se non sempre, ottengo un attributo privato dalla classe che rappresenta quell'oggetto dati o lo sto impostando: la coppia getter / setter. Inoltre, Eclipse li genera per te.

Tendo ad usare Load solo quando intendo i file - come in "caricamento in memoria" e questo di solito implica il caricamento in primitive, strutture (C) o oggetti. Uso invio / ricezione per il web.

Come detto sopra, la coerenza è tutto e questo include cross-sviluppatori.

Non è chiaro cosa intendi per "ottenere i dati". Dal database? Un file? Memoria?

La mia opinione sulla denominazione dei metodi è che il suo ruolo è eliminare qualsiasi ambiguità e, idealmente, la necessità di cercare la documentazione. Credo che ciò dovrebbe essere fatto anche a costo di nomi di metodi più lunghi. Secondo gli studi, la maggior parte degli sviluppatori intermedi + è in grado di leggere più parole nel caso del cammello. Con IDE e completamenti automatici, anche la scrittura di nomi di metodo lunghi non è un problema.

Pertanto, quando vedo "fetchBooks", a meno che il contesto non sia molto chiaro (ad esempio, una classe denominata BookFetcherFromDatabase), è ambiguo. Prenderlo da dove? Qual'è la differenza tra fetch e find? Stai anche rischiando il problema che alcuni sviluppatori associno la semantica a determinate parole chiave. Ad esempio, recupero del database (o memoria) rispetto al caricamento (dal file) o al download (dal web).

Preferirei vedere qualcosa come "fetchBooksFromDatabase", "loadBookFromFile", "findBooksInCollection", ecc. È meno visibile, ma una volta superata la lunghezza, è chiaro. Tutti quelli che leggono questo capiranno subito quello che stai cercando di fare.