门面模式
介绍
在 Laravel 文档中，您会看到许多通过“门面模式”与 Laravel 功能交互的代码示例。门面模式为应用程序的服务容器中的类提供了一个“静态”接口。Laravel 附带了许多门面模式，几乎可以访问 Laravel 的所有功能。
Laravel 的门面模式作为服务容器中底层类的“静态代理”，提供了简洁、富有表现力的语法，同时比传统的静态方法具有更好的可测试性和灵活性。如果您不完全理解门面模式的工作原理也没关系 - 继续学习 Laravel 即可。
所有 Laravel 的门面模式都定义在 Illuminate\Support\Facades 命名空间中。因此，我们可以轻松地访问一个门面模式，如下所示：
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Route;
Route::get('/cache', function () {
return Cache::get('key');
});在 Laravel 文档中，许多示例将使用门面模式来演示框架的各种功能。
辅助函数
为了补充门面模式，Laravel 提供了多种全局“辅助函数”，使与常见 Laravel 功能的交互更加容易。您可能会使用的一些常见辅助函数有 view、response、url、config 等。Laravel 提供的每个辅助函数都在其对应的功能中进行了文档化；不过，完整列表可以在专门的辅助文档中找到。
例如，代替使用 Illuminate\Support\Facades\Response 门面模式生成 JSON 响应，我们可以简单地使用 response 函数。因为辅助函数是全局可用的，您不需要导入任何类即可使用它们：
use Illuminate\Support\Facades\Response;
Route::get('/users', function () {
return Response::json([
// ...
]);
});
Route::get('/users', function () {
return response()->json([
// ...
]);
});何时使用门面模式
门面模式有许多优点。它们提供了简洁、易记的语法，使您可以使用 Laravel 的功能而无需记住必须手动注入或配置的长类名。此外，由于它们独特地使用 PHP 的动态方法，它们易于测试。
然而，使用门面模式时需要注意一些事项。门面模式的主要危险是类的“范围蔓延”。由于门面模式使用起来非常简单且不需要注入，因此很容易让您的类继续增长，并在单个类中使用许多门面模式。使用依赖注入，这种潜力通过大型构造函数给您的视觉反馈得以缓解，提示您的类变得过大。因此，在使用门面模式时，请特别注意类的大小，以确保其责任范围保持狭窄。如果您的类变得过大，请考虑将其拆分为多个较小的类。
门面模式 vs. 依赖注入
依赖注入的主要优点之一是能够替换注入类的实现。这在测试期间非常有用，因为您可以注入一个模拟或存根，并断言在存根上调用了各种方法。
通常，不可能模拟或存根真正的静态类方法。然而，由于门面模式使用动态方法将方法调用代理到从服务容器解析的对象，我们实际上可以像测试注入的类实例一样测试门面模式。例如，给定以下路由：
use Illuminate\Support\Facades\Cache;
Route::get('/cache', function () {
return Cache::get('key');
});使用 Laravel 的门面模式测试方法，我们可以编写以下测试来验证 Cache::get 方法是否使用我们期望的参数被调用：
use Illuminate\Support\Facades\Cache;
test('basic example', function () {
Cache::shouldReceive('get')
->with('key')
->andReturn('value');
$response = $this->get('/cache');
$response->assertSee('value');
});use Illuminate\Support\Facades\Cache;
/**
* A basic functional test example.
*/
public function test_basic_example(): void
{
Cache::shouldReceive('get')
->with('key')
->andReturn('value');
$response = $this->get('/cache');
$response->assertSee('value');
}门面模式 vs. 辅助函数
除了门面模式，Laravel 还包括多种“辅助”函数，可以执行常见任务，如生成视图、触发事件、调度作业或发送 HTTP 响应。许多这些辅助函数执行与相应门面模式相同的功能。例如，这个门面模式调用和辅助调用是等价的：
return Illuminate\Support\Facades\View::make('profile');
return view('profile');门面模式和辅助函数之间没有实际区别。使用辅助函数时，您仍然可以像测试相应的门面模式一样测试它们。例如，给定以下路由：
Route::get('/cache', function () {
return cache('key');
});cache 辅助函数将调用 Cache 门面模式底层类的 get 方法。因此，即使我们使用的是辅助函数，我们也可以编写以下测试来验证该方法是否使用我们期望的参数被调用：
use Illuminate\Support\Facades\Cache;
/**
* A basic functional test example.
*/
public function test_basic_example(): void
{
Cache::shouldReceive('get')
->with('key')
->andReturn('value');
$response = $this->get('/cache');
$response->assertSee('value');
}门面模式如何工作
在 Laravel 应用程序中，门面模式是一个类，它提供对容器中对象的访问。使这项工作成为可能的机制在 Facade 类中。Laravel 的门面模式以及您创建的任何自定义门面模式都将扩展基础的 Illuminate\Support\Facades\Facade 类。
Facade 基类利用 __callStatic() 魔术方法将您的门面模式的调用推迟到从容器解析的对象。在下面的示例中，调用了 Laravel 缓存系统。通过查看此代码，您可能会认为静态 get 方法正在 Cache 类上被调用：
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Cache;
use Illuminate\View\View;
class UserController extends Controller
{
/**
* Show the profile for the given user.
*/
public function showProfile(string $id): View
{
$user = Cache::get('user:'.$id);
return view('profile', ['user' => $user]);
}
}请注意，在文件的顶部，我们正在“导入” Cache 门面模式。这个门面模式作为访问 Illuminate\Contracts\Cache\Factory 接口的底层实现的代理。我们使用门面模式进行的任何调用都将传递给 Laravel 缓存服务的底层实例。
如果我们查看 Illuminate\Support\Facades\Cache 类，您会看到没有静态方法 get：
class Cache extends Facade
{
/**
* Get the registered name of the component.
*/
protected static function getFacadeAccessor(): string
{
return 'cache';
}
}相反，Cache 门面模式扩展了基础 Facade 类，并定义了方法 getFacadeAccessor()。此方法的任务是返回服务容器绑定的名称。当用户引用 Cache 门面模式上的任何静态方法时，Laravel 将从服务容器解析 cache 绑定，并针对该对象运行请求的方法（在本例中为 get）。
实时门面模式
使用实时门面模式，您可以将应用程序中的任何类视为门面模式。为了说明如何使用它，让我们首先检查一些不使用实时门面模式的代码。例如，假设我们的 Podcast 模型有一个 publish 方法。然而，为了发布播客，我们需要注入一个 Publisher 实例：
<?php
namespace App\Models;
use App\Contracts\Publisher;
use Illuminate\Database\Eloquent\Model;
class Podcast extends Model
{
/**
* Publish the podcast.
*/
public function publish(Publisher $publisher): void
{
$this->update(['publishing' => now()]);
$publisher->publish($this);
}
}将发布者实现注入到方法中使我们能够轻松地在隔离中测试该方法，因为我们可以模拟注入的发布者。然而，这要求我们每次调用 publish 方法时都显式传递一个发布者实例。使用实时门面模式，我们可以保持相同的可测试性，同时不需要显式传递 Publisher 实例。要生成实时门面模式，请在导入类的命名空间前加上 Facades 前缀：
<?php
namespace App\Models;
use App\Contracts\Publisher;
use Facades\App\Contracts\Publisher;
use Illuminate\Database\Eloquent\Model;
class Podcast extends Model
{
/**
* Publish the podcast.
*/
public function publish(Publisher $publisher): void
public function publish(): void
{
$this->update(['publishing' => now()]);
$publisher->publish($this);
Publisher::publish($this);
}
}使用实时门面模式时，发布者实现将使用 Facades 前缀后面的接口或类名部分从服务容器中解析出来。在测试时，我们可以使用 Laravel 内置的门面模式测试助手来模拟此方法调用：
<?php
use App\Models\Podcast;
use Facades\App\Contracts\Publisher;
use Illuminate\Foundation\Testing\RefreshDatabase;
uses(RefreshDatabase::class);
test('podcast can be published', function () {
$podcast = Podcast::factory()->create();
Publisher::shouldReceive('publish')->once()->with($podcast);
$podcast->publish();
});<?php
namespace Tests\Feature;
use App\Models\Podcast;
use Facades\App\Contracts\Publisher;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
class PodcastTest extends TestCase
{
use RefreshDatabase;
/**
* A test example.
*/
public function test_podcast_can_be_published(): void
{
$podcast = Podcast::factory()->create();
Publisher::shouldReceive('publish')->once()->with($podcast);
$podcast->publish();
}
}门面类参考
下面您将找到每个门面模式及其底层类。这是快速查找给定门面模式根的 API 文档的有用工具。还包括适用的服务容器绑定键。