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 來存儲和检索用戶數據。讓我們分解一下：

我們導入 Cache Contract，使用 use Illuminate\Contracts\Cache\Repository as Cache;。
在構造函數中，我們注入 Cache Contract 的實例。
在 showProfile 方法中，我們使用 remember 方法來麼提取用戶數據，或者如果不存在，則從數據庫中獲取並將其存儲在緩存中一小時（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