建立可重複使用的 Laravel 模型篩選器以進行動態查詢

Laravel 以其優雅和易用性而聞名，它真正閃耀的領域之一是資料庫查詢。通常，您會發現自己需要根據使用者輸入或其他動態因素來建立複雜的查詢。 Laravel 的 Eloquent ORM 提供了一種乾淨簡單的方式與資料庫交互，但是如果您想讓模型查詢更加靈活怎麼辦？輸入模型過濾的概念。

在本部落格中，我們將探索如何在 Laravel 中建立可重複使用且功能強大的模型濾鏡。這將允許您根據傳入的請求參數動態套用查詢條件，使您的 Eloquent 查詢更加模組化和可維護。

為什麼要使用模型過濾器？

Laravel 中的模型過濾器是一個類，它封裝了根據使用者輸入建立動態查詢條件所需的所有邏輯。這有助於保持控制器清潔、重複使用程式碼並使您的應用程式更加模組化。

使用模型過濾器的優點：

• 關注點分離：透過將查詢邏輯移至專用類別來保持控制器乾淨。

• 可重複使用性：讓您在多個控制器或查詢之間重複使用相同的篩選器邏輯。

• 靈活性：可以更輕鬆地新增或修改查詢條件，而無需更改應用程式的核心邏輯。

實作模型過濾器的逐步指南

第 1 步：設定過濾器類別

首先建立一個基本過濾器類，該類將處理動態新增查詢條件。此類將負責根據請求資料應用過濾器。

<?php

namespace App\Filters;

use Illuminate\Database\Eloquent\Builder;

abstract class QueryFilter
{
    protected $request;
    protected $builder;

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

    public function apply(Builder $builder)
    {
        $this->builder = $builder;

        foreach ($this->filters() as $filter => $value) {
            if (method_exists($this, $filter)) {
                $this->$filter($value);
            }
        }

        return $this->builder;
    }

    public function filters()
    {
        return $this->request->all();
    }
}

第 2 步：建立特定的過濾器類別

接下來，為要過濾的模型建立特定的過濾器類別。此類別將擴展基本 QueryFilter 類別並包含每個可過濾屬性的方法。

例如，假設您有一個產品型號，並且您想要按類別、價格和可用性進行過濾。

<?php

namespace App\Filters;

class ProductFilter extends QueryFilter
{
    public function category($value)
    {
        return $this->builder->where('category_id', $value);
    }

    public function price($value)
    {
        return $this->builder->where('price', '<=', $value);
    }

    public function availability($value)
    {
        return $this->builder->where('availability', $value);
    }
}

第 3 步：在控制器中套用過濾器

現在，在控制器中套用過濾器，根據請求參數動態過濾結果。

<?php

namespace App\Http\Controllers;

use App\Models\Product;
use App\Filters\ProductFilter;
use Illuminate\Http\Request;

class ProductController extends Controller
{
    public function index(Request $request, ProductFilter $filters)
    {
        $products = Product::filter($filters)->get();

        return view('products.index', compact('products'));
    }
}

第 4 步：將過濾範圍新增至模型

為了輕鬆套用濾鏡，請在您的 Eloquent 模型上新增範圍。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    public function scopeFilter($query, $filters)
    {
        return $filters->apply($query);
    }
}

第 5 步：在應用程式中使用過濾器

一切設定完畢後，您現在可以根據傳入的請求參數輕鬆過濾您的產品模型。例如：

// Example: /products?category=1&price=100&availability=in_stock

此 URL 將根據指定的類別、價格和可用性來過濾產品，並將過濾結果顯示給使用者。

結論

Laravel 中的模型篩選是一種使用乾淨、可重複使用的程式碼處理動態查詢條件的強大方法。透過執行上述步驟，您可以建立一個靈活的過濾系統，從而簡化您的控制器並使您的應用程式更易於維護。這種方法不僅有助於編寫更少的程式碼，而且還使您的查詢更能適應未來的需求。

在您作為 Laravel 開發人員的旅程中，掌握這些模式將顯著提高應用程式的品質和可擴展性。所以，嘗試一下，將您的 Laravel 查詢提升到一個新的水平！

享受吧！

以上是建立可重複使用的 Laravel 模型篩選器以進行動態查詢的詳細內容。更多資訊請關注PHP中文網其他相關文章！