Найкраща практика - завершення, якщо навколо виклику функції проти додавання раннього виходу, якщо охорона функціонує

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

Я не запитую, який найкращий підхід, коли я виконую функцію, я запитую, чи слід я вийти зранку чи я просто не повинен викликати функцію.

Оберніть, якщо навколо дзвінка функції

if (shouldThisRun) {
  runFunction();
}

Увімкніть, якщо ( охоронець ) у функції

runFunction() {
  if (!shouldThisRun) return;
}

Остання опція, очевидно, має потенціал зменшення дублювання коду, якщо цю функцію викликають кілька разів, але іноді не потрібно додавати її сюди, оскільки тоді ви можете втратити єдину відповідальність функції.

Ось приклад

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

Я не впевнений, чи це лише я, але мені здається дещо брудним перевірити цю внутрішню функцію, оскільки я хочу зберегти цю функцію якомога більш чистою - якщо я її зателефоную, я очікую, що стан буде оновлений. Але я не можу сказати, чи краще перервати дзвінок під контролем у кількох місцях, де я знаю, що він може не змінитися.

Обгортання дзвінка if навколо функції:
Це означає, чи потрібно функцію взагалі викликати і є частиною процесу прийняття рішень у вашій програмі.

Застереження про функцію (раннє повернення):
це захист від виклику з недійсними параметрами

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

Логіка щодо того, чи взагалі викликати функцію, знаходиться на більш високому рівні абстракції, навіть якщо тільки просто. Він повинен існувати поза самою функцією. Як каже DocBrown, для спрощення коду ви можете мати проміжну функцію, яка виконує цю перевірку.

Це гарне запитання і підпадає під набір питань, що призводять до визнання рівнів абстракції. Кожна функція повинна функціонувати на одному рівні абстракції, а наявність логіки програми та логіки функції у вас відчуває себе неправильно - це тому, що вони знаходяться на різних рівнях абстракції. Сама функція - нижчий рівень.

Зберігаючи ці окремі дані, ви гарантуєте, що ваш код буде легше писати, читати та підтримувати.

Ви можете мати як функцію, яка не перевіряє параметри, так і іншу, яка робить, як це (можливо, повертає деяку інформацію про те, чи був виклик):

bool tryRunFunction(...)
{
    bool shouldThisRun = /* some logic using data not available inside "runFunction"*/;
    if (shouldThisRun)
        runFunction();
    return shouldThisRun;
}

Таким чином, ви можете уникнути повторюваної логіки, надавши багаторазову використання tryRunFunctionі все ж мати свою оригінальну (можливо, чисту) функцію, яка не робить перевірку всередині.

Зауважте, що іноді вам знадобиться функція на зразок tryRunFunctionінтегрованої перевірки, щоб ви могли інтегрувати чек runFunction. Або вам більше не потрібно повторно використовувати чек у будь-якій частині програми, і в цьому випадку ви можете дозволити йому залишатися у функції виклику.

Однак спробуйте зробити прозорим для абонента, що відбувається, давши своїм функціям належні імена. Таким чином, абоненти не повинні вгадувати чи вдивлятися у реалізацію, якщо їм доведеться робити перевірки самостійно або якщо викликана функція вже робить це для них. Простий префікс на зразок tryчасто може бути достатнім для цього.

Що стосується того, хто вирішує, чи потрібно балотуватися, відповідь - від GRASP , який є "знавцем інформації".

Після того, як ви вирішили це, розгляньте можливість перейменування функції для наочності.

Щось подібне, якщо функція вирішує:

 ensureUpdated()
 updateIfDirty()

Або, якщо абонент повинен вирішити:

 writeStatus()

Я хотів би розкрити відповідь @ Baldrickk.

Немає загальної відповіді на ваше запитання. Це залежить від значення (контракту) функції, яку потрібно викликати, та характеру умови.

Тож давайте обговоримо це в контексті Вашого прикладу updateStatus(). Це контракт, мабуть, полягає в оновленні якогось статусу, тому що сталося щось, що впливає на статус. Я очікую, що дзвінки до цього методу будуть дозволені, навіть якщо немає реальної зміни статусу, і будуть необхідні, якщо є реальна зміна.

Таким чином, сайт, що телефонує, може пропустити виклик, updateStatus()якщо він знає, що (всередині горизонту домену) нічого відповідного не змінилося. Ось такі ситуації, коли виклик повинен бути оточений відповідним ifконструктом.

Всередині updateStatus()функції можуть виникати ситуації, коли ця функція виявляє (за даними в її горизонті домену), що робити нічого, і саме там слід повернутися рано.

Отже, питання:

• Ззовні, коли дозволено / потрібно викликати функцію, враховуючи договір функції?
• Чи всередині функції існують ситуації, коли вона може повернутися рано, без реальної роботи?
• Чи відповідає умові, чи потрібно викликати функцію / повернутись рано, до внутрішньої області функції або зовні?

З updateStatus()функцією я б очікував побачити і те, і те, що викликає сайти, які нічого не знають, змінилося, пропустив виклик і перевірку реалізації на ранніх стадіях "нічого не змінилося", навіть якщо таким чином двічі перевіряється однаковий стан, обидва всередині і зовні.

Є багато хороших пояснень. Але я хочу виглядати незвично: Припустимо, що ви використовуєте цей спосіб:

if (shouldThisRun) {
   runFunction();
}

runFunction() {
   if (!shouldThisRun) return;
}

І вам потрібно викликати іншу функцію в runFunctionтакому методі:

runFunction() {
   if (!shouldThisRun) return;
   someOtherfunction();
}

Що ти робитимеш? Ви копіюєте всі перевірки зверху вниз?

someOtherfunction() {
   if (!shouldThisRun) return;
}

Я не думаю, що так. Таким чином, я зазвичай дотримуюся одного і того ж підходу: перевіряю вводи та перевіряю умови в publicметоді. Загальнодоступні методи повинні робити власні перевірки та перевіряти необхідні умови, навіть те, хто телефонує. Але нехай приватні методи просто займаються своїми справами . Деяка інша функція може зателефонувати, runFunctionне виконуючи перевірки або перевіряючи будь-яку умову.

public someFunction() {
   if (shouldThisRun) {
      runFunction();
   }
}

private runFunction() {
 // do your business.
}