在 Laravel 应用中使用 Repository Design pattern 模式

🌟 入门

在本教程中，我们将向上一教程中构建的应用程序添加功能。克隆github存储库，运行composer install，npm install并连接到您的数据库。

$ mysql -uroot -p
mysql> create database laravelTaskApp;

如果您在这里有遇到问题，请查看我写过的其他文章安装MySQL 和 initial Laravel setup. 访问 localhost:8000，您可以看到一个异步添加和删除任务的应用程序。这意味着它将执行操作并显示最新数据，而无需刷新网页。

这是我们在上一教程中构建的任务应用程序。

🏁 仓库设计模式

在上一教程中，我们在控制器中编写了所有应用程序逻辑。另一种开发方法是将一些调用抽象到称为存储库的PHP类中。这个想法是我们可以将模型与控制器解耦，并为复杂的查询分配可读的名称。

我们将重构我们的应用程序以使用存储库模式。第一步是为app/Repositories/Repository.php.创建文件

<?php
 namespace App\Repositories;

use Illuminate\Database\Eloquent\Model;

class Repository implements RepositoryInterface
{
    // 类实例上的模型属性
    protected $model;

    // 将模型绑定到仓库的构造器
    public function __construct(Model $model)
    {
        $this->model = $model;
    }

    // 获取模型的所有实例
    public function all()
    {
        return $this->model->all();
    }

    // 在数据库中创建新记录
    public function create(array $data)
    {
        return $this->model->create($data);
    }

    // 更新数据库中的记录
    public function update(array $data, $id)
    {
        $record = $this->find($id);
        return $record->update($data);
    }

    // 从数据库中删除记录
    public functi delete($id)
    {
        return $this->model->destroy($id);
    }

    // 显示具有给定id的记录
    public function show($id)
    {
        return $this->model-findOrFail($id);
    }

    // 获取关联的模型
    public function getModel()
    {
        return $this->model;
    }

    // 设置关联的模型
    public function setModel($model)
    {
        $this->model = $model;
        return $this;
    }

    // 渴望负载数据库关系
    public function with($relations)
    {
        return $this->model->with($relations);
    }
}

该文件定义了我们的Repository类。此类的实例具有一个模型属性，我们将其绑定到一个Eloquent模型。一旦将其绑定到构造函数中，我们就可以从类方法中调用对应的方法，比如：findOrFail，update 或者 all。

implements RepositoryInterface部分不是严格必需的，但它为我们的代码增加了一层额外的结构。接口是定义类必须定义的方法的协定。在我们的例子中，界面如下所示：

<?php namespace App\Repositories;

interface RepositoryInterface
{
    public function all();

    public function create(**array** $data);

    public function update(**array** $data, $id);

    public function delete($id);

    public function show($id);
}

如果我们创建实现该接口的新仓库，我们将始终知道这些方法已经被定义。接口提供了结构，因此我们知道我们的代码需要做什么。

回到我们的 TaskController.php文件，我们实例化一个仓库并将Task模型传递给它。

<?php

namespace App\Http\Controllers;

use App\Task;
use App\Repositories\Repository;
use Illuminate\Http\Request;

class TaskController extends Controller
{
    // 我们可以从中使用存储库的空间
   protected $model;

   public function __construct(Task $task)
   {
       // 设置模型
       $this->model = new Repository($task);
   }

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

   public function store(Request $request)
   {
       $this->validate($request, [
           'body' => 'required|max:500'
       ]);

       // 创建记录并仅传递可写入的字段
       return $this->model->create($request->only($this->model->getModel()->fillable));
   }

   public function show($id)
   {
       return $this->model->show($id);
   }

   public function update(Request $request, $id)
   {
       // 更新模型并仅传递可写入字段
       $this->model->update($request->only($this->model->getModel()->fillable), $id);

       return $this->model->find($id);
   }

   public function destroy($id)
   {
       return $this->model->delete($id);
   }
}

Laravel 服务容器将自动解析我们的依赖项并将其注入到控制器实例中(docs).

至此，我们的应用程序的工作原理完全相同，但是我们的代码已重构为使用苍鹭，并且我们添加了两个API端点。

GitHub上可用源代码

php laravel