PHP主|使用Slim中間件

Slim 框架的中間件：構建強大的 PHP 微型應用

Slim 是一個功能強大的 PHP 微型框架，其中間件功能允許在應用中實現各種過濾器式服務，例如身份驗證和緩存。中間件封裝應用程序，並能影響應用程序的環境以及請求和響應對象。

關鍵要點:

• Slim 的中間件是一個強大的特性，允許實現各種過濾器式服務，如身份驗證和緩存。中間件封裝應用程序，並能影響應用的環境、請求和響應對象。
• 在 Slim 中實現中間件，需要編寫一個擴展 SlimMiddleware 類並重寫 call() 方法的類。此方法是中間件的入口點，可以從中返回（中斷執行流程）或調用下一層。然後，中間件可以操作響應的標頭和正文。
• 使用 Slim 的 add() 方法註冊 Slim 應用程序中的中間件。可以通過後續調用 add() 方法註冊多個中間件。必須以與調用順序相反的順序添加中間件，因為新的中間件會圍繞任何先前添加的中間件。中間件的配置通常通過服務的構造函數完成。

Slim 中間件的理解

Slim 文檔將 Slim 應用程序比作洋蔥，洋蔥的每一層都是中間件。這是一個恰當的比喻。為了更好地理解它，讓我們假設我們正在編寫一個使用身份驗證和緩存的應用程序。我們的架構可能如下所示：

負責生成頁面內容的代碼被包裝在幾層中間件中，最重要的是身份驗證邏輯和緩存邏輯。執行流程經過每一層，要么允許流向下一層，要么被轉移。首先檢查用戶是否已通過身份驗證。如果沒有，則中斷流程並返回 HTTP 401 狀態。然後檢查是否可以使用內容的緩存副本。如果是，則使用緩存的頁面副本中斷流程。可能存在其他中間件層，直到流程最終到達負責生成頁面的邏輯。當我們的中間件方法返回時，執行流程會通過它們冒泡返回。例如，緩存中間件的其餘邏輯將緩存頁面的內容以供以後查找。

中間件的實現

要了解如何實現自定義中間件，讓我們看看可以作為上面提到的緩存中間件的代碼。實現任何基本 Slim 中間件組件的要求實際上非常少。我們只需要編寫一個擴展 SlimMiddleware 類並重寫 call() 方法的類。中間件的入口點是此 call() 方法，我們可以從中返回（從而中斷執行流程）或調用下一層。

<?php namespace MyMiddleware;

class Cache extends SlimMiddleware
{
    protected $db;

    public function __construct(PDO $db)
    {
        $this->db = $db;
    }

    public function call()
    {
        $key = $this->app->request()->getResourceUri();
        $rsp = $this->app->response();

        $data = $this->fetch($key);
        if ($data) {
            // 缓存命中...返回缓存的内容
            $rsp["Content-Type"] = $data["content_type"];
            $rsp->body($data["body"]);
            return;
        }

        // 缓存未命中...继续生成页面
        $this->next->call();

        if ($rsp->status() == 200) {
            // 缓存结果以供将来查找
            $this->save($key, $rsp["Content-Type"], $rsp->body());
        }
    }

    protected function fetch($key)
    {
        $query = "SELECT content_type, body FROM cache
            WHERE key = " . $this->db->quote($key);
        $result = $this->db->query($query);
        $row = $result->fetch(PDO::FETCH_ASSOC);
        $result->closeCursor();
        return $row;
    }

    protected function save($key, $contentType, $body)
    {
        $query = sprintf("INSERT INTO cache (key, content_type, body)
            VALUES (%s, %s, %s)",
            $this->db->quote($key),
            $this->db->quote($contentType),
            $this->db->quote($body)
        );
        $this->db->query($query);
    }

}

call() 方法首先檢查內容是否在緩存中可用。如果是，它設置響應的 Content-Type 標頭和正文，然後返回，從而短路管道。如果緩存未命中，則調用 $this->next->call() 來調用下一個中間件層。當流程從其他中間件調用返回到這一點時，會快速檢查請求狀態，並將相關數據緩存以供將來查找。因為該類擴展了 Slim 的 Middleware 類，所以它可以通過 $this->app 訪問 Slim 應用程序的實例，從而間接訪問響應和請求對象。我們可以通過將其視為數組來影響響應的標頭，並通過其 body() 方法影響響應的正文。 fetch() 和 save() 方法是受保護的輔助方法，它們只是包裝數據庫查詢以查找和持久化內容。我在這裡包含它們只是為了完成示例。它假設存在一個名為 cache 的表，其中包含 key、content_type 和 body 列。根據您的需要，您的持久性機制可能有所不同。此外，此處未顯示（為簡單起見）緩存過期，儘管您可以自己輕鬆地合併它。

中間件的註冊和配置

使用 Slim 的 add() 方法註冊中間件。

<?php require_once "../vendor/autoload.php";

$app = new SlimSlim();
$app->add(new MyMiddlewareCache($db));

當然，可以通過後續調用 add() 方法註冊多個中間件。因為新的中間件會圍繞任何先前添加的中間件，這意味著必須以與調用順序相反的順序添加它們。

<?php $app = new SlimSlim();
$app->add(new MyMiddlewareCache($db));
$app->add(new MyMiddlewareAuth($db));
// ...

在上面的示例中，Cache 中間件包裝了 Slim 應用，然後 Auth 中間件包裝了 Cache。當調用 $app->run() 時，執行流程將類似於上圖所示，首先進入身份驗證中間件，然後一直向下工作到路由。中間件的配置通常通過服務的構造函數完成。在我們的示例中，我只是傳遞了一個活動的數據庫連接，以便它可以訪問緩存表，但是您可以編寫您的類以接受您可能需要自定義其行為的任何信息。例如，可以重寫該組件以接受一個公開fetch() 和save() 方法的處理程序對象；這將允許我們刪除示例方法（或將它們用作默認回退），並且最終用戶開發人員將根據其需求提供功能作為組件配置的一部分。

結論

我發現中間件是實現 Slim 應用程序各個方面的優雅解決方案。在本文中，我解釋了中間件架構的工作原理以及實現自己的中間件所需的條件。有一個小型額外存儲庫，其中包含一些基本的中間件示例，例如 CSRF 保護和 HTTP 身份驗證。我已經重構了這裡的示例並提交了一個拉取請求，因此，如果您編寫了一個有用的中間件服務，為什麼不考慮將其提交到項目中，以便其他人也能從中受益呢？

(圖片來自 Fotolia)

(以下為FAQ，已根據原文內容調整和補充，並精簡部分重複內容)

關於 Slim 中間件的常見問題

• 什麼是 Slim 中間件，為什麼它很重要？ Slim 中間件是 Slim 框架中一個強大的工具，允許您操作 HTTP 請求和響應。它很重要，因為它提供了一種在 Slim 應用程序之前和之後執行代碼的方法，以修改傳入的請求或傳出的響應。這可用於各種目的，例如身份驗證、緩存或日誌記錄。

• 如何在 Slim 中創建中間件？ 在 Slim 中創建中間件涉及定義一個實現 MiddlewareInterface 的類。此類應該有一個名為 process() 的方法，該方法接收 ServerRequestInterface 和 RequestHandlerInterface。 process() 方法是您可以操作請求和響應的地方。

• 如何將中間件添加到我的 Slim 應用程序？ 可以使用 add() 方法將中間件添加到您的 Slim 應用程序。此方法接收中間件類的實例。中間件按添加順序執行，因此最後添加的中間件將是第一個執行的中間件。

• 我可以將中間件用於 Slim 中的特定路由嗎？ 是的，中間件可以應用於 Slim 中的特定路由。這是通過在 Route 對象而不是 App 對像上調用 add() 方法來完成的。這允許您擁有僅影響某些路由的中間件。

• 全局中間件和路由中間件有什麼區別？ 全局中間件應用於 Slim 應用程序處理的每個請求，而路由中間件僅應用於特定路由。這允許您為應用程序的不同部分使用不同的中間件。

• 如何使用中間件進行 Slim 中的錯誤處理？ 通過在中間件類中捕獲異常，可以使用中間件進行 Slim 中的錯誤處理。然後，您可以修改響應以包含錯誤信息，或將用戶重定向到錯誤頁面。

• 可以使用中間件在 Slim 中對用戶進行身份驗證嗎？ 是的，中間件通常用於 Slim 中的身份驗證。這可以通過檢查中間件中的有效會話或令牌來完成，如果用戶未經身份驗證，則返回錯誤響應。

• 如何使用中間件在 Slim 中進行日誌記錄？ 通過將有關請求和響應的信息寫入日誌文件，可以使用中間件進行日誌記錄。這對於調試或監視您的應用程序非常有用。

• 我可以將第三方中間件與 Slim 一起使用嗎？ 是的，Slim 支持第三方中間件。這可以像您自己的中間件一樣添加到您的應用程序中。這允許您利用現有的中間件來完成常見任務。

• 如何測試我的 Slim 中間件？ 測試 Slim 中間件涉及創建模擬請求和響應，並將它們傳遞給您的中間件。然後，您可以斷言中間件的行為符合預期，例如修改請求或響應，或拋出異常。

以上是PHP主|使用Slim中間件的詳細內容。更多資訊請關注PHP中文網其他相關文章！