如何在Laravel5.8中正确地应用Repository设计模式
在本文中,我会向你展示如何在Laravel中从头开始实现repository设计模式。我将使用Laravel5.8.3版,但Laravel版本不是最重要的。在开始写代码之前,你需要了解一些关于repository设计模式的相关信息。
repository设计模式允许你使用对象,而不需要了解这些对象是如何持久化的。本质上,它是数据层的抽象。
这意味着你的业务逻辑不需要了解如何检索数据或数据源是什么,业务逻辑依赖于repository来检索正确的数据。
关于这个模式,我看到有人将它误解为repository被用来创建或更新数据。这不是repository应该做的,repository不应该创建或更新数据,仅仅用于检索数据。
理解透了吧?接下来一起写代码
既然我们从头开始,那么我们先创建一个新的Laravel项目吧:
composercreate-project--prefer-distlaravel/laravelrepository
对于本教程,我们将构建一个小型的博客应用。现在我们已经创建好了一个新的Laravel项目,接下来应该为它创建一个控制器和模型。
phpartisanmake:controllerBlogController
这将在app/Http/Controllers目录中创建BlogController。
phpartisanmake:modelModels/Blog-m
提示:
-m选项会创建一个对应的数据库迁移,你可以在database/migrations目录中找到所生成的迁移。
现在你应该能在app/Models目录中找到刚生成的模型Blog了吧。这只是一种我喜欢的存放模型的方式。
现在我们有了控制器和模型,是时候看看我们创建的迁移文件了。除了默认的Laravel时间戳字段外,我们的博客只需要标题、内容和用户ID字段。
bigIncrements('id'); $table->string('title'); $table->text('content'); $table->integer('user_id'); $table->timestamps(); $table->foreign('user_id') ->references('id') ->on('users'); }); } publicfunctiondown() { Schema::dropIfExists('blogs'); } }
提示:
如果你使用的是Laravel5.8以下的旧版本,请将
$table->bigIncrements('id');
替换为:
$table->increments('id');
设置数据库
我将使用MySQL数据库作为示例,第一步就是创建一个新的数据库。
mysql-uroot-p createdatabaselaravel_repository;
以上命令将会创建一个叫laravel_repository的新数据库。接下来我们需要添加数据库信息到Laravel根目录的.env文件中。
DB_DATABASE=laravel_repository DB_USERNAME=root DB_PASSWORD=secret
当你更新了.env文件后我们需要清空缓存:
phpartisanconfig:clear
运行迁移
现在我们已经设置好了数据库,可以开始运行迁移了:
phpartisanmigrate
这将会创建blogs表,包含了我们在迁移中声明的title,content和user_id字段。
实现repository设计模式
一切就绪,我们现在可以开始实现repository设计风格了。我们将会在app目录中创建Repositories目录。我们将要创建的第二个目录是Interfaces目录,这个目录位于Repositories目录中。
在Interfaces文件中我们将创建一个包含两个方法的BlogRepositoryInterface接口。
- 返回所有博客文章的all方法
- 返回特定用户所有博客文章的getByUser方法
我们需要创建的最后一个类是将要实现BlogRepositoryInterface的BlogRepository,我们会写一个最简单的实现方式。
id)->get(); } }你的Repositories目录应该像这样:
app/ └──Repositories/ ├──BlogRepository.php └──Interfaces/ └──BlogRepositoryInterface.php你现在已经成功创建了一个repository了。但是我们还没有完成,是时候开始使用我们的repository了。
在控制器中使用Repository
要开始使用BlogRepository,我们首先需要将其注入到BlogController。由于Laravel的依赖注入,我们很容易用另一个来替换它。这就是我们控制器的样子:
blogRepository=$blogRepository; } publicfunctionindex() { $blogs=$this->blogRepository->all(); returnview('blog')->withBlogs($blogs); } publicfunctiondetail($id) { $user=User::find($id); $blogs=$this->blogRepository->getByUser($user); returnview('blog')->withBlogs($blogs); } }如你所见,控制器中的代码很简短,可读性非常的高。不需要十行代码就可以获取到所需的数据,多亏了repository,所有这些逻辑都可以在一行代码中完成。这对单元测试也很好,因为repository的方法很容易复用。
repository设计模式也使更改数据源变得更加容易。在这个例子中,我们使用MySQL数据库来检索我们的博客内容。我们使用Eloquent来完成查询数据库操作。但是假设我们在某个网站上看到了一个很棒的博客API,我们想使用这个API作为数据源,我们所要做的就是重写BlogRepository来调用这个API替换Eloquent。
RepositoryServiceProvider
我们将注入BlogController中的BlogRepository,而不是注入BlogController中的BlogRepositoryInterface,然后让服务容器决定将使用哪个存储库。这将在AppServiceProvider的boot方法中实现,但我更喜欢为此创建一个新的provider来保持整洁。
phpartisanmake:providerRepositoryServiceProvider我们为此创建一个新的provider的原因是,当您的项目开始发展为大型项目时,结构会变得非常凌乱。设想一下,一个拥有10个以上模型的项目,每个模型都有自己的repository,你的AppServiceProvider可读性将会大大降低。
我们的RepositoryServiceProvider会像下面这样:
app->bind( BlogRepositoryInterface::class, BlogRepository::class ); } }留意用另一个repository替代BlogRepository是多么容易!
不要忘记添加RepositoryServiceProvider到config/app.php文件的providers列表中。完成了这些后我们需要清空缓存:
phpartisanconfig:clear就是这样
现在你已经成功实现了repository设计模式,不是很难吧?
你可以选择增加一些路由和视图来拓展代码,但本文将在这里结束,因为本文主要是介绍repository设计模式的。
原文地址:https://itnext.io/repository-design-pattern-done-right-in-laravel-d177b5fa75d4
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。