為什麼要在 Laravel 實現儲存庫模式？-php教程-PHP中文網

為什麼要在 Laravel 實現儲存庫模式？

WBOY

發布： 2024-09-08 12:31:08

原創

887 人瀏覽過

Why Implement the Repository Pattern in Laravel?

Laravel 中的儲存庫模式簡介

儲存庫模式是一種設計模式，用於管理資料存取邏輯並將其集中在一個地方。這種模式有助於將檢索和保存資料的邏輯與業務邏輯分開，使程式碼庫更加模組化、可重複使用和可測試。

在 Laravel 中，儲存庫模式可用於抽象與資料模型（如 Eloquent 模型）的交互，使您的程式碼隨著應用程式的成長而變得更加靈活和可維護。

為什麼要使用儲存庫模式？

關注點分離：它將業務邏輯與資料存取邏輯分離，使程式碼更乾淨，更易於管理。
鬆散耦合：透過抽象資料庫存取邏輯，可以減少對特定ORM（例如Eloquent）的直接依賴，如果需要切換到不同的資料庫，可以在將來更輕鬆地進行修改或儲存引擎。
更好的測試：它使單元測試更容易，因為您可以在測試中模擬儲存庫，而不必擔心資料庫或 ORM。
DRY 原則：公共資料庫查詢可以在應用程式的不同部分重複使用，防止程式碼重複。

儲存庫模式的基本結構

儲存庫模式通常涉及三個元件：

儲存庫介面：定義如何存取資料的契約。
儲存庫實作：實作具有檢索和操作資料邏輯的介面。
模型：你的資料模型，在 Laravel 通常是 Eloquent 模型。

Laravel 中儲存庫模式的逐步實作

1.建立儲存庫介面

首先，定義接口，指定與資料互動的方法。

// app/Repositories/Contracts/UserRepositoryInterface.php
namespace App\Repositories\Contracts;

interface UserRepositoryInterface
{
    public function all();
    public function find($id);
    public function create(array $data);
    public function update($id, array $data);
    public function delete($id);
}

登入後複製

在此範例中，介面定義了用於操作使用者資料的方法，如 all()、find()、create()、update() 和 delete()。

2.建立儲存庫實作

接下來，建立一個實作儲存庫介面的具體類別。此類別將包含與資料庫互動的實際邏輯，通常使用 Eloquent 模型。

// app/Repositories/Eloquent/UserRepository.php
namespace App\Repositories\Eloquent;

use App\Models\User;
use App\Repositories\Contracts\UserRepositoryInterface;

class UserRepository implements UserRepositoryInterface
{
    protected $user;

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

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

    public function find($id)
    {
        return $this->user->findOrFail($id);
    }

    public function create(array $data)
    {
        return $this->user->create($data);
    }

    public function update($id, array $data)
    {
        $user = $this->find($id);
        $user->update($data);
        return $user;
    }

    public function delete($id)
    {
        $user = $this->find($id);
        return $user->delete();
    }
}

登入後複製

此實作使用 Eloquent 方法（all()、findOrFail()、create()、update()、delete()）與資料庫互動。但是，使用此儲存庫的程式碼並不了解有關 Eloquent 的任何信息，這使得將來在必要時更容易更改底層資料來源。

3.將儲存庫綁定到介面

Laravel 允許我們將介面綁定到具體類，這對於依賴注入很有用。您通常會在服務提供者執行此操作。

// app/Providers/RepositoryServiceProvider.php
namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use App\Repositories\Contracts\UserRepositoryInterface;
use App\Repositories\Eloquent\UserRepository;

class RepositoryServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->bind(UserRepositoryInterface::class, UserRepository::class);
    }
}

登入後複製

在此範例中，每當請求 UserRepositoryInterface 時，Laravel 都會自動將其解析為 UserRepository 實作。

最後，在config/app.php檔案中註冊這個服務提供者：

'providers' => [
    // Other service providers...
    App\Providers\RepositoryServiceProvider::class,
],

登入後複製

4.在控制器中使用儲存庫

完成所有設定後，您現在可以將 UserRepositoryInterface 注入控制器並使用它來存取使用者數據，而無需將程式碼與 Eloquent 緊密耦合。

// app/Http/Controllers/UserController.php
namespace App\Http\Controllers;

use App\Repositories\Contracts\UserRepositoryInterface;
use Illuminate\Http\Request;

class UserController extends Controller
{
    protected $userRepository;

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

    public function index()
    {
        $users = $this->userRepository->all();
        return response()->json($users);
    }

    public function show($id)
    {
        $user = $this->userRepository->find($id);
        return response()->json($user);
    }

    public function store(Request $request)
    {
        $user = $this->userRepository->create($request->all());
        return response()->json($user);
    }

    public function update(Request $request, $id)
    {
        $user = $this->userRepository->update($id, $request->all());
        return response()->json($user);
    }

    public function destroy($id)
    {
        $this->userRepository->delete($id);
        return response()->json(['message' => 'User deleted']);
    }
}

登入後複製

這裡，控制器現在只知道 UserRepositoryInterface，並不關心如何獲取數據，從而提供了清晰的關注點分離。