Когда я должен создать сервис или служебную функцию?

На протяжении всей прошлой недели я думал об этом: когда мне следует создать сервис или служебную функцию?

В ядре Drupal у нас есть функции Services и Utility, но я не могу найти различия между ними (когда мне нужно создать сервис или когда мне нужно создать сервисную функцию).

Я возьму в качестве примера модуль веса модулей, где у меня есть класс 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 (где вы увидите множество функций утилит) ни один из них не использует внутри службы, и обычно служба использует другие службы внутри (я не иметь обзор всех услуг, чтобы подтвердить это).

Итак, когда я должен создать сервис или служебную функцию?

В общем пользуюсь услугами. См. Следующий пост в блоге, когда можно использовать статические служебные функции:

Так никогда не использовать статический?

Ну нет, есть действительные варианты использования. Во-первых, статический список предопределенных элементов может помочь уменьшить объем памяти, поскольку он будет на уровне класса, а не в каких-либо случаях.

Другие случаи - это служебные методы, которые не требуют внешних зависимостей, например, метод slugify.

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

Метод slug делает только очень хорошо определенное поведение. Это легко принять во внимание в модульных тестах, и я не буду сильно беспокоиться, когда увижу этот вызов.

Эти методы могут даже быть проверены модулем, так как они не требуют инициализации.

Источник: 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')

Вероятно, это связано с тем, что служебный класс используется в устаревшем процедурном коде. В ООП-коде это не обязательно, здесь вы должны внедрить сервис напрямую.

Кен Рикард из канала Slack Drupal #contribute говорит: «Я бы создал службу, если вы ожидаете, что другие модули (или другие разработчики) будут взаимодействовать с этим кодом. Служебные методы - это всего лишь частные ярлыки для вас».

Да, классная вещь об услугах в том, что каждый может их перезаписать. Поэтому, если вы хотите дать другим людям возможность настраивать определенный фрагмент кода. См. Изменение существующих сервисов, предоставление динамических сервисов .

Кроме того, вы должны сделать это сервисом, если вам нужно провести пробное тестирование для PHP модульного тестирования. См. Сервисы и внедрение зависимостей в Drupal 8 , см. Модульное тестирование более сложных классов Drupal .

Q & A:

Сервисный тест

Написание модульных тестов для метода, который вызывает статические методы из другого класса