Laravel的Facade是什么?
Facade
其实是一个容器中类的静态代理,他可以让你以静态的方式来调用存放在容器中任何对象的任何方法。举个例子:
use Illuminate\Support\Facades\Cache;
Route::get('/cache', function () {
return Cache::get('key');
});
实际上,Cache
类并没有一个get
静态方法,但是却可以被调用,这就是Facade
的静态代理功能。
如何使用Facade?
假如我们自定义了一个类并且放入容器中后,该如何以Facade
的方式来调用呢?很简单:
use Illuminate\Support\Facades\Facade;
class Cache extends Facade
{
/**
* 获取组件注册名称
*
* @return string
*/
protected static function getFacadeAccessor() {
return 'cache';
}
}
只要定义一个类让他继承自Illuminate\Support\Facades\Facade
,并且实现一个抽象方法getFacadeAccessor
即可。这个方法只要返回一个字符串,就是返回服务容器绑定类的别名。其实,通过源码可以知道,对象不一定要放到容器中,可以直接在这里返回也是可以的,下面会说道:
use Illuminate\Support\Facades\Facade;
use Cache;
class Cache extends Facade
{
/**
* 获取组件注册名称
*
* @return string
*/
protected static function getFacadeAccessor() {
return new Cache;
}
}
如何实现的呢?
我们来看看Illuminate\Support\Facades\Facade
的源码:
abstract class Facade
{
/**
* The application instance being facaded.
*
* @var \Illuminate\Contracts\Foundation\Application
*/
protected static $app;
/**
* The resolved object instances.
*
* @var array
*/
protected static $resolvedInstance;
/**
* Get the root object behind the facade.
*
* @return mixed
*/
public static function getFacadeRoot()
{
return static::resolveFacadeInstance(static::getFacadeAccessor());
}
/**
* Get the registered name of the component.
*
* @return string
*
* @throws \RuntimeException
*/
protected static function getFacadeAccessor()
{
throw new RuntimeException('Facade does not implement getFacadeAccessor method.');
}
/**
* Resolve the facade root instance from the container.
*
* @param string|object $name
* @return mixed
*/
protected static function resolveFacadeInstance($name)
{
if (is_object($name)) {
return $name;
}
if (isset(static::$resolvedInstance[$name])) {
return static::$resolvedInstance[$name];
}
return static::$resolvedInstance[$name] = static::$app[$name];
}
/**
* Handle dynamic, static calls to the object.
*
* @param string $method
* @param array $args
* @return mixed
*
* @throws \RuntimeException
*/
public static function __callStatic($method, $args)
{
$instance = static::getFacadeRoot();
if (! $instance) {
throw new RuntimeException('A facade root has not been set.');
}
return $instance->$method(...$args);
}
}
Facade
的代码不止以上这些,我抽出了核心的部分。直接来看看__callStatic
这个方法:
public static function __callStatic($method, $args)
{
$instance = static::getFacadeRoot(); //解析出实例
if (! $instance) {
throw new RuntimeException('A facade root has not been set.');
}
return $instance->$method(...$args); //调用方法
}
这是PHP中的一个魔术方法,当以静态的方式调用一个不存在的方法时,该方法会被调用。代码很简单,就是解析实例调用方法。不过这里要注意一个就是这里使用的是static
关键字而不是self
关键字,这涉及到一个后期的静态绑定,可以看看文档:http://php.net/manual/zh/language.oop5.late-static-bindings.php
再来看看getFacadeRoot
的代码,这个方法就是从容器中解析出对象:
public static function getFacadeRoot(){
return static::resolveFacadeInstance(static::getFacadeAccessor());
}
protected static function getFacadeAccessor(){
throw new RuntimeException('Facade does not implement getFacadeAccessor method.');
}
protected static function resolveFacadeInstance($name){
if (is_object($name)) {
return $name;
}
if (isset(static::$resolvedInstance[$name])) {
return static::$resolvedInstance[$name];
}
return static::$resolvedInstance[$name] = static::$app[$name];
}
其中的getFacadeAccessor
这个方法必须被重写,否者就会抛出异常。然后在resolveFacadeInstance
这个方法中会先判断是否是一个对象,如果是的话就直接返回。所以上文说的getFacadeAccessor
这个方法直接返回一个对象也是可以的,奥秘就在这。
然后会去判断需要解析的对象是否已经解析过了,如果解析过了就直接返回,否则会从容器中去解析再返回,这样不仅仅实现了单例,而且还可以提升性能。
得到对象后,就是直接通过对象来调用方法了:
$instance->$method(...$args); //调用方法
总结
其实Laravel
的Facade
原理不难,但是在研究的过程是可以发现很多文档没有提供的内容的,也能进一步提高我们阅读源码的能力。