Quand dois-je créer un service ou une fonction utilitaire?

J'ai eu cette question en tête toute la semaine dernière: quand devrais-je créer un service ou une fonction utilitaire?

Dans le Drupal Core, nous avons à la fois des services et des fonctions utilitaires, mais je ne trouve pas la distinction entre eux (quand j'ai besoin de créer un service ou quand j'ai besoin de créer une fonction utilitaire).

Je vais prendre comme exemple le module Modules Weight où j'ai la classe 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;
  }

}

Dans cette classe, j'ai deux fonctions statiques, mais ce sont toutes les deux des fonctions utilitaires ou prepareDelta()une fonction utilitaire et modulesList()devraient être dans une autre classe et avoir un service?

La seule différence que j'ai trouvée à ce moment est qu'à l'intérieur de l'espace de noms Drupal \ Component \ Utility (où vous verrez beaucoup de fonctions utilitaires) aucun d'eux n'utilise à l'intérieur d'un service et généralement un service utilise un autre service à l'intérieur (je ne le fais pas avoir revu tous les services pour valider cela).

Alors, quand devrais-je créer un service ou une fonction utilitaire?

Dans les services à usage général. Consultez le billet de blog suivant lorsqu'il est OK d'utiliser des fonctions utilitaires statiques:

Alors n'utilisez jamais d'électricité statique?

Eh bien non, il existe des cas d'utilisation valides. La première est que si vous avez une liste d'éléments prédéfinis, la statique peut aider à réduire la mémoire car elle sera au niveau de la classe et pas dans tous les cas.

D'autres cas sont des méthodes utilitaires qui ne nécessitent pas de dépendances extérieures, par exemple une méthode slugify.

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

La méthode slug ne fait qu'un comportement très bien défini. Il est facile de prendre en compte le comportement dans les tests unitaires et je ne serais pas trop inquiet en voyant cet appel.

Ces méthodes peuvent même être testées unitairement car elles ne nécessitent pas d'initialisation.

Source: https://stovepipe.systems/post/avoiding-static-in-your-code

(La quantité de code statique maintenant dans Drupal est due à la transition du code procédural D7, donc n'utilisez pas Drupal dans l'état actuel comme exemple.)

À propos de l'exemple de la question, le reste de la classe d'utilité (non montré dans la question)

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

}

appelle le propre service du module dans un wrapper statique:

\Drupal::service('modules_weight')

Cela est probablement dû au fait que la classe utilitaire est utilisée dans le code procédural hérité. Dans le code POO, cela n'est pas nécessaire, vous devez ici injecter le service directement.

Ken Rickard de Slack Drupal #contribute channel dit: "Je créerais un service si vous vous attendez à ce que d'autres modules (ou d'autres développeurs) interagissent avec ce code. Les méthodes utilitaires ne sont que des raccourcis privés pour vous-même."

Oui, une chose intéressante à propos des services est que n'importe qui peut les remplacer. Donc, si vous souhaitez donner à d'autres personnes la possibilité de personnaliser un morceau de code particulier. Voir Modification des services existants, fourniture de services dynamiques .

De plus, vous devriez en faire un service si vous avez besoin de faire un test Mock pour les tests unitaires PHP. Voir Services et injection de dépendances dans Drupal 8 , voir Tests unitaires de classes Drupal plus compliquées .

Q & R:

Test d'unité de service

Écriture de tests unitaires pour une méthode qui appelle des méthodes statiques d'une autre classe