Коли я повинен створити службу чи функцію утиліти?

Я мав на увазі це питання протягом усього останнього тижня: Коли я повинен створити службу чи функцію утиліти?

У Drupal Core у нас є і функції Служби, і Утиліта, але я не можу знайти їх різниці (коли мені потрібно створити службу або коли мені потрібно створити функцію утиліти).

Я візьму для прикладу модуль ваги модулів, де я маю клас InternalFunctions .

<?php

namespace Drupal\modules_weight\Utility;

class InternalFunctions {

  public static function prepareDelta($weight) {
    $delta = 100;

    $weight = (int) $weight;

    if ($weight > $delta) {
      return $weight;
    }

    if ($weight < -100) {
      return $weight * -1;
    }

    return $delta;
  }


  public static function modulesList($force = FALSE) {
    $modules = [];
    $installed_modules = system_get_info('module');

    $config_factory = \Drupal::service('config.factory');

    if ($force) {
      $show_system_modules = TRUE;
    }
    else {
modules.
      $show_system_modules = $config_factory->get('modules_weight.settings')->get('show_system_modules');
    }

    $modules_weight = $config_factory->get('core.extension')->get('module');

    foreach ($installed_modules as $filename => $module_info) {
      if (!isset($module_info['hidden']) && ($show_system_modules || $module_info['package'] != 'Core')) {
        $modules[$filename]['name'] = $module_info['name'];
        $modules[$filename]['description'] = $module_info['description'];
        $modules[$filename]['weight'] = $modules_weight[$filename];
        $modules[$filename]['package'] = $module_info['package'];
      }
    }
    uasort($modules, ['Drupal\Component\Utility\SortArray', 'sortByWeightElement']);

    return $modules;
  }

}

У цьому класі у мене є дві статичні функції, але вони обидві функції утиліти, або prepareDelta()це корисна функція, і вона modulesList()повинна бути в іншому класі та мати сервіс?

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

Отже, коли я повинен створити службу чи функцію утиліти?

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

Так ніколи не використовуйте статичну?

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

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

<?php
class Util
{
    public static function slug($string)
    {
        return strtolower(trim(preg_replace('/[^A-Za-z0-9-]+/', '_', $string)));
    }
}

Метод слизняків виконує лише дуже чітко визначену поведінку. Легко врахувати поведінку в одиничних тестах, і я б не надто хвилювався, коли бачу цей дзвінок.

Ці методи навіть можуть бути перевірені одиницею, оскільки вони не потребують ініціалізації.

Джерело: https://stovepipe.systems/post/avoiding-static-in-your-code

(Кількість статичного коду зараз у Drupal пов'язана з переходом від процедурного коду D7, тому не використовуйте Drupal у поточному стані як приклад.)

Про приклад із запитання, решта класу корисності (не вказано у запитанні)

<?php

namespace Drupal\modules_weight\Utility;

/**
 * Provides module internal helper methods.
 *
 * @ingroup utility
 */
class InternalFunctions {

...

  /**
   * Return the modules list ordered by the modules weight.
   *
   * @param bool $force
   *   Force to show the core modules.
   *
   * @return array
   *   The modules list.
   */
  public static function modulesList($force = FALSE) {
    // If we don't force we need to check the configuration variable.
    if (!$force) {
      // Getting the config to know if we should show or not the core modules.
      $force = \Drupal::service('config.factory')->get('modules_weight.settings')->get('show_system_modules');
    }
    // Getting the modules list.
    $modules = \Drupal::service('modules_weight')->getModulesList($force);

    return $modules;
  }

}

викликає власний сервіс модуля в статичній обгортці:

\Drupal::service('modules_weight')

Це, мабуть, тому, що клас корисності використовується у застарілому процесуальному коді. У коді OOP це не обов'язково, тут вам слід ввести послугу безпосередньо.

Кен Рікард із каналу Slack Drupal #contribute каже: "Я створив би сервіс, якщо ви очікуєте, що інші модулі (або інші розробники) взаємодіють із цим кодом. Корисні методи - це лише приватні ярлики для себе".

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

Крім того, вам слід зробити це послугою, якщо вам потрібно зробити Mock test для тестування модуля PHP. Див. Служби та введення залежності в Drupal 8 , див. Тестування блоку складніших класів Drupal .

Питання та відповіді:

Тест сервісного блоку

Написання одиничних тестів для методу, який викликає статичні методи з іншого класу