Jak i dlaczego decydować między metodami nazewnictwa z prefiksami „get” i „find”

Zawsze mam problem z ustaleniem, czy powinienem nazwać określoną metodę zaczynającą się od getSomethingkontra findSomething.

Problem polega na tworzeniu pomocników dla źle zaprojektowanych interfejsów API. Dzieje się tak zwykle podczas pobierania danych z obiektu, który wymaga obiektu jako parametru. Oto prosty przykład:

public String getRevision(Item item) {
    service.load(item, "revision");
    // there is usually more work to do before getting the data..
    try {
        return item.get_revision();
    }
    catch(NotLoadedException exception) {
        log.error("Property named 'property_name' was not loaded", exception);
    }
    return null;
}

Jak i dlaczego decydować między nazwaniem tej metody jako getRevision()lub findRevision()?

Używam, Getgdy wiem, że czas pobierania będzie bardzo krótki (jak w przypadku wyszukiwania z tabeli skrótów lub btree).

Findimplikuje proces wyszukiwania lub algorytm obliczeniowy, którego wykonanie wymaga „dłuższego” okresu (dla pewnej dłuższej wartości).

Powiedziałbym, że to findmoże zawieść, ale getnie powinno.

Cytując rozmowę, którą często prowadzę z moimi dziećmi:

ja: hej dzieciaku! Znajdź mi baterie

dzieciak: Ale gdzie oni są?

ja: Właśnie dlatego kazałem ci je znaleźć . Gdybym wiedział, gdzie oni są, powiedziałbym, żebyś poszedł po nie. Lub możesz zapytać swoją matkę.

Ten sam pomysł dotyczy:

• użyj „get” dla metody, która zwraca tanio dostępną informację (i prawdopodobnie może być wstawiona lub w inny sposób zoptymalizowana), lub dla informacji posiadanej wyłącznie przez ten obiekt.

• użyj „find” dla metody, która działa, aby uzyskać kawałek informacji lub używa innych obiektów, aby go znaleźć.

Znajdź oznacza brak wyniku, na przykład podczas wykonywania zapytania do bazy danych z niektórymi parametrami, które mogą się zmieniać między wywołaniami. Z drugiej strony, uzyskanie sugeruje, że wyniki są znane metodzie wcześniej lub nie zmienią się, gdy zostaną poznane, że nie ma parametrów wywołania.
Więc użyłbym na przykład Customer findCustomerById (długi customerId) i Customer getCustomer ()

Stosuję następujący wzór:

• Foo GetFoo() nie może zwrócić wartości null, a jego złożoność wynosi O (log (n)) lub mniej
• bool TryGetFoo(out Foo) może zwrócić null, a jego złożoność wynosi O (log (n)) lub mniej
• Foo FindFoo() nie może zwrócić null, a jego złożoność jest większa niż O (log (n))
• bool TryFindFoo(out Foo) może zwrócić null, a jego złożoność jest większa niż O (log (n))

W ten sposób kod jest dość jasny pod względem intencji i złożoności, jakiej można się spodziewać.

Zazwyczaj Gettery są przeznaczone do bezpośredniego dostępu do listy lub słownika / zestawu.
Findery to dokładne wyszukiwanie, pełne skanowanie listy itp.

W Twoim przypadku:

public bool TryGetRevision( Item item, out String revision ) 
{
    service.load( item, "revision" );
    // there is usually more work to do before getting the data..
    try 
    {
        revision = item.get_revision();
        return true;
    }
    catch( NotLoadedException exception )
    {
        log.error( "Property named 'property_name' was not loaded", exception );
        revision = "";
        return false;
    }
}

getjest odpowiednie w każdym przypadku _ w rzeczywistości często zakłada się, że aby coś uzyskać, musisz to najpierw znaleźć. Więc jeśli nie jesteś pewien, użyj get.

Użyłbym finddo metod takich jak findMinimum()lub findOptimal(), tj. Tam, gdzie istnieje jakiś specjalny algorytm, który oblicza wartość zwracaną, a nie po prostu wysyła do DB, systemu plików, zdalnego serwera itp. Żądanie otrzymania danych.

Nie używaj znajdź ani nie otrzymuj prefiksów. Jest to naruszenie zasady UniformAccessPrinciple wymyślonej przez Bertranda Meyera . Dlaczego nie stworzyć metody takiej jak poniżej:

public String revision(Item item)

Zasadniczo będę używać Getdo pobierania obiektu / wartości i Finddo wyszukiwania jego położenia (na przykład w tablicy).

na przykład:

object o = obj.GetItem( 'name');

integer i = somearray.Find( 'name');

Dla mnie findoznacza to, że może być obecny więcej niż jeden wynik. getimplikuje tylko jeden.