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 socket方式提交的post详解
Jul 19 PHP
PHP中如何判断AJAX提交的数据
Feb 05 PHP
php处理文件的小例子(解压缩,删除目录)
Feb 03 PHP
php gzip压缩输出的实现方法
Apr 27 PHP
PHP中实现生成静态文件的方法缓解服务器压力
Jan 07 PHP
Thinkphp中Create方法深入探究
Jun 16 PHP
ThinkPHP实现动态包含文件的方法
Nov 29 PHP
PHP加密解密函数详解
Oct 28 PHP
CentOS下与Apache连接的PHP多版本共存方案实现详解
Dec 19 PHP
PHP简单实现二维数组的矩阵转置操作示例
Nov 24 PHP
PHP的静态方法与普通方法用法实例分析
Sep 26 PHP
使用Rancher在K8S上部署高性能PHP应用程序的教程
Jul 10 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
2006/12/13 PHP
PHP第一季视频教程(李炎恢+php100 不断更新)
2011/05/29 PHP
PHP中的socket_read和socket_recv区别详解
2015/02/09 PHP
Centos 6.5下PHP 5.3安装ffmpeg扩展的步骤详解
2017/03/02 PHP
CL vs ForZe BO5 第四场 2.13
2021/03/10 DOTA
基于jQuery的淡入淡出可自动切换的幻灯插件
2010/08/24 Javascript
jQuery 拖动层(在可视区域范围内)
2012/05/24 Javascript
jQuery ajax dataType值为text json探索分享
2013/09/23 Javascript
使用JavaScript实现网页版Pongo设计思路及源代码分享
2014/06/16 Javascript
javascript禁止访客复制网页内容的实现代码
2015/08/05 Javascript
JS实现常见的TAB、弹出层效果(TAB标签,斑马线,遮罩层等)
2015/10/08 Javascript
JavaScript中的对象和原型(一)
2016/08/12 Javascript
AngularJS封装指令方法详解
2016/12/12 Javascript
JS中input表单隐藏域及其使用方法
2017/02/13 Javascript
vue添加axios,并且指定baseurl的方法
2018/09/19 Javascript
javascript跳转与返回和刷新页面的实例代码
2019/11/20 Javascript
vue实现简单跑马灯效果
2020/05/25 Javascript
python实现的阳历转阴历(农历)算法
2014/04/25 Python
Python实现从百度API获取天气的方法
2015/03/11 Python
python密码错误三次锁定(实例讲解)
2017/11/14 Python
Python log模块logging记录打印用法解析
2020/01/20 Python
python使用OpenCV模块实现图像的融合示例代码
2020/04/10 Python
Python如何实现爬取B站视频
2020/05/20 Python
浅析Python模块之间的相互引用问题
2021/02/26 Python
马耳他航空公司官方网站:Air Malta
2019/05/15 全球购物
大学生毕业的自我评价分享
2014/01/02 职场文书
员工培训邀请函
2014/02/02 职场文书
旅行社优秀创业计划书
2014/08/16 职场文书
党员反对四风思想汇报范文
2014/10/25 职场文书
学习社交礼仪心得体会
2016/01/22 职场文书
小学一年级数学教学反思
2016/02/16 职场文书
详解Mysql和Oracle之间的误区
2021/05/18 MySQL
golang实现一个简单的websocket聊天室功能
2021/10/05 Golang
动画《平凡职业成就世界最强》宣布制作OVA
2022/04/01 日漫
改造DE1103三步曲
2022/04/07 无线电
Tomcat弱口令复现及利用
2022/05/06 Servers