Laravel Facade

版本5.1

namespace App\Http\Controllers;

use Cache;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function showProfile($id)
    {
        $user = Cache::get('user:'.$id);

        return view('profile', ['user' => $user]);
    }
}

代码中的 Cache 能够被这样直接使用因为使用了 Facade, 效果是通过 Cache 类使用静态方法调用容器中绑定的相应的类解析出的实例的对应方法。

有点绕额。

首先，Cache 实际是 Illuminate\Support\Facades\Cache 的别名，通过 class_alias 函数实现的, 这个步骤稍后再看。

Illuminate\Support\Facades\Cache 里继承 Illuminate\Support\Facades\Facade 并且实现了一个getFacadeAccessor方法。

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

回到 Cache::get('user:'.$id) 这个语句，当这个类没有找到get静态方法的时候，父类里的魔术方法会被调用。

public static function __callStatic($method, $args)
{
    $instance = static::getFacadeRoot();

    if (! $instance) {
        throw new RuntimeException('A facade root has not been set.');
    }

    switch (count($args)) {
        case 0:
            return $instance->$method();

        case 1:
            return $instance->$method($args[0]);

        case 2:
            return $instance->$method($args[0], $args[1]);

        case 3:
            return $instance->$method($args[0], $args[1], $args[2]);

        case 4:
            return $instance->$method($args[0], $args[1], $args[2], $args[3]);

        default:
            return call_user_func_array([$instance, $method], $args);
    }
}

getFacadeRoot 方法应该是要返回一个对象。

public static function getFacadeRoot()
{
    return static::resolveFacadeInstance(static::getFacadeAccessor());
}

getFacadeAccessor()方法在子类里定义了，只是返回一个字符串cache。

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];
}

$app会赋值为容器，也就是 $app['cache'], $app的父类继承了 ArrayAccess，于是 $app['cache'] 实际是调用了 $app->offsetGet('cache'), 实现 $app->make('cache')

在回到最初，Illuminate\Support\Facades\Cache 在哪里把 Cache 设置为别名，需要过一下 Laravel 的启动过程。看下入口文件 public/index.php

require __DIR__.'/../bootstrap/autoload.php';
$app = require_once __DIR__.'/../bootstrap/app.php';
$kernel = $app->make(Illuminate\Contracts\Http\Kernel::class);
$response = $kernel->handle(
        $request = Illuminate\Http\Request::capture()
);
$response->send();
$kernel->terminate($request, $response);

容器通过make Illuminate\Contracts\Http\Kernel::class 之后，得到是 App\Http\Kernel 的实例，下一句执行App\Http\Kernel 父类 Illuminate\Foundation\Http 中的handle方法，handle方法中调用了 sendRequestThroughRouter 方法， 这个方法里又执行 bootstrap 方法，这个方法是把需要启动的类名数组传递给容器的 bootstrapWith 方法来执行。

看下数组

protected $bootstrappers = [
    'Illuminate\Foundation\Bootstrap\DetectEnvironment',
    'Illuminate\Foundation\Bootstrap\LoadConfiguration',
    'Illuminate\Foundation\Bootstrap\ConfigureLogging',
    'Illuminate\Foundation\Bootstrap\HandleExceptions',
    'Illuminate\Foundation\Bootstrap\RegisterFacades',
    'Illuminate\Foundation\Bootstrap\RegisterProviders',
    'Illuminate\Foundation\Bootstrap\BootProviders',
];

里面的 Illuminate\Foundation\Bootstrap\RegisterFacades，就是注册Facades应该就是要找的类了。那传入容器 Illuminate\Foundation\Application 中的bootstrapWith 方法会发生什么额。

public function bootstrapWith(array $bootstrappers)
{
    $this->hasBeenBootstrapped = true;

    foreach ($bootstrappers as $bootstrapper) {
        $this['events']->fire('bootstrapping: '.$bootstrapper, [$this]);
        $this->make($bootstrapper)->bootstrap($this);
        $this['events']->fire('bootstrapped: '.$bootstrapper, [$this]);
    }
}

$this->make('Illuminate\Foundation\Bootstrap\RegisterFacades')->bootstrap($this);
也就是解析得到 Illuminate\Foundation\Bootstrap\RegisterFacades 的实例，执行里面的 bootstrap 方法。

public function bootstrap(Application $app)
{
    Facade::clearResolvedInstances();
    Facade::setFacadeApplication($app);
    AliasLoader::getInstance($app->make('config')->get('app.aliases'))->register();
}

看 setFacadeApplication($app) ，就是容器传入facade类，赋值给里面的 $app。

$app->make('config')->get('app.aliases') 可以猜到是取 config/app.php 中的aliases，也就是别名和对应Facade类。
$app->make('config')返回的是一个 Illuminate\Config\Repository 对象，这个设置是在 bootstrapWith 调用 Illuminate\Foundation\Bootstrap\LoadConfiguration 的时候，暂且不说。

'aliases' => [
        ...
        'Cache'     => Illuminate\Support\Facades\Cache::class,
        ...
        ]

把这个数组传入 Illuminate\Foundation\AliasLoader 的getInstance方法。

public static function getInstance(array $aliases = [])
{
    if (is_null(static::$instance)) {
        return static::$instance = new static($aliases);
    }

    $aliases = array_merge(static::$instance->getAliases(), $aliases);
    static::$instance->setAliases($aliases);
    return static::$instance;
}

就是把aliases赋值给了

public function register()
{
    if (! $this->registered) {
        $this->prependToLoaderStack();
        $this->registered = true;
    }
}

protected function prependToLoaderStack()
{
    spl_autoload_register([$this, 'load'], true, true);
}

public function load($alias)
{
    if (isset($this->aliases[$alias])) {
        return class_alias($this->aliases[$alias], $alias);
    }
}

就是用 spl_autoload_register 把 load 函数，放到了autoload的处理过程中，这个不管，看下 load 函数，就是那个数组里的Facade类都设置一个别名。