核心要點(diǎn)

• Drupal 8 的 ConfigFormBase 類提供了額外的功能來與配置系統(tǒng)交互，允許將表單轉(zhuǎn)換為存儲(chǔ)值的工具。這可以通過用 ConfigFormBase 替換擴(kuò)展類并在表單中進(jìn)行必要的更改來實(shí)現(xiàn)。Drupal 8 中的配置存儲(chǔ)在 YAML 文件中，可以通過 UI 進(jìn)行更改，以便跨不同站點(diǎn)部署。
• Drupal 8 中的服務(wù)容器允許創(chuàng)建服務(wù)，即執(zhí)行全局操作的 PHP 類，并將其注冊(cè)到服務(wù)容器中以供訪問。依賴注入用于將對(duì)象傳遞給其他對(duì)象，確保解耦。可以通過在模塊的根目錄中創(chuàng)建 demo.services.yml 文件來注冊(cè)服務(wù)。
• Drupal 8 中的依賴注入是一種設(shè)計(jì)模式，允許一個(gè)對(duì)象提供另一個(gè)對(duì)象的依賴項(xiàng)，使代碼更模塊化且更易于測(cè)試。這可以通過擴(kuò)展 ControllerBase 類或?qū)崿F(xiàn) ContainerInjectionInterface 來實(shí)現(xiàn)。還可以使用 Drupal 類全局訪問服務(wù)。

請(qǐng)注意，由于撰寫本文時(shí) Drupal 8 正在進(jìn)行開發(fā)過程，因此某些代碼部分可能已過時(shí)。請(qǐng)查看此存儲(chǔ)庫，我嘗試更新示例代碼并使其與最新的 Drupal 8 版本兼容。

在之前的關(guān)于 Drupal 8 模塊開發(fā)的文章中，我們研究了創(chuàng)建塊類型和表單。我們已經(jīng)看到塊現(xiàn)在是可重用的，以及定義塊類型所需的一切都在一個(gè)類中完成。類似地，表單生成函數(shù)也分組在一個(gè)類中，其中特定方法執(zhí)行的任務(wù)類似于我們?cè)?Drupal 7 中習(xí)慣的任務(wù)。

在本教程中，我將從我們上次結(jié)束的地方繼續(xù)。我將說明如何將我們的 DemoForm 轉(zhuǎn)換為用于通過 Drupal 8 配置系統(tǒng)存儲(chǔ)值的表單。之后，我們將通過示例說明服務(wù)容器和依賴注入。

別忘了，如果您想獲取本教程系列中編寫的全部代碼，可以查看此存儲(chǔ)庫。

配置表單

當(dāng)我們第一次定義 DemoForm 時(shí)，我們擴(kuò)展了 FormBase 類，這是 FormInterface 的最簡單實(shí)現(xiàn)。但是，Drupal 8 還附帶了一個(gè) ConfigFormBase，它提供了一些附加功能，使與配置系統(tǒng)交互變得非常容易。

我們現(xiàn)在要做的是將 DemoForm 轉(zhuǎn)換為一個(gè)用于存儲(chǔ)用戶輸入的電子郵件地址的表單。我們應(yīng)該做的第一件事是用 ConfigFormBase 替換擴(kuò)展類（當(dāng)然還要 use 它）：

use Drupal\Core\Form\ConfigFormBase;

class DemoForm extends ConfigFormBase {

在我們繼續(xù)更改表單中的其他內(nèi)容之前，讓我們了解一下 Drupal 8 中的簡單配置是如何工作的。我說“簡單”，因?yàn)檫€有更復(fù)雜的配置實(shí)體，我們今天不會(huì)介紹。就目前而言，模塊（核心或 contrib）提供的配置存儲(chǔ)在 YAML 文件中。啟用模塊后，此數(shù)據(jù)將導(dǎo)入到數(shù)據(jù)庫中（以便在使用時(shí)提高性能）。通過 UI，我們可以更改此配置，然后可以輕松地將其導(dǎo)出到 YAML 文件中，以便跨不同站點(diǎn)部署。

模塊可以在模塊根目錄的 config/install 文件夾中提供一個(gè) YAML 文件中的默認(rèn)配置。此文件的命名約定是在其前面加上模塊的名稱。因此，讓我們創(chuàng)建一個(gè)名為 demo.settings.yml 的文件。在這個(gè)文件中，讓我們粘貼以下內(nèi)容：

demo:
  email_address: demo@demo.com

這是一個(gè)嵌套結(jié)構(gòu)（就像 PHP 中的關(guān)聯(lián)數(shù)組）。在 demo 鍵下，我們有另一個(gè)鍵值對(duì)。通常，要訪問這些嵌套值，我們使用點(diǎn) (.)。在我們的例子中是 demo.email_address。

一旦我們有了這個(gè)文件，你需要記住的一件重要事情是，只有在安裝模塊時(shí)才會(huì)導(dǎo)入此文件。因此，繼續(xù)重新安裝它。現(xiàn)在我們可以回到我們的表單并逐一查看需要調(diào)整的方法。

這就是 buildForm() 方法現(xiàn)在的樣子：

public function buildForm(array $form, array &$form_state) {

  $form = parent::buildForm($form, $form_state);

  $config = $this->config('demo.settings');

  $form['email'] = array(
    '#type' => 'email',
    '#title' => $this->t('Your .com email address.'),
    '#default_value' => $config->get('demo.email_address')
  );

  return $form;
}

首先，與 FormBase 相反，ConfigFormBase 類也實(shí)現(xiàn)了此方法，以便向表單數(shù)組（提交按鈕）添加元素。因此，在添加我們自己的元素之前，我們可以使用父類之前所做的操作。

現(xiàn)在對(duì)于配置部分。Drupal 8 提供了一個(gè) Config 對(duì)象，我們可以用它來與配置交互。某些類已經(jīng)通過依賴注入獲得了它。ConfigFormBase 就是這樣一個(gè)類。

如您所見，我們正在使用父類的 config() 方法來檢索一個(gè) Config 對(duì)象，該對(duì)象已填充我們的 demo.settings 簡單配置。然后，對(duì)于電子郵件表單元素的 #default_value，我們使用 Config 對(duì)象的 get() 方法來檢索電子郵件地址的值。

接下來，我們只需要更改提交處理程序，因?yàn)?validateForm() 方法現(xiàn)在可以保持不變：

public function submitForm(array &$form, array &$form_state) {

  $config = $this->config('demo.settings');
  $config->set('demo.email_address', $form_state['values']['email']);
  $config->save();

  return parent::submitForm($form, $form_state);
}

在此方法中，我們首先檢索我們配置的 Config 對(duì)象（就像我們之前做的那樣）。然后，我們使用它的 set() 方法將 email_address 的值更改為用戶提交的值。然后我們使用 save() 方法保存配置。最后，我們擴(kuò)展了父提交處理程序，因?yàn)樗_實(shí)包含一些功能（在這種情況下，它會(huì)將 Drupal 消息設(shè)置為屏幕）。

就是這樣。您可以清除緩存并試一試。通過提交一個(gè)新的電子郵件地址，您將其存儲(chǔ)在配置中。demo.settings.yml 文件當(dāng)然不會(huì)更改，但是您可以去導(dǎo)出 demo.settings 配置并將其導(dǎo)入到另一個(gè)站點(diǎn)。

服務(wù)容器和依賴注入

接下來我們要看的是服務(wù)容器。服務(wù)背后的理念是將功能分解成可重用的組件。因此，服務(wù)是一個(gè)執(zhí)行某些全局操作并注冊(cè)到服務(wù)容器以便訪問的 PHP 類。

依賴注入是我們傳遞對(duì)象以確保解耦的方式。每個(gè)服務(wù)都需要處理一件事情，如果它需要另一個(gè)服務(wù)，則后者可以注入到前者中。但我們馬上就會(huì)看到如何操作。

接下來，我們將創(chuàng)建一個(gè)非常簡單的服務(wù)并將其注冊(cè)到容器中。它只有一個(gè)真正的返回簡單值的方法。然后，我們將該服務(wù)作為依賴項(xiàng)注入到我們的 DemoController 中并使用服務(wù)提供的值。

為了注冊(cè)服務(wù)，我們需要?jiǎng)?chuàng)建一個(gè)位于模塊根目錄的 demo.services.yml 文件，其內(nèi)容如下：

use Drupal\Core\Form\ConfigFormBase;

class DemoForm extends ConfigFormBase {

文件命名約定是 module_name.services.yml。

第一行創(chuàng)建了一個(gè)服務(wù)數(shù)組。第二行定義了第一個(gè)服務(wù)（稱為 demo_service，以模塊名稱為前綴）。第三行指定將為此服務(wù)實(shí)例化的類。接下來是在我們模塊的 src/ 文件夾中創(chuàng)建 DemoService.php 類文件。這就是我的服務(wù)所做的（實(shí)際上什么也沒有，只是為了說明如何使用它）：

demo:
  email_address: demo@demo.com

這里不需要解釋任何內(nèi)容，因?yàn)樗浅；A(chǔ)。接下來，讓我們轉(zhuǎn)向我們的 DemoController 并使用此服務(wù)。我們可以通過兩種方式做到這一點(diǎn)：通過 Drupal 類全局訪問容器或使用依賴注入將此類的對(duì)象傳遞給我們的控制器。最佳實(shí)踐建議我們應(yīng)該采用第二種方式，所以這就是我們將要做的。但有時(shí)您需要全局訪問服務(wù)。為此，您可以執(zhí)行以下操作：

public function buildForm(array $form, array &$form_state) {

  $form = parent::buildForm($form, $form_state);

  $config = $this->config('demo.settings');

  $form['email'] = array(
    '#type' => 'email',
    '#title' => $this->t('Your .com email address.'),
    '#default_value' => $config->get('demo.email_address')
  );

  return $form;
}

現(xiàn)在 $service 是我們剛剛創(chuàng)建的 DemoService 類的對(duì)象。但是讓我們看看如何在 DemoController 類中將我們的服務(wù)作為依賴項(xiàng)注入。我將首先解釋需要做什么，然后您將看到包含所有對(duì)其進(jìn)行的更改的完整控制器。

首先，我們需要訪問服務(wù)容器。對(duì)于控制器來說，這非常容易。我們可以擴(kuò)展 ControllerBase 類，這除了其他一些幫助程序之外還給我們提供了這一點(diǎn)?；蛘撸覀兊目刂破骺梢詫?shí)現(xiàn) ContainerInjectionInterface，這也可以讓我們?cè)L問容器。但是我們將堅(jiān)持使用 ControllerBase，因此我們需要 use 該類。

接下來，我們需要 use Symfony 2 ContainerInterface 作為 create() 方法的要求，該方法實(shí)例化控制器的另一個(gè)對(duì)象并將我們想要的服務(wù)傳遞給它。

最后，我們將需要一個(gè)構(gòu)造函數(shù)來獲取傳遞的服務(wù)對(duì)象（create() 返回的對(duì)象）并將它們分配給屬性以供以后使用。create() 方法返回對(duì)象的順序需要反映它們傳遞給構(gòu)造函數(shù)的順序。

因此，讓我們看看我們修改后的 DemoController：

use Drupal\Core\Form\ConfigFormBase;

class DemoForm extends ConfigFormBase {

如您所見，所有步驟都在這里。create() 方法創(chuàng)建了我們控制器類的新實(shí)例，并將從容器檢索的服務(wù)傳遞給它。最后，DemoService 類的實(shí)例存儲(chǔ)在 $demoService 屬性中，我們可以使用它來調(diào)用其 getDemoValue() 方法。然后，此值將用于“Hello”消息中。清除緩存并試一試。轉(zhuǎn)到 demo/ 路徑，您應(yīng)該看到頁面上打印的“Hello Upchuk！”。

我相信您可以看到服務(wù)容器的強(qiáng)大功能，因?yàn)槲覀儸F(xiàn)在可以編寫解耦的功能并將其傳遞到需要的地方。我沒有向您展示如何操作，但是您也可以在注冊(cè)服務(wù)時(shí)聲明依賴項(xiàng)。這意味著當(dāng) Drupal 實(shí)例化服務(wù)對(duì)象時(shí)，它也將為其所有依賴項(xiàng)這樣做，并將它們傳遞給其構(gòu)造函數(shù)。您可以在此文檔頁面上閱讀有關(guān)如何執(zhí)行此操作的更多信息。

結(jié)論

在本文中，我們研究了很多很酷的東西。我們已經(jīng)看到了配置系統(tǒng)如何管理簡單的配置以及為此提供的哪些“表單”功能。我鼓勵(lì)您探索 ConfigFormBase 的實(shí)現(xiàn)方式以及擴(kuò)展它時(shí)可用的功能。此外，您應(yīng)該在 UI 中使用在站點(diǎn)之間導(dǎo)入/導(dǎo)出配置進(jìn)行練習(xí)。從現(xiàn)在開始，這將是對(duì)部署過程的一大改進(jìn)。

然后，我們研究了服務(wù)、它們是什么以及它們?nèi)绾喂ぷ?。一種維護(hù)可重用且解耦的功能塊的好方法，這些功能塊可從任何地方訪問。我希望依賴注入的概念不再那么可怕（如果它對(duì)您來說是的話）。它基本上等同于將參數(shù)傳遞給過程函數(shù)，但由 Symfony 及其強(qiáng)大的服務(wù)容器在幕后使用構(gòu)造函數(shù)方法（或 setter）完成。

關(guān)于構(gòu)建 Drupal 8 模塊的常見問題：配置管理和服務(wù)容器

服務(wù)容器在 Drupal 8 中的作用是什么？

Drupal 8 中的服務(wù)容器是一個(gè)關(guān)鍵組件，用于管理服務(wù)的創(chuàng)建，服務(wù)是在 Drupal 應(yīng)用程序中全局使用的對(duì)象。它確保每個(gè)服務(wù)只實(shí)例化一次，從而節(jié)省內(nèi)存并提高性能。服務(wù)容器還處理依賴注入，這是一種設(shè)計(jì)模式，允許一個(gè)對(duì)象提供另一個(gè)對(duì)象的依賴項(xiàng)。這使代碼更模塊化、更易于測(cè)試并促進(jìn)更好的組織。

如何在 Drupal 8 中定義新服務(wù)？

要在 Drupal 8 中定義新服務(wù)，您需要在模塊的根目錄中創(chuàng)建一個(gè) services.yml 文件。此文件應(yīng)包含服務(wù)的名稱、類和參數(shù)。該類應(yīng)是實(shí)現(xiàn)服務(wù)的類的完全限定名稱，參數(shù)應(yīng)為服務(wù)所依賴的任何服務(wù)或參數(shù)。

Drupal 8 中的配置管理的目的是什么？

Drupal 8 中的配置管理是一個(gè)系統(tǒng)，允許您以一致的方式管理站點(diǎn)配置數(shù)據(jù)。它使您可以導(dǎo)入、導(dǎo)出和同步配置數(shù)據(jù)，這在將配置更改從開發(fā)環(huán)境移動(dòng)到生產(chǎn)站點(diǎn)時(shí)非常有用。它還提供了一種跟蹤和管理站點(diǎn)配置隨時(shí)間推移的變化的方法。

如何使用配置管理系統(tǒng)導(dǎo)出和導(dǎo)入配置數(shù)據(jù)？

要在 Drupal 8 中導(dǎo)出配置數(shù)據(jù)，您可以使用管理面板中的配置管理界面或使用 Drush 命令。導(dǎo)出的數(shù)據(jù)將采用 YAML 格式，可以輕松讀取和編輯。要導(dǎo)入配置數(shù)據(jù)，您可以通過配置管理界面上傳導(dǎo)出的 YAML 文件或使用 Drush 命令。請(qǐng)記住，在導(dǎo)入配置數(shù)據(jù)之前備份您的站點(diǎn)，以防止任何潛在的數(shù)據(jù)丟失。

什么是依賴注入，為什么它在 Drupal 8 中很重要？

依賴注入是一種設(shè)計(jì)模式，允許一個(gè)對(duì)象提供另一個(gè)對(duì)象的依賴項(xiàng)。在 Drupal 8 中，它用于使服務(wù)和控制器更模塊化且更易于測(cè)試。不是在對(duì)象內(nèi)部創(chuàng)建依賴項(xiàng)，而是通過構(gòu)造函數(shù)或 setter 方法傳遞（注入）它們。這使代碼更易于測(cè)試、更靈活且耦合度更低。

如何在我的 Drupal 8 服務(wù)中注入依賴項(xiàng)？

要在 Drupal 8 中的服務(wù)中注入依賴項(xiàng)，您需要在 services.yml 文件中服務(wù)的定義中定義它們。依賴項(xiàng)應(yīng)列在 arguments 鍵下。創(chuàng)建服務(wù)時(shí)，服務(wù)容器將自動(dòng)將這些依賴項(xiàng)傳遞給服務(wù)的構(gòu)造函數(shù)。

Drupal 8 中的服務(wù)和插件有什么區(qū)別？

在 Drupal 8 中，服務(wù)是一個(gè)執(zhí)行應(yīng)用程序中全局任務(wù)的對(duì)象，而插件是一個(gè)以可插入方式執(zhí)行特定任務(wù)的對(duì)象。服務(wù)在 services.yml 文件中定義，并由服務(wù)容器管理，而插件由插件管理器發(fā)現(xiàn)和實(shí)例化。

如何在 Drupal 8 中覆蓋服務(wù)？

要在 Drupal 8 中覆蓋服務(wù)，您需要在模塊的 services.yml 文件中定義一個(gè)與要覆蓋的服務(wù)同名的服務(wù)。您的新服務(wù)應(yīng)擴(kuò)展原始服務(wù)的類并覆蓋要更改的方法。

如何使用配置管理系統(tǒng)跟蹤站點(diǎn)配置的更改？

Drupal 8 中的配置管理系統(tǒng)提供了一種通過配置快照系統(tǒng)跟蹤站點(diǎn)配置更改的方法。每當(dāng)您導(dǎo)入或同步配置數(shù)據(jù)時(shí)，此系統(tǒng)都會(huì)對(duì)站點(diǎn)的活動(dòng)配置進(jìn)行快照。然后，您可以比較這些快照以查看進(jìn)行了哪些更改。

services.yml 文件在 Drupal 8 中的作用是什么？

Drupal 8 中的 services.yml 文件是定義模塊服務(wù)的場(chǎng)所。每個(gè)服務(wù)都使用唯一的名稱、實(shí)現(xiàn)服務(wù)的類的完全限定名稱以及服務(wù)所依賴的任何服務(wù)或參數(shù)來定義。services.yml 文件由服務(wù)容器讀取，服務(wù)容器管理服務(wù)的創(chuàng)建和注入。

以上是Drupal 8模塊 - 配置管理和服務(wù)容器的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！