Quando devo criar um serviço ou uma função de utilitário?

Eu tive essa pergunta em mente durante toda a última semana: Quando devo criar um serviço ou uma função de utilitário?

No Drupal Core, temos as funções Serviços e Utilitários, mas não consigo encontrar a distinção entre elas (quando preciso criar um serviço ou quando preciso criar uma função utilitária).

Tomarei como exemplo o módulo Modules Weight , onde tenho a 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;
  }

}

Nesta classe, eu tenho duas funções estáticas, mas elas são funções utilitárias ou prepareDelta()é uma função utilitária e modulesList()devem estar em outra classe e ter um serviço?

A única diferença que encontrei nesse momento é que, dentro do espaço de nome Drupal \ Component \ Utility (onde você verá muitas funções de utilidade), nenhuma delas usa dentro de um serviço e, geralmente, um serviço usa outros serviços (eu não revise todos os serviços para validar isso).

Então, quando devo criar um serviço ou uma função de utilitário?

Em serviços de uso geral. Consulte a seguinte postagem no blog quando estiver OK para usar funções de utilitário estático:

Então nunca use estática?

Bem, não, existem casos de uso válidos. Uma é que, se você tiver uma lista de itens pré-definidos, estática, poderá ajudar a reduzir a memória, pois ela estará no nível da classe e não em nenhum caso.

Outros casos são métodos utilitários que não requerem dependências externas, por exemplo, um método slugify.

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

O método slug faz apenas um comportamento muito bem definido. É fácil levar o comportamento em consideração nos testes de unidade e não ficaria muito preocupado quando vir essa ligação.

Esses métodos podem até ser testados em unidade, pois não requerem inicialização.

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

(A quantidade de código estático agora no Drupal é devido à transição do código processual D7, portanto, não use o Drupal no estado atual como exemplo.)

Sobre o exemplo da pergunta, o restante da classe de utilitário (não mostrado na pergunta)

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

}

chama o serviço próprio do módulo em um wrapper estático:

\Drupal::service('modules_weight')

Provavelmente, isso ocorre porque a classe de utilitário é usada no código processual herdado. No código OOP, isso não é necessário, aqui você deve injetar o serviço diretamente.

Ken Rickard, do canal #contribute do Slack Drupal, diz: "Eu criaria um serviço se você espera que outros módulos (ou outros desenvolvedores) interajam com esse código. Os métodos utilitários são apenas atalhos privados para você."

Sim, uma coisa interessante sobre serviços é que qualquer um pode substituí-los. Portanto, se você deseja dar a outras pessoas a capacidade de personalizar um pedaço de código específico. Consulte Alterando serviços existentes, fornecendo serviços dinâmicos .

Além disso, você deve torná-lo um serviço se precisar fazer o teste Mock para o teste de unidade PHP. Consulte Serviços e injeção de dependência no Drupal 8 , consulte Unidade de teste de classes Drupal mais complicadas .

Perguntas e Respostas:

Teste de unidade de serviço

Escrevendo testes de unidade para um método que chama métodos estáticos de outra classe