Кілька аргументів у виклику функції проти одного масиву

У мене є функція, яка приймає набір параметрів, потім застосовує їх як умови до SQL-запиту. Однак, поки я віддав перевагу одному масиву аргументів, що містить самі умови:

function searchQuery($params = array()) {
    foreach($params as $param => $value) {
        switch ($param) {
            case 'name':
                $query->where('name', $value);
                break;
            case 'phone':
                $query->join('phone');
                $query->where('phone', $value);
                break;
        }
    }
}

Мій колега вважав за краще чітко перераховувати всі аргументи замість цього:

function searchQuery($name = '', $phone = '') {
    if ($name) {
        $query->where('name', $value);
    }

    if ($phone) {
        $query->join('phone');
        $query->where('phone', $value);
    }
}

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

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

searchQuery('', '', '', '', '', '', '', '', '', '', '', '', 'search_query')

ІМХО ваш колега правильний для наведеного вище прикладу. Ваші уподобання можуть бути лаконічними, але вони також менш читабельні і, отже, менш досяжні. Задайте питання, чому турбує написання функції в першу чергу, що ваша функція "підносить до столу" - я повинен зрозуміти, що вона робить і як це робить, дуже детально, просто щоб її використовувати. З його прикладом, хоча я не програміст PHP, я можу побачити достатньо деталей у декларації функції, що мені не доводиться турбуватися про її виконання.

Що стосується більшої кількості аргументів, це зазвичай вважається запахом коду. Зазвичай функція намагається зробити занадто багато? Якщо ви дійсно потребуєте великої кількості аргументів, ймовірно, вони пов'язані якимось чином і належать разом до однієї або кількох структур або класів (можливо, навіть масив пов’язаних елементів, таких як рядки в адресі). Однак передача неструктурованого масиву нічого не робить для вирішення коду запахів.

Моя відповідь - більш-менш агностична мова.

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

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

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

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

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

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

function searchQuery($params = array()) {
    foreach($params as $param => $value) {
        $query->where($param, $value);
    }
} 

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

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

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

function searchQuery($params = array()) {
    $defaults = array(
        'name' => '',
        'phone' => '',
        ....
    );
    $params = array_merge($defaults, $params);

    if(!empty($params['name'])) {
        $query->where('name', $params['name']);
    }
    if (!empty($params['phone'])) {
        $query->join('phone');
        $query->where('phone', $params['phone']);
    }
    ....
}

Крім того, ви можете передати рядок, що нагадує рядок запиту, і використовувати parse_str(оскільки, здається, ви використовуєте PHP, але інші рішення, ймовірно, доступні на інших мовах), обробити його в масив всередині методу:

/**
 * Executes a search in the DB with the constraints specified in the $queryString
 * @var $queryString string The search parameters in a query string format (ie
 *      "foo=abc&bar=hello"
 * @return ResultSet the result set of performing the query
 */
function searchQuery($queryString) {
  $params = parse_str($queryString);
  if (isset($params['name'])) {
    $query->where('name', $params['name']);
  }
  if (isset($params['phone'])) {
    $query->join('phone');
    $query->where('phone', $params['phone']);
  }
  ...

  return ...;
}

і називати це так

$result = searchQuery('name=foo&phone=555-123-456');

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