Contract,翻译过来叫契约、协议等。在 Laravel-china 的翻译中,是一个不翻词,这里也使用 Contract 来代替。
Contract 就是接口 Interface,用来规范某些服务的功能结构的,在 Laravel 中称之为契约。
以缓存操作为例,我们直接使用 Cache::get() 和 Cache::put() 即可完成缓存的获取和设置,语法很简单。此时问题来了:缓存的实现有很多种,例如文件缓存,Memcache 缓存,Redis 缓存等,要保证任何一种缓存的操作都具备 get 和 put 方法,如何保证?就是需要每种缓存服务的实现,都实现 Cache 契约,契约就是接口,就可以保证每种缓存的实现都具有一致的结构了。
缓存服务实现与 Cache 契约结构说明我们以 Cache 契约和一系列 Cache 服务实现为例,说一下这个结构:
缓存的相关实现,都位于:IlluminateCache 下:
Laravel5.5 预设了:Apc, Array, File, Database, Memcached, Null, Redis, Taggable 多种缓存的具体实现方案,以常用的 Redis 为例,IlluminateCacheRedisStore 就是 redis 缓存服务实现,查看其源代码:
namespace IlluminateCache;
// 导入契约Store
use IlluminateContractsCacheStore;
use IlluminateContractsRedisFactory as Redis;
// RedisStore 需要实现 Store,这个Store就是一个契约接口
class RedisStore extends TaggableStore implements Store
{
}
可见,该 Redis 缓存功能类,需要实现一个 Store 的接口,这个接口就是 IlluminateContractsCacheStore ,在 Laravel 中称之为契约,看该 Cache 契约的实现:
namespace IlluminateContractsCache;
interface Store
{
// 获取缓存项
public function get($key);
// 设置缓存项
public function put($key, $value, $minutes);
}
接口契约中定义了关于缓存应该具备的方法,这样在缓存操作时,无论文件,Redis 或者 Apc 缓存,都具有了统一的接口,不用担心使用上的语法差异了。
说了这么多,其实就是操作上的抽象层,将需要的操作提取,保证所有驱动实现具有统一的结构。这就是接口的常规目的,Laravel 中叫成了契约而已,没有特殊功能。
契约在编码时的使用定义好的契约,在编程时的主要使用方式,是从服务容器中解析绑定到该契约上的实现。
还是以 Cache 缓存为例,我们使用时可以使用 Facade 来使用:Cache::get(‘key’) 又或者使用助手函数来使用: cache(‘key’) 。但是无论如何使用,语法都是 app(‘cache’)->get(‘key’) 这个语法来实现的(这个可以参考 Facade - 注 这个章节)。
其中 app(‘cache’) 就是从服务容器中,解析 cache 对应的服务实现。这个服务,实在 Cache 服务提供者中绑定到容器中的,参考代码如下:
文件 IlluminateCacheCacheServiceProvider:
class CacheServiceProvider extends ServiceProvider
{
// 延迟到使用时才绑定
protected $defer = true;
public function register()
{
// 绑定cache到服务容器。
$this->app->singleton('cache', function ($app) {
return new CacheManager($app);
});
}
那也就意味着,如果需要在程序中使用缓存对象对象,仅仅需要从容器中解析出来即可。
另一个需要使用契约的场景,就是需要编写扩展时,为了保证扩展是通用的,扩展通常都需要实现某个契约,这样你的扩展就是一个通用的扩展。
官方文档概要在契约这篇官方文档中,主要说明契约的优势。内容如下:
使用契约原因,可以使得代码低耦合,保证代码的简洁性。
内置契约参考列表文档中,有一个章节是比较 Facade 和 Contract。放在一起比较的原因,应该是在 Laraval 中,通常每个 Contract 都有对应的 Facade。就像我们 Cache,就有 Cache 的 Facace 和 Cache 的 Contract。当使用 Cache 时,会导致我们确定不了当前时契约 Contract 还是门面 Facade。这就是放在一起比较的原因吧,语法类似。
但除此之外,Contract 与 Facade 功能完全不同,作用也不同,其实没有什么可比性。
Facade,简化服务的调用语法的功能。
Contract,定义一组服务的通用操作接口。
一组相关的服务,既需要通用的接口,也需要简化调用的操作。就是需要 Contract 也需要 Facade,两者作用完全不同,其实不用混淆,不用放在一起比较的!
总结Laraval 中,定义一组相关服务通用操作接口,称之为契约!就这么简单。



