Kiedy powinienem utworzyć usługę lub funkcję narzędziową?

Przez cały tydzień myślałem o tym: kiedy powinienem stworzyć usługę lub funkcję użyteczności?

W Drupal Core mamy zarówno funkcje Usługi, jak i Narzędzie, ale nie mogę znaleźć rozróżnienia między nimi (kiedy muszę utworzyć usługę lub kiedy muszę utworzyć funkcję narzędzia).

Jako przykład wezmę moduł Moduły wagi , w którym mam klasę 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;
  }

}

W tej klasie mam dwie funkcje statyczne, ale obie są funkcjami użytecznymi, czy też prepareDelta()są funkcjami użytecznymi i modulesList()powinny być w innej klasie i mieć usługę?

Jedyną różnicą, którą znalazłem w tym momencie, jest to, że w przestrzeni nazw Drupal \ Component \ Utility (gdzie zobaczysz wiele funkcji narzędzi) żadna z nich nie korzysta z usługi i zwykle usługa korzysta z innych usług w środku (ja nie przejrzyj wszystkie usługi, aby to potwierdzić).

Kiedy więc powinienem utworzyć usługę lub funkcję narzędziową?

W ogólnym użyciu usługi. Zobacz następujący post na blogu, gdy korzystanie ze statycznych funkcji narzędzia jest w porządku:

Więc nigdy nie używaj statycznego?

Cóż, nie, istnieją ważne przypadki użycia. Jednym z nich jest to, że jeśli masz listę predefiniowanych elementów, static może pomóc zmniejszyć pamięć, ponieważ będzie ona na poziomie klasy, a nie w żadnym przypadku.

Inne przypadki to metody narzędziowe, które nie wymagają zewnętrznych zależności, na przykład metoda slugify.

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

Metoda ślimaka ma tylko bardzo dobrze zdefiniowane zachowanie. Łatwo jest wziąć to pod uwagę w testach jednostkowych i nie martwiłbym się zbytnio, gdy widzę to wezwanie.

Te metody mogą być nawet testowane jednostkowo, ponieważ nie wymagają inicjalizacji.

Źródło: https://stovepipe.systems/post/avoiding-static-in-your-code

(Ilość kodu statycznego teraz w Drupal wynika z przejścia od kodu D7 proceduralnego, więc nie używaj Drupala w obecnym stanie jako przykładu.)

O przykładzie z pytania, reszcie klasy użyteczności (nie pokazanej w pytaniu)

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

}

wywołuje własną usługę modułu w statycznym opakowaniu:

\Drupal::service('modules_weight')

Jest tak prawdopodobnie dlatego, że klasa użyteczności jest używana w starszym kodzie proceduralnym. W kodzie OOP nie jest to konieczne, tutaj należy wstrzyknąć usługę bezpośrednio.

Ken Rickard z kanału Slack Drupal #contribute mówi: „Stworzyłbym usługę, jeśli oczekujesz, że inne moduły (lub inni programiści) będą współpracować z tym kodem. Metody użytkowe to po prostu prywatne skróty”.

Tak, fajną rzeczą w usługach jest to, że każdy może je zastąpić. Więc jeśli chcesz dać innym ludziom możliwość dostosowania określonego fragmentu kodu. Zobacz Zmiana istniejących usług, dostarczanie usług dynamicznych .

Ponadto powinieneś uczynić go usługą, jeśli chcesz wykonać próbny test do testowania jednostek PHP. Zobacz Usługi i wstrzykiwanie zależności w Drupal 8 , zobacz Testowanie jednostek bardziej skomplikowanych klas Drupal .

Pytania i odpowiedzi:

Test jednostki serwisowej

Pisanie testów jednostkowych dla metody wywołującej metody statyczne z innej klasy