Laravel框架下的Contracts契约详解


Posted in PHP onMarch 17, 2020

Contracts

Laravel 的契约是一组定义框架提供的核心服务的接口, 例如我们在介绍用户认证的章节中到的用户看守器契约IllumninateContractsAuthGuard 和用户提供器契约IlluminateContractsAuthUserProvider以及框架自带的App\User模型所实现的IlluminateContractsAuthAuthenticatable契约。

为什么使用契约

通过上面几个契约的源码文件我们可以看到,Laravel提供的契约是为核心模块定义的一组interface。Laravel为每个契约都提供了相应的实现类,下表列出了Laravel为上面提到的三个契约提供的实现类。

Laravel框架下的Contracts契约详解

所以在自己开发的项目中,如果Laravel提供的用户认证系统无法满足需求,你可以根据需求定义看守器和用户提供器的实现类,比如我之前做的项目就是用户认证依赖于公司的员工管理系统的API,所以我就自己写了看守器和用户提供器契约的实现类,让Laravel通过自定义的Guard和UserProvider来完成用户认证。自定义用户认证的方法在介绍用户认证的章节中我们介绍过,读者可以去翻阅那块的文章。

所以Laravel为所有的核心功能都定义契约接口的目的就是为了让开发者能够根据自己项目的需要自己定义实现类,而对于这些接口的消费者(比如:Controller、或者内核提供的 AuthManager这些)他们不需要关心接口提供的方法具体是怎么实现的, 只关心接口的方法能提供什么功能然后去使用这些功能就可以了,我们可以根据需求在必要的时候为接口更换实现类,而消费端不用进行任何改动。

定义和使用契约

上面我们提到的都是Laravel内核提供的契约, 在开发大型项目的时候我们也可以自己在项目中定义契约和实现类,你有可能会觉得自带的Controller、Model两层就已经足够你编写代码了,凭空多出来契约和实现类会让开发变得繁琐。我们先从一个简单的例子出发,考虑下面的代码有什么问题:

class OrderController extends Controller
{
 public function getUserOrders()
 {
  $orders= Order::where('user_id', '=', \Auth::user()->id)->get();
  return View::make('order.index', compact('orders'));
 }
}

这段代码很简单,但我们要想测试这段代码的话就一定会和实际的数据库发生联系。

也就是说, ORM和这个控制器有着紧耦合。如果不使用Eloquent ORM,不连接到实际数据库,我们就没办法运行或者测试这段代码。这段代码同时也违背了“关注分离”这个软件设计原则。

简单讲:这个控制器知道的太多了。

控制器不需要去了解数据是从哪儿来的,只要知道如何访问就行。控制器也不需要知道这数据是从MySQL或哪儿来的,只需要知道这数据目前是可用的。

Separation Of Concerns 关注分离

Every class should have a single responsibility, and that responsibility should be entirely encapsulated by the class.

每个类都应该只有单一的职责,并且职责里所有的东西都应该由这个类封装

接下来我们定义一个接口,然后实现该接口

interface OrderRepositoryInterface 
{
 public function userOrders(User $user);
}
class OrderRepository implements OrderRepositoryInterface
{
 public function userOrders(User $user)
 {
  Order::where('user_id', '=', $user->id)->get();
 }
}

将接口的实现绑定到Laravel的服务容器中

App::singleton('OrderRepositoryInterface', 'OrderRespository');  

然后我们将该接口的实现注入我们的控制器

class UserController extends Controller
{
 public function __construct(OrderRepositoryInterface $orderRepository)
 {
  $this->orders = $orderRespository;
 }
 public function getUserOrders()
 {
  $orders = $this->orders->userOrders();
  return View::make('order.index', compact('orders'));
 }
}

现在我们的控制器就完全和数据层面无关了。在这里我们的数据可能来自MySQL,MongoDB或者Redis。我们的控制器不知道也不需要知道他们的区别。这样我们就可以独立于数据层来测试Web层了,将来切换存储实现也会很容易。

接口与团队开发

当你的团队在开发大型应用时,不同的部分有着不同的开发速度。

比如一个开发人员在开发数据层,另一个开发人员在做控制器层。

写控制器的开发者想测试他的控制器,不过数据层开发较慢没法同步测试。那如果两个开发者能先以interface的方式达成协议,后台开发的各种类都遵循这种协议。

一旦建立了约定,就算约定还没实现,开发者也可以为这接口写个“假”实现

class DummyOrderRepository implements OrderRepositoryInterface 
{
 public function userOrders(User $user)
 {
  return collect(['Order 1', 'Order 2', 'Order 3']);
 }
}

一旦假实现写好了,就可以被绑定到IoC容器里

App::singleton('OrderRepositoryInterface', 'DummyOrderRepository');

然后这个应用的视图就可以用假数据填充了。接下来一旦后台开发者写完了真正的实现代码,比如叫RedisOrderRepository。

那么使用IoC容器切换接口实现,应用就可以轻易地切换到真正的实现上,整个应用就会使用从Redis读出来的数据了。

接口与测试

建立好接口约定后也更有利于我们在测试时进行Mock

public function testIndexActionBindsUsersFromRepository()
{ 
 // Arrange...
 $repository = Mockery::mock('OrderRepositoryInterface');
 $repository->shouldReceive('userOrders')->once()->andReturn(['order1', 'order2]);
 App::instance('OrderRepositoryInterface', $repository);
 // Act...
 $response = $this->action('GET', 'OrderController@getUserOrders');
 // Assert...
 $this->assertResponseOk();
 $this->assertViewHas('order', ['order1', 'order2']);
 }

总结

接口在程序设计阶段非常有用,在设计阶段与团队讨论完成功能需要制定哪些接口,然后设计出每个接口具体要实现的方法,方法的入参和返回值这些,每个人就可以按照接口的约定来开发自己的模块,遇到还没实现的接口完全可以先定义接口的假实现等到真正的实现开发完成后再进行切换,这样既降低了软件程序结构中上层对下层的耦合也能保证各部分的开发进度不会过度依赖其他部分的完成情况。

到此这篇关于解析Laravel框架下的Contracts契约的文章就介绍到这了,更多相关laravel contracts契约 内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

PHP 相关文章推荐
扩展你的 PHP 之入门篇
Dec 04 PHP
Apache服务器无法使用的解决方法
May 08 PHP
PHP实现的交通银行网银在线支付接口ECSHOP插件和使用例子
May 10 PHP
PHP实现的增强性mhash函数
May 27 PHP
PHP的Yii框架中Model模型的学习教程
Mar 29 PHP
你不知道的文件上传漏洞php代码分析
Sep 29 PHP
解决form中action属性后面?传递参数 获取不到的问题
Jul 21 PHP
PHP编程实现计算抽奖概率算法完整实例
Aug 09 PHP
PHP回调函数与匿名函数实例详解
Aug 16 PHP
Yii 框架入口脚本示例分析
May 19 PHP
如何利用PHP实现上传图片功能详解
Sep 24 PHP
php使用event扩展的io复用测试的示例
Oct 20 PHP
使用Entrust扩展包在laravel 中实现RBAC的功能
Mar 16 #PHP
PHP代码加密的方法总结
Mar 13 #PHP
YII2框架中behavior行为的理解与使用方法示例
Mar 13 #PHP
YII2框架中actions的作用与使用方法示例
Mar 13 #PHP
PHP正则之正向预查与反向预查讲解与实例
Apr 06 #PHP
TP5框架安全机制实例分析
Apr 05 #PHP
TP5框架实现自定义分页样式的方法示例
Apr 05 #PHP
You might like
PHP 显示客户端IP与服务器IP的代码
2010/10/12 PHP
PHP autoload与spl_autoload自动加载机制的深入理解
2013/06/05 PHP
30个php操作redis常用方法代码例子
2014/07/05 PHP
PHP多线程类及用法实例
2014/12/03 PHP
php实现约瑟夫问题的方法小结
2015/03/23 PHP
PHP aes (ecb)解密后乱码问题
2015/06/22 PHP
浅谈php提交form表单
2015/07/01 PHP
PHP快速排序算法实现的原理及代码详解
2019/04/03 PHP
JQuery Ajax通过Handler访问外部XML数据的代码
2010/06/01 Javascript
js实现点小图看大图效果的思路及示例代码
2013/10/28 Javascript
javascript使用location.search的示例
2013/11/05 Javascript
JS中的log对象获取以及debug的写法介绍
2014/03/03 Javascript
jquery控制select的text/value值为选中状态
2014/06/03 Javascript
arcgis for js 修改infowindow样式的方法
2016/11/02 Javascript
原生js编写2048小游戏
2017/03/17 Javascript
javascript帧动画(实例讲解)
2017/09/02 Javascript
Vue中添加手机验证码组件功能操作方法
2017/12/07 Javascript
vue动态渲染svg、添加点击事件的实现
2020/03/13 Javascript
python中查看变量内存地址的方法
2015/05/05 Python
简单介绍Python2.x版本中的cmp()方法的使用
2015/05/20 Python
python中快速进行多个字符替换的方法小结
2016/12/15 Python
解决Scrapy安装错误:Microsoft Visual C++ 14.0 is required...
2017/10/01 Python
python实现彩色图转换成灰度图
2019/01/15 Python
Django的性能优化实现解析
2019/07/30 Python
Django 源码WSGI剖析过程详解
2019/08/05 Python
使用keras实现densenet和Xception的模型融合
2020/05/23 Python
浅谈keras 模型用于预测时的注意事项
2020/06/27 Python
python Selenium 库的使用技巧
2020/10/16 Python
CSS 说明横向进度条最后显示文字的实现代码
2020/11/10 HTML / CSS
旅游管理专业生自荐信范文
2014/01/02 职场文书
军训自我鉴定100字
2014/02/13 职场文书
《风筝》教学反思
2014/04/10 职场文书
企业承诺书格式
2014/05/21 职场文书
小学生勤俭节约演讲稿
2014/08/28 职场文书
无房证明范本
2014/09/17 职场文书
Golang 并发下的问题定位及解决方案
2022/03/16 Golang