Як і чому вирішити між методами іменування з префіксами «дістати» та «знайти»

У мене завжди виникають проблеми з з'ясуванням, чи варто називати певний метод, починаючи з getSomethingпорівняння findSomething.

Проблема полягає у створенні помічників для погано розроблених API. Зазвичай це відбувається при отриманні даних від об'єкта, який вимагає об'єкт як параметр. Ось простий приклад:

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;
}

Як і чому вирішити між називанням цього методу як getRevision()або findRevision()?

Я використовую, Getколи знаю, що час пошуку буде дуже коротким (як у пошуку з хеш-таблиці або btree).

FindМає на увазі процес пошуку або обчислювальний алгоритм, для виконання якого потрібен "більший" проміжок часу (для деякого довільного значення довшого).

Я б сказав, що це findможе не вдатися, але getне повинно.

Цитувати розмову, яку я часто маю зі своїми дітьми:

я: Ей, дитино! Іди, знайди мені акумулятори

дитина: Але де вони?

я: Ось чому я сказав вам піти їх знайти . Якби я знав , де вони були, я сказав би вам піти отримати їх. Або ви могли запитати у своєї матері.

Така ж ідея:

• використовувати "get" для методу, який повертає недорогий доступний фрагмент інформації (і, ймовірно, може бути накреслений або іншим чином оптимізований), або для інформації, яка однозначно належить цьому об'єкту.

• використовувати "find" для методу, який працює, щоб отримати частину інформації, або використовує інші об'єкти для її пошуку.

Значення має на увазі відсутність результату, як, наприклад, при виконанні запиту до бази даних з деякими параметрами, які можуть змінюватися між викликами. Отримати, з іншого боку, означає, що результати відомі методу заздалегідь або не змінюватимуться колись відомо, що немає жодних параметрів для виклику.
Отже, я б використав, наприклад, клієнт findCustomerById (довгий customerId) та клієнт getCustomer ()

Я застосовую таку схему:

• Foo GetFoo() не може повернути нуль, і його складність становить O (log (n)) або менше
• bool TryGetFoo(out Foo) може повернути нуль, і його складність становить O (log (n)) або менше
• Foo FindFoo() не може повернути нуль, і його складність більше O (log (n))
• bool TryFindFoo(out Foo) може повернути нуль, і його складність більше O (log (n))

Таким чином код досить чіткий щодо намірів та складності, яку ви можете очікувати.

Як правило, Getters - це прямий список або доступ до словника / набору.
Finders здійснюють глибокий пошук, повне сканування списку тощо ...

У вашому випадку:

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;
    }
}

getдоречно в будь-якому випадку - насправді часто вважається, що для того, щоб отримати щось, потрібно знайти це першим. Тож якщо ви не впевнені, використовуйте get.

Я хотів би використовувати findдля методів , таких як findMinimum()або findOptimal(), тобто там , де є якийсь - то спеціальний алгоритм , який обчислює значення, що повертається, а не просто зробити запит до БД, файлова система, віддалений сервер і т.д. , щоб отримати якісь - то дані.

Не використовуйте префікси знахідки або отримання. Це порушення UniformAccessPrinciple, придумане bertrand meyer. Чому б не створити такий метод, як наступний:

public String revision(Item item)

Я, як правило, використовую Getдля отримання об'єкта / значення та Findдля пошуку його місця (наприклад, у масиві).

для:

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

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

Для мене, findмається на увазі, може бути, що існує більше ніж один результат. getпередбачає лише одне.