Khi nào tôi nên tạo một dịch vụ hoặc một chức năng tiện ích?

Tôi đã có câu hỏi này trong suốt tuần qua: Khi nào tôi nên tạo một dịch vụ hoặc một chức năng tiện ích?

Trong Lõi Drupal, chúng tôi có cả hai chức năng Dịch vụ và Tiện ích, nhưng tôi không thể tìm thấy sự khác biệt giữa chúng (khi tôi cần tạo dịch vụ hoặc khi tôi cần tạo chức năng tiện ích).

Tôi sẽ lấy ví dụ mô-đun Trọng lượng mô-đun nơi tôi có lớp InternalFifts .

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

}

Trong lớp này tôi có hai hàm tĩnh nhưng chúng đều là hàm tiện ích hoặc prepareDelta()là hàm tiện ích và modulesList()nên ở trong lớp khác và có dịch vụ?

Sự khác biệt duy nhất mà tôi tìm thấy tại thời điểm này là bên trong không gian tên Drupal \ Element \ Utility (nơi bạn sẽ thấy rất nhiều tiện ích) không ai trong số họ sử dụng bên trong một dịch vụ và thường là một dịch vụ sử dụng các dịch vụ khác bên trong (Tôi không đã xem xét tất cả các dịch vụ để xác nhận điều này).

Vì vậy, khi tôi nên tạo một dịch vụ hoặc một chức năng tiện ích?

Trong dịch vụ sử dụng chung. Xem bài đăng blog sau đây khi sử dụng các chức năng tiện ích tĩnh:

Vậy không bao giờ sử dụng tĩnh?

Vâng không, có trường hợp sử dụng hợp lệ. Một là nếu bạn có một danh sách các mục được xác định trước tĩnh có thể giúp giảm bộ nhớ vì nó sẽ ở cấp độ lớp và không phải trong bất kỳ trường hợp nào.

Các trường hợp khác là các phương thức tiện ích không yêu cầu phụ thuộc bên ngoài, ví dụ như phương thức slugify.

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

Phương pháp sên chỉ thực hiện một hành vi được xác định rất tốt. Thật dễ dàng để đưa hành vi vào tài khoản trong các bài kiểm tra đơn vị và tôi sẽ không quá lo lắng khi thấy cuộc gọi này.

Các phương thức này thậm chí có thể được kiểm tra đơn vị vì chúng không yêu cầu khởi tạo.

Nguồn: https://stovepipe.systems/post/avoiding-static-in-your-code

(Số lượng mã tĩnh hiện tại trong Drupal là do quá trình chuyển đổi từ mã D7 theo thủ tục, vì vậy đừng sử dụng Drupal ở trạng thái hiện tại làm ví dụ.)

Về ví dụ từ câu hỏi, phần còn lại của lớp tiện ích (không được hiển thị trong câu hỏi)

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

}

gọi dịch vụ riêng của mô-đun trong một trình bao bọc tĩnh:

\Drupal::service('modules_weight')

Điều này có thể là do lớp tiện ích được sử dụng trong mã thủ tục kế thừa. Trong mã OOP, điều này là không cần thiết, ở đây bạn nên tiêm dịch vụ trực tiếp.

Ken Rickard từ kênh Slack Drupal #contribution nói: "Tôi sẽ tạo ra một dịch vụ nếu bạn mong đợi các mô-đun khác (hoặc nhà phát triển khác) tương tác với mã đó. Phương thức tiện ích chỉ là lối tắt riêng cho chính bạn."

Vâng, một điều thú vị về dịch vụ là bất cứ ai cũng có thể ghi đè lên chúng. Vì vậy, nếu bạn muốn cung cấp cho người khác khả năng tùy chỉnh một đoạn mã cụ thể. Xem Thay đổi dịch vụ hiện có, cung cấp dịch vụ động .

Ngoài ra, bạn nên biến nó thành một dịch vụ nếu bạn cần thực hiện kiểm tra Mock để kiểm tra Đơn vị PHP. Xem Dịch vụ và tiêm phụ thuộc trong Drupal 8 , xem Đơn vị kiểm tra các lớp Drupal phức tạp hơn .

Hỏi và đáp:

Kiểm tra đơn vị dịch vụ

Viết đơn vị kiểm tra cho một phương thức gọi các phương thức tĩnh từ một lớp khác