Skip to content

外观模式

介绍

外观提供了一个“静态”接口来访问应用程序的服务容器中的类。Laravel自带许多外观,您可能在不知不觉中已经在使用它们!Laravel的“外观”作为服务容器中底层类的“静态代理”,提供了简洁、富有表现力的语法,同时比传统的静态方法具有更好的可测试性和灵活性。

有时,您可能希望为您的应用程序和包创建自己的外观,因此让我们来探索这些类的概念、开发和使用。

NOTE

在深入了解外观之前,强烈建议您非常熟悉Laravel的服务容器

解释

在Laravel应用程序的上下文中,外观是一个提供从容器访问对象的类。使这项工作成为可能的机制在于Facade类。Laravel的外观以及您创建的任何自定义外观都将扩展基础Facade类。

您的外观类只需要实现一个方法:getFacadeAccessorgetFacadeAccessor方法的任务是定义从容器中解析什么。Facade基类利用__callStatic()魔术方法将来自您的外观的调用推迟到已解析的对象。

因此,当您进行类似Cache::get的外观调用时,Laravel会从服务容器中解析Cache管理器类,并在该类上调用get方法。从技术上讲,Laravel外观是使用Laravel服务容器作为服务定位器的便捷语法。

实际使用

在下面的示例中,调用了Laravel缓存系统。通过查看此代码,您可能会认为静态方法get正在被调用在Cache类上。

php
$value = Cache::get('key');

然而,如果我们查看Illuminate\Support\Facades\Cache类,您会发现没有静态方法get

php
class Cache extends Facade {

	/**
	 * 获取组件的注册名称。
	 *
	 * @return string
	 */
	protected static function getFacadeAccessor() { return 'cache'; }

}

Cache类扩展了基础Facade类并定义了一个方法getFacadeAccessor()。请记住,此方法的任务是返回服务容器绑定的名称。

当用户引用Cache外观上的任何静态方法时,Laravel会从服务容器中解析cache绑定,并在该对象上运行请求的方法(在本例中为get)。

因此,我们的Cache::get调用可以重写如下:

php
$value = $app->make('cache')->get('key');

导入外观

请记住,如果您在命名空间的控制器中使用外观,您需要将外观类导入到命名空间中。所有外观都位于全局命名空间中:

php
<?php namespace App\Http\Controllers;

use Cache;

class PhotosController extends Controller {

	/**
	 * 获取所有应用程序照片。
	 *
	 * @return Response
	 */
	public function index()
	{
		$photos = Cache::get('photos');

		//
	}

}

创建外观

为您自己的应用程序或包创建外观很简单。您只需要3件事:

  • 一个服务容器绑定。
  • 一个外观类。
  • 一个外观别名配置。

让我们看一个例子。这里,我们定义了一个类为PaymentGateway\Payment

php
namespace PaymentGateway;

class Payment {

	public function process()
	{
		//
	}

}

我们需要能够从服务容器中解析此类。因此,让我们将绑定添加到服务提供者中:

php
App::bind('payment', function()
{
	return new \PaymentGateway\Payment;
});

注册此绑定的一个好地方是创建一个新的服务提供者名为PaymentServiceProvider,并将此绑定添加到register方法中。然后,您可以配置Laravel从config/app.php配置文件加载您的服务提供者。

接下来,我们可以创建自己的外观类:

php
use Illuminate\Support\Facades\Facade;

class Payment extends Facade {

	protected static function getFacadeAccessor() { return 'payment'; }

}

最后,如果我们愿意,我们可以将外观的别名添加到config/app.php配置文件中的aliases数组中。现在,我们可以在Payment类的实例上调用process方法。

php
Payment::process();

关于自动加载别名的注意事项

aliases数组中的类在某些情况下不可用,因为PHP不会尝试自动加载未定义的类型提示类。如果\ServiceWrapper\ApiTimeoutException被别名为ApiTimeoutException,则在命名空间\ServiceWrapper之外的catch(ApiTimeoutException $e)将永远不会捕获异常,即使抛出了一个异常。在具有类型提示到别名类的类中也会发现类似的问题。唯一的解决方法是放弃别名并在每个需要它们的文件顶部use您希望类型提示的类。

模拟外观

单元测试是外观工作方式的重要方面。事实上,可测试性是外观存在的主要原因。有关更多信息,请查看文档的模拟外观部分。

外观类参考

下面您将找到每个外观及其底层类。这是快速深入了解给定外观根的API文档的有用工具。还包括服务容器绑定键(如适用)。

外观服务容器绑定
AppIlluminate\Foundation\Applicationapp
ArtisanIlluminate\Console\Applicationartisan
AuthIlluminate\Auth\AuthManagerauth
Auth (实例)Illuminate\Auth\Guard
BladeIlluminate\View\Compilers\BladeCompilerblade.compiler
BusIlluminate\Contracts\Bus\Dispatcher
CacheIlluminate\Cache\CacheManagercache
ConfigIlluminate\Config\Repositoryconfig
CookieIlluminate\Cookie\CookieJarcookie
CryptIlluminate\Encryption\Encrypterencrypter
DBIlluminate\Database\DatabaseManagerdb
DB (实例)Illuminate\Database\Connection
EventIlluminate\Events\Dispatcherevents
FileIlluminate\Filesystem\Filesystemfiles
HashIlluminate\Contracts\Hashing\Hasherhash
InputIlluminate\Http\Requestrequest
LangIlluminate\Translation\Translatortranslator
LogIlluminate\Log\Writerlog
MailIlluminate\Mail\Mailermailer
PasswordIlluminate\Auth\Passwords\PasswordBrokerauth.password
QueueIlluminate\Queue\QueueManagerqueue
Queue (实例)Illuminate\Queue\QueueInterface
Queue (基类)Illuminate\Queue\Queue
RedirectIlluminate\Routing\Redirectorredirect
RedisIlluminate\Redis\Databaseredis
RequestIlluminate\Http\Requestrequest
ResponseIlluminate\Contracts\Routing\ResponseFactory
RouteIlluminate\Routing\Routerrouter
SchemaIlluminate\Database\Schema\Blueprint
SessionIlluminate\Session\SessionManagersession
Session (实例)Illuminate\Session\Store
StorageIlluminate\Contracts\Filesystem\Factoryfilesystem
URLIlluminate\Routing\UrlGeneratorurl
ValidatorIlluminate\Validation\Factoryvalidator
Validator (实例)Illuminate\Validation\Validator
ViewIlluminate\View\Factoryview
View (实例)Illuminate\View\View