Laravel容器延迟加载以及Auth扩展详解

jopen 9年前

昨天按照手册教程,动手写一个Auth扩展,按照包独立性的原则,我不希望将Auth::extend()这种方法写在 start.php 中,毫无疑问,我选择了在服务提供器register()方法中注册扩展驱动。然而,事与愿违……

Laravel容器延迟加载以及Auth扩展详解

发现问题

当我在 LoauthServiceProvider 中这样写的时候:

public function register()  {      //      \Auth::extend('loauth',function($app){});  }

报错

Call to undefined method Illuminate\Support\Facades\Auth::extend()

寻找原因

当时就纳闷了,找原因,怀疑是Auth没注册?检查发现注册了,因为在路由中可以使用;php artisan clear-compiled 没用;百思不得其解,甚至怀疑是我不小心修改了核心类,还重新下载了一次laravel包,问题依旧。

折腾了一晚上,最终我把目光锁定在 AuthServiceProvider 的 $defer 属性。

根据手册以及注释,我们得知 $defer 属性是用来延迟加载该服务提供器,说直白点就是延迟执行 register() 方法,只需要配合provides()方法即可实现。举个例子:

public function provides()  {      return array('auth');  }

这个是 AuthServiceProvider 里的方法,当框架初始化的时候,会依次加载服务提供器,如果发现这个服务提供器protected $defer=true 那么就会调用它的 provides() 方法,其返回的数组包含需要延迟加载的服务名称,这样当我们在路由、控制器或者其他地方调用 Auth::METHOD() 的时候,才会去调用提供器的 register() 方法。

确定症结

那么问题来了,既然是被动延迟加载,也就是说当我调用Auth类方法时应该会自动实例化Auth类啊,为什么我在LoauthServiceProvider中调用的时候却提示方法不存在,但是在路由中却可以呢。

我猜测是因为优先级的问题,可能在框架注册 LoauthServiceProvider::register() 的时候,Auth 还没有标记为延迟加载,这就造成了一个先后问题,任何即时加载的服务提供器都无法在register方法中调用延迟加载的服务。

经过研究,顺利在核心代码中找到证据 Illuminate\Foundation\ProviderRepository

public function load(Application $app, array $providers)  {      //...省略      // We will go ahead and register all of the eagerly loaded providers with the      // application so their services can be registered with the application as      // a provided service. Then we will set the deferred service list on it.      foreach ($manifest['eager'] as $provider)      {          $app->register($this->createProvider($app, $provider));      }      //延迟加载标记在即时加载服务之后      $app->setDeferredServices($manifest['deferred']);  }

解决之道

虽然发现了问题所在,但并不代表问题就解决了,修改核心代码不是个明智的选择,所以只能在我们自己的包里想办法咯,一个解决方案如下:

public function register()  {      //      $authProvider = new \Illuminate\Auth\AuthServiceProvider($this->app);      $authProvider->register();      \Auth::extend('loauth',function($app){});  }

既然auth还未注册,那么我们手动调用它的register方法帮它注册。

来源:codeceo