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.MVC的模板标签系统(五)
Sep 05 PHP
把PHP安装为Apache DSO
Oct 09 PHP
利用static实现表格的颜色隔行显示
Oct 09 PHP
解决PHP在DOS命令行下却无法链接MySQL的技术笔记
Dec 29 PHP
PHP面向对象概念
Nov 06 PHP
PHP读取CURL模拟登录时生成Cookie文件的方法
Nov 04 PHP
PHP CURL 多线程操作代码实例
May 13 PHP
常见PHP数据库解决方案分析介绍
Sep 24 PHP
Yii2.0中的COOKIE和SESSION用法
Aug 12 PHP
thinkphp修改配置进入默认首页的方法
Feb 07 PHP
PHP实现的大文件切割与合并功能示例
Apr 10 PHP
基于laravel缓冲cache的用法详解
Oct 23 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
别人整理的服务器变量:$_SERVER
2006/10/20 PHP
PHP获取短链接跳转后的真实地址和响应头信息的方法
2014/07/25 PHP
实例讲解如何在PHP的Yii框架中进行错误和异常处理
2016/03/17 PHP
php array_map使用自定义的函数处理数组中的每个值
2016/10/26 PHP
thinkphp5+layui实现的分页样式示例
2019/10/08 PHP
javascript showModalDialog 多层模态窗口实现页面提交及刷新的代码
2009/11/28 Javascript
js防止表单重复提交的两种方法
2013/09/30 Javascript
javascript类型转换示例
2014/04/29 Javascript
node.js中的fs.statSync方法使用说明
2014/12/16 Javascript
JavaScript希尔排序、快速排序、归并排序算法
2016/05/08 Javascript
星期几的不同脚本写法(推荐)
2016/06/01 Javascript
项目实践一图片上传之form表单还是base64前端图片压缩(前端图片压缩)
2016/07/28 Javascript
微信公众号 客服接口的开发实例详解
2016/09/28 Javascript
JavaScript登录验证码的实现
2016/10/27 Javascript
react高阶组件经典应用之权限控制详解
2017/09/07 Javascript
NodeJS服务器实现gzip压缩的示例代码
2018/10/12 NodeJs
小程序云开发部署攻略(图文教程)
2018/10/30 Javascript
浅析JavaScript 函数柯里化
2020/09/08 Javascript
ant design vue中表格指定格式渲染方式
2020/10/28 Javascript
python原始套接字编程示例分享
2014/02/21 Python
深入理解NumPy简明教程---数组2
2016/12/17 Python
解决seaborn在pycharm中绘图不出图的问题
2018/05/24 Python
python计算阶乘和的方法(1!+2!+3!+...+n!)
2019/02/01 Python
解决pycharm不能自动保存在远程linux中的问题
2021/02/06 Python
python 30行代码实现蚂蚁森林自动偷能量
2021/02/08 Python
给女朋友的道歉信
2014/01/10 职场文书
写给爸爸的道歉信
2014/01/15 职场文书
如何编写优秀的食品项目创业计划书
2014/01/23 职场文书
庆八一活动方案
2014/01/25 职场文书
元旦晚会主持词
2014/03/24 职场文书
村党支部群众路线教育实践活动对照检查材料
2014/09/26 职场文书
公司离职证明范本
2014/10/17 职场文书
承德避暑山庄导游词
2015/02/03 职场文书
财务稽核岗位职责
2015/04/13 职场文书
2015年教研组工作总结
2015/05/04 职场文书
思想品德课教学反思
2016/02/24 职场文书