Laravel框架下的Contracts契约详解

Laravel的Contracts契约是一种基于接口的技术，可以确保应用程序与服务提供商之间的协作是正确的。Contracts契约将自己视为连接消费者和服务提供商的接口，类似于协议或契约书。作为契约的实现者，服务提供商必须遵守契约，以满足消费者对接口使用的预期。

在Laravel中，Contracts契约作为一些核心服务提供商的基础，如缓存、队列、事件等。

为什么使用Contracts契约？

使用Contracts契约可以带来很多好处：

• 提高可维护性：由于Contracts作为契约被所有相关方使用，服务提供方要求契约的修改将考虑这些变化对依赖方的影响，从而保持界面的稳定性。
• 并增强了可测试性：Contracts契约使创建替代服务实现的组件变得容易，这使您可以模拟依赖项中的服务，并在测试中进行验证，而无需实际调用服务。
• 提高灵活性：因为Contracts契约是默认情况下基于接口的，所以如果您需要切换服务提供程序，则可以通过向容器绑定不同的实现来实现这一点，而不必改变您的代码。
• 使文档更易于理解：由于标准化接口，Contracts契约使文档更容易理解。因为接口可以简洁地表达如何使用服务，所以读者可以直接阅读接口，而不必去翻阅服务的实现。

示例1：使用Contracts契约的缓存机制

<?php

namespace App\Http\Controllers;

use Illuminate\Contracts\Cache\Repository as Cache;

class UserController extends Controller
{
    protected $cache;

    public function __construct(Cache $cache)
    {
        $this->cache = $cache;
    }

    public function index()
    {
        $users = $this->cache->remember('users', 60, function() {
            return DB::table('users')->get();
        });

        return view('users.index', ['users' => $users]);
    }
}

上述代码使用了Contracts契约 Illuminate\Contracts\Cache\Repository 作为缓存的接口。 这允许我们将任何实现该契约的缓存合约实例注入到控制器中。

$user = $this->cache->remember('users', 60, function() {
    return DB::table('users')->get();
});

在此代码中，我们使用了 remember 方法，该方法尝试从缓存中获取指定的缓存项，如果缓存不存在，则使用提供的回调函数将新数据存储在缓存中，并为缓存设置时间。 如果缓存存在，则将缓存值返回。

示例2：使用Contracts契约的队列机制

<?php

namespace App\Http\Controllers;

use Illuminate\Contracts\Queue\Queue;

class UserController extends Controller
{
    protected $queue;

    public function __construct(Queue $queue)
    {
        $this->queue = $queue;
    }

    public function index()
    {
        $job = new ProcessPodcast($podcast);

        $this->queue->push($job);
    }
}

上述代码使用了Contracts契约 Illuminate\Contracts\Queue\Queue 作为队列的接口。 这允许我们将任何实现该契约的队列实例注入到控制器中。

$this->queue->push($job);

在这个代码片段中，我们从队列实例中获取 push 方法。 这种灵活性允许我们使用任何队列服务供应商的队列作为后台作业的处理程序。

结论

Contracts契约提供了许多优点，特别是当您的应用程序需要使用第三方服务提供商或包组件，或者当您需要更好地组织应用程序以支持可插拔性、模块化和可组合性时。在此过程中，实现Contracts契约需要一定的技术/工程能力，但这是一件值得投资的事情。