门面
简介
在 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 提供的每个辅助函数都有相应的功能文档；但是，完整的列表可在专门的 辅助函数文档 中找到。
例如，我们可以简单地使用 response 函数，而不是使用 Illuminate\Support\Facades\Response 门面来生成 JSON 响应。由于辅助函数全局可用，您无需导入任何类即可使用它们：
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;
/**
* 一个基本的功能测试示例。
*/
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;
/**
* 一个基本的功能测试示例。
*/
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 缓存系统进行了调用。乍一看这段代码，可能会假设正在 Cache 类上调用静态 get 方法：
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Cache;
use Illuminate\View\View;
class UserController extends Controller
{
/**
* 显示给定用户的个人资料。
*/
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
{
/**
* 获取组件的注册名称。
*/
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
{
/**
* 发布播客。
*/
public function publish(Publisher $publisher): void
{
$this->update(['publishing' => now()]);
$publisher->publish($this);
}
}将发布者实现注入方法使我们能够轻松地隔离测试方法，因为我们可以模拟注入的发布者。但是，它要求我们每次调用 publish 方法时都传递一个发布者实例。使用实时门面，我们可以保持相同的可测试性，而无需显式传递 Publisher 实例。要生成实时门面，请在导入类的命名空间前加上 Facades：
<?php
namespace App\Models;
use App\Contracts\Publisher; // [tl! remove]
use Facades\App\Contracts\Publisher; // [tl! add]
use Illuminate\Database\Eloquent\Model;
class Podcast extends Model
{
/**
* 发布播客。
*/
public function publish(Publisher $publisher): void // [tl! remove]
public function publish(): void // [tl! add]
{
$this->update(['publishing' => now()]);
$publisher->publish($this); // [tl! remove]
Publisher::publish($this); // [tl! add]
}
}当使用实时门面时，将使用 Facades 前缀后出现的接口或类名部分从服务容器解析发布者实现。在测试时，我们可以使用 Laravel 内置的门面测试辅助函数来模拟此方法调用：
<?php
use App\Models\Podcast;
use Facades\App\Contracts\Publisher;
use Illuminate\Foundation\Testing\RefreshDatabase;
pest()->use(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;
/**
* 一个测试示例。
*/
public function test_podcast_can_be_published(): void
{
$podcast = Podcast::factory()->create();
Publisher::shouldReceive('publish')->once()->with($podcast);
$podcast->publish();
}
}门面类参考
下面您将找到每个门面及其底层类。这是快速深入了解给定门面根的 API 文档的有用工具。服务容器绑定 键也包含在适用的地方。