Laravel - Contracts: 初学者指南

你好，未来的 Laravel 巫师们！今天，我们将踏上一段激动人心的旅程，探索 Laravel Contracts 的世界。如果你是编程新手，不用担心——我将作为你友好的向导，我们会一步一步地学习。在本教程结束时，你将对 Contracts 有一个扎实的理解，并了解它们如何使你的 Laravel 应用程序更加灵活和强大。

Laravel - Contracts

什么是 Laravel Contracts？

想象一下你正在构建一个巨大的乐高结构。如果你能轻松地替换某些部分，而不会让整个结构崩溃，那岂不是很好？这正是 Laravel Contracts 允许我们在代码中做到的！

从技术术语上讲，Laravel Contracts 是一组定义框架核心服务的接口。它们是你和框架之间的“合同”，确保某些方法总是可用，无论具体的实现如何。

为什么使用 Contracts？

灵活性：Contracts 使得替换应用程序的组件变得更容易。
清晰性：它们为框架的特性提供了一个清晰简洁的 API。
可测试性：Contracts 使得编写代码的单元测试更加简单。

让我们通过一些例子来深入了解！

你的第一个 Contract：Cache

Laravel 中最常用的 Contracts 之一是 Cache Contract。让我们看看我们如何使用它：

use Illuminate\Contracts\Cache\Repository as Cache;

class UserController
{
protected $cache;

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

public function showProfile($id)
{
$user = $this->cache->remember('user.'.$id, 3600, function() use ($id) {
return User::find($id);
});

return view('user.profile', ['user' => $user]);
}
}

在这个例子中，我们使用 Cache Contract 来存储和检索用户数据。让我们分解一下：

我们通过 use Illuminate\Contracts\Cache\Repository as Cache; 导入 Cache Contract。
在构造函数中，我们注入了一个 Cache Contract 的实例。
在 showProfile 方法中，我们使用 remember 方法来检索缓存中的用户，或者如果不存在，从数据库中获取并存储在缓存中，有效期为1小时（3600秒）。

在这里使用 Contract 的美妙之处在于，我们不必担心具体的缓存实现。它可能是使用 Redis、Memcached，甚至是基于文件的缓存——我们的代码保持不变！

依赖注入的力量

你可能注意到我们没有自己创建 Cache 实例。相反，我们在构造函数中请求它。这称为依赖注入，它是 Laravel 中的一个关键概念。

当 Laravel 创建 UserController 的实例时，它看到我们在构造函数中请求一个 Cache。然后 Laravel 查找应该用于 Cache Contract 的具体实现，并自动将其提供给我们的控制器。

这使得我们的代码更灵活，更容易测试。我们可以在测试中轻松替换缓存实现，而无需更改控制器代码！

常见的 Laravel Contracts

Laravel 提供了许多开箱即用的 Contracts。以下是一些最常用的：

Contract	描述
Cache	提供了缓存数据的方法
Queue	允许你延迟处理耗时的任务
Auth	处理认证和授权
Mail	提供了发送电子邮件的方法
Filesystem	提供了一个统一的 API，用于处理本地和云文件存储

创建你自己的 Contracts

随着你对 Laravel 的熟悉程度加深，你可能会发现自己想要创建自己的 Contracts。让我们为一个假设的天气服务创建一个简单的 Contract：

// app/Contracts/WeatherService.php
namespace App\Contracts;

interface WeatherService
{
public function getCurrentTemperature(string $city): float;
public function getForecast(string $city, int $days): array;
}

现在我们可以创建这个 Contract 的实现：

// app/Services/OpenWeatherMapService.php
namespace App\Services;

use App\Contracts\WeatherService;

class OpenWeatherMapService implements WeatherService
{
public function getCurrentTemperature(string $city): float
{
// 使用 OpenWeatherMap API 的实现
}

public function getForecast(string $city, int $days): array
{
// 使用 OpenWeatherMap API 的实现
}
}

要在我们的应用程序中使用它，我们会在服务提供者中将我们的实现绑定到 Contract：

// app/Providers/AppServiceProvider.php
use App\Contracts\WeatherService;
use App\Services\OpenWeatherMapService;

public function register()
{
$this->app->bind(WeatherService::class, OpenWeatherMapService::class);
}

现在，在我们的应用程序中任何需要天气数据的地方，我们都可以简单地提示 WeatherService Contract：

use App\Contracts\WeatherService;

class WeatherController
{
protected $weather;

public function __construct(WeatherService $weather)
{
$this->weather = $weather;
}

public function index(Request $request)
{
$temperature = $this->weather->getCurrentTemperature($request->city);
return view('weather', ['temperature' => $temperature]);
}
}

这种方法的优点在于，如果我们后来决定切换到不同的天气 API，我们只需要创建一个新的实现并更新我们的服务提供者。应用程序的其余代码保持不变！

结论

恭喜你！你已经迈出了进入 Laravel Contracts 世界的第一步。我们介绍了什么是 Contracts，为什么它们有用，以及如何在你的 Laravel 应用程序中使用它们。我们还创建了我们自己的 Contract 和实现！

记住，Contracts 是关于为你的应用程序组件定义一个清晰的 API。它们使你的代码更加灵活、易于理解和测试。在你继续你的 Laravel 旅程时，你会发现越来越多的方法来利用 Contracts 构建健壮、可维护的应用程序。

继续练习，保持好奇心，在你意识到之前，你将成为 Laravel Contract 的高手！快乐编码！

Credits: Image by storyset