资讯专栏INFORMATION COLUMN

"php artisan serve"到底干了什么

TANKING / 2123人阅读

摘要:最近看了一下这个框架,写点东西当个笔记。函数会迭代属性为的,逐一将其注册,的方法继承自父类,关键的就是在这个里注册的。

最近看了一下 laravel 这个框架,写点东西当个笔记。跟着官网上的说明 install 好一个项目后,在项目根目录执行命令php artisan serve就可以开启一个简易的服务器进行开发,这个命令到底做了什么,看了一下代码,在这里简要描述一下自己的看法。

先说明一下,这里项目 install 的方法不是安装 laravel/installer,而是composer create-project --prefer-dist laravel/laravel blog,写笔记的时候 laravel 的版本还是 5.5,以后版本更新后可能就不一样了。

artisan 实际上是项目根目录下的一个 php 脚本,而且默认是有执行权限的,所以命令其实可以简写成artisan serve,脚本的代码行数很少,实际上就十几行:

</>复制代码

  1. #!/usr/bin/env php
  2. make(IlluminateContractsConsoleKernel::class);
  3. $status = $kernel->handle(
  4. $input = new SymfonyComponentConsoleInputArgvInput,
  5. new SymfonyComponentConsoleOutputConsoleOutput
  6. );
  7. $kernel->terminate($input, $status);
  8. exit($status);

代码里,require __DIR__."/vendor/autoload.php";的 autoload.php 文件是 composer 生成的文件,实际用处就是利用 php 提供 spl_autoload_register 函数注册一个方法,让执行时遇到一个未声明的类时会自动将包含类定义的文件包含进来,举个例子就是脚本当中并没有包含任何文件,但却可以直接 new 一个 SymfonyComponentConsoleInputArgvInput 对象,就是这个 autoload.php 的功劳了。

接下来的这一行,$app = require_once __DIR__."/bootstrap/app.php";,在脚本里实例化一个 IlluminateFoundationApplication 对象,将几个重要的接口和类绑定在一起,然后将 Application 对象返回,其中接下来用到的 IlluminateContractsConsoleKernel::class 就是在这里和 AppConsoleKernel::class 绑定在一起的。

$kernel = $app->make(IlluminateContractsConsoleKernel::class);,直观的解释就是让 $app 制造出一个 AppConsoleKernel::class 实例(虽然括号里是 IlluminateContractsConsoleKernel::class,但由于跟这个接口绑定在一起的是 AppConsoleKernel::class 所以实际上 $kernel 实际上是 AppConsoleKernel::class)。

之后的就是整个脚本中最重要的一行了,调用 $kernelhandle 方法,AppConsoleKernel::class这个类在项目根目录下的 app/Console 文件夹里,这个类并没有实现 handle 方法,实际上调用的是它的父类的 handle方法:

</>复制代码

  1. IlluminateFoundationConsoleKernelhandler 方法如下:

  2. </>复制代码

    1. public function handle($input, $output = null)
    2. {
    3. try {
    4. $this->bootstrap();
    5. return $this->getArtisan()->run($input, $output);
    6. } catch (Exception $e) {
    7. $this->reportException($e);
    8. $this->renderException($output, $e);
    9. return 1;
    10. } catch (Throwable $e) {
    11. $e = new FatalThrowableError($e);
    12. $this->reportException($e);
    13. $this->renderException($output, $e);
    14. return 1;
    15. }
    16. }
  3. bootstrap 方法如下:

  4. </>复制代码

    1. public function bootstrap()
    2. {
    3. if (! $this->app->hasBeenBootstrapped()) {
    4. $this->app->bootstrapWith($this->bootstrappers());
    5. }
    6. $this->app->loadDeferredProviders();
    7. if (! $this->commandsLoaded) {
    8. $this->commands();
    9. $this->commandsLoaded = true;
    10. }
    11. }
  5. 先从 bootstrap 方法说起, $kernel 对象里的成员 $app 实际上就是之前实例化的 IlluminateFoundationApplication ,所以调用的 bootstrapWith 方法是这样的:

  6. </>复制代码

    1. public function bootstrapWith(array $bootstrappers)
    2. {
    3. $this->hasBeenBootstrapped = true;
    4. foreach ($bootstrappers as $bootstrapper) {
    5. $this["events"]->fire("bootstrapping: ".$bootstrapper, [$this]);
    6. $this->make($bootstrapper)->bootstrap($this);
    7. $this["events"]->fire("bootstrapped: ".$bootstrapper, [$this]);
    8. }
    9. }
  7. 那么串联起来实际上 bootstrap 方法里的这一句 $this->app->bootstrapWith($this->bootstrappers()); 就是实例化了 $kernel$bootstrappers 包含的所有类并且调用了这些对象里的 bootstrap 方法:

  8. </>复制代码

    1. protected $bootstrappers = [
    2. IlluminateFoundationBootstrapLoadEnvironmentVariables::class,
    3. IlluminateFoundationBootstrapLoadConfiguration::class,
    4. IlluminateFoundationBootstrapHandleExceptions::class,
    5. IlluminateFoundationBootstrapRegisterFacades::class,
    6. IlluminateFoundationBootstrapSetRequestForConsole::class,
    7. IlluminateFoundationBootstrapRegisterProviders::class,
    8. IlluminateFoundationBootstrapBootProviders::class,
    9. ];
  9. 其中 IlluminateFoundationBootstrapRegisterProviders::classbootstrap 会调用 IlluminateFoundationApplication 实例的 registerConfiguredProviders 方法,这个方法会将读取到的项目配置里的配置项(项目根目录下的 config/app.php 文件里的 providers)放入一个 IlluminateSupportCollection 对象中,然后和缓存合并并且排除掉其中的重复项作为一个 ProviderRepository 实例的 load 方法的参数,这个 load 方法里会将 $defer 属性不为 trueProvider 类使用 IlluminateFoundationApplicationregister 方法注册(最简单理解就是 new 一个该 Provider 对象然后调用该对象的 register 方法)。

  10. artisan 十分重要的一个 ProviderArtisanServiceProvider)的注册过程非常绕。

  11. 项目根目录下的 config/app.php 里有个 ConsoleSupportServiceProvider$defer 属性为 true ,所以不会在上面提到的过程中马上注册,而会在 bootstrap 中的这句 $this->app->loadDeferredProviders(); 里注册。

  12. loadDeferredProviders 函数会迭代 $defer 属性为 trueProvider,逐一将其注册,ConsoleSupportServiceProviderregister 方法继承自父类 AggregateServiceProvider ,关键的 ArtisanServiceProvider 就是在这个 register 里注册的。

  13. ArtisanServiceProviderregister 方法如下:

  14. </>复制代码

    1. public function register()
    2. {
    3. $this->registerCommands(array_merge(
    4. $this->commands, $this->devCommands
    5. ));
    6. }
    7. protected function registerCommands(array $commands)
    8. {
    9. foreach (array_keys($commands) as $command) {
    10. call_user_func_array([$this, "register{$command}Command"], []);
    11. }
    12. $this->commands(array_values($commands));
    13. }
  15. 这个方法会调用自身的方法 registerCommandsregisterCommands 会调用 ArtisanServiceProvider 里所有名字类似 "register{$command}Command" 的方法,这些方法会在 IlluminateFoundationApplication 这个容器(即 IlluminateFoundationApplication 实例,这个类继承了 IlluminateContainerContainer)中注册命令,当需要使用这些命令时就会返回一个这些命令的实例:

  16. </>复制代码

    1. protected function registerServeCommand()
    2. {
    3. $this->app->singleton("command.serve", function () {
    4. return new ServeCommand;
    5. });
    6. }
  17. serve 这个命令为例,这个方法的用处就是当需要从容器里取出 command.serve 时就会得到一个 ServeCommand 实例。

  18. registerCommands 方法里还有一个重要的方法调用, $this->commands(array_values($commands));ArtisanServiceProvider 里并没有这个方法的声明,所以这个方法其实是在其父类 ServiceProvider 实现的:

  19. </>复制代码

    1. use IlluminateConsoleApplication as Artisan;
    2. ......
    3. public function commands($commands)
    4. {
    5. $commands = is_array($commands) ? $commands : func_get_args();
    6. Artisan::starting(function ($artisan) use ($commands) {
    7. $artisan->resolveCommands($commands);
    8. });
    9. }
  20. Artisan::starting 这个静态方法的调用会将括号里的匿名函数添加到 Artisan 类(实际上是 IlluminateConsoleApplication 类,不过引入时起了个别名)的静态成员 $bootstrappers 里,这个会在接下来再提及到。

  21. 接下来回到 IlluminateFoundationConsoleKernelhandler 方法,return $this->getArtisan()->run($input, $output);getArtisan 方法如下:

  22. </>复制代码

    1. protected function getArtisan()
    2. {
    3. if (is_null($this->artisan)) {
    4. return $this->artisan = (new Artisan($this->app, $this->events, $this->app->version()))
    5. ->resolveCommands($this->commands);
    6. }
    7. return $this->artisan;
    8. }
  23. 该方法会 new 出一个 Artisan 对象, 而这个类会在自己的构造函数调用 bootstrap 方法:

  24. </>复制代码

    1. protected function bootstrap()
    2. {
    3. foreach (static::$bootstrappers as $bootstrapper) {
    4. $bootstrapper($this);
    5. }
    6. }
  25. 这时候刚才被提及到的匿名函数就是在这里发挥作用,该匿名函数的作用就是调用 Artisan 对象的 resolveCommands 方法:

  26. </>复制代码

    1. public function resolve($command)
    2. {
    3. return $this->add($this->laravel->make($command));
    4. }
    5. public function resolveCommands($commands)
    6. {
    7. $commands = is_array($commands) ? $commands : func_get_args();
    8. foreach ($commands as $command) {
    9. $this->resolve($command);
    10. }
    11. return $this;
    12. }
  27. resolveCommands 方法中迭代的 $commands 参数实际上是 ArtisanServiceProvider 里的两个属性 $commands$devCommands merge 在一起后取出值的数组(merge 发生在 ArtisanServiceProviderregister 方法, registerCommands 中使用 array_values 取出其中的值),所以对于 serve 这个命令,实际上发生的是 $this->resolve("command.serve");,而在之前已经提到过,ArtisanServiceProvider"register{$command}Command" 的方法会在容器里注册命令,那么 resolve 方法的结果将会是将一个 new 出来 ServeCommand 对象作为参数被传递到 add 方法:

  28. </>复制代码

    1. public function add(SymfonyCommand $command)
    2. {
    3. if ($command instanceof Command) {
    4. $command->setLaravel($this->laravel);
    5. }
    6. return $this->addToParent($command);
    7. }
    8. protected function addToParent(SymfonyCommand $command)
    9. {
    10. return parent::add($command);
    11. }
  29. add 方法实际上还是调用了父类(SymfonyComponentConsoleApplication)的 add

  30. </>复制代码

    1. public function add(Command $command)
    2. {
    3. ......
    4. $this->commands[$command->getName()] = $command;
    5. ......
    6. return $command;
    7. }
  31. 关键在 $this->commands[$command->getName()] = $command;,参数 $command 已经知道是一个 ServeCommand 对象,所以这一句的作用就是在 Artisan 对象的 $commands 属性添加了一个键为 serve 、值为 ServeCommand 对象的成员。

  32. getArtisan 方法执行完后就会调用其返回的 Artisan 对象的 run 方法:

  33. </>复制代码

    1. public function run(InputInterface $input = null, OutputInterface $output = null)
    2. {
    3. $commandName = $this->getCommandName(
    4. $input = $input ?: new ArgvInput
    5. );
    6. $this->events->fire(
    7. new EventsCommandStarting(
    8. $commandName, $input, $output = $output ?: new ConsoleOutput
    9. )
    10. );
    11. $exitCode = parent::run($input, $output);
    12. $this->events->fire(
    13. new EventsCommandFinished($commandName, $input, $output, $exitCode)
    14. );
    15. return $exitCode;
    16. }
  34. $input 参数是在 artisan 脚本里 new 出来的 SymfonyComponentConsoleInputArgvInput 对象,getCommandName 是继承自父类的方法:

  35. </>复制代码

    1. protected function getCommandName(InputInterface $input)
    2. {
    3. return $this->singleCommand ? $this->defaultCommand : $input->getFirstArgument();
    4. }
  36. 也就是说这个方法的返回结果就是 SymfonyComponentConsoleInputArgvInput 对象的 getFirstArgument 方法的返回值:

  37. </>复制代码

    1. public function __construct(array $argv = null, InputDefinition $definition = null)
    2. {
    3. if (null === $argv) {
    4. $argv = $_SERVER["argv"];
    5. }
    6. // strip the application name
    7. array_shift($argv);
    8. $this->tokens = $argv;
    9. parent::__construct($definition);
    10. }
    11. ......
    12. public function getFirstArgument()
    13. {
    14. foreach ($this->tokens as $token) {
    15. if ($token && "-" === $token[0]) {
    16. continue;
    17. }
    18. return $token;
    19. }
    20. }
  38. getFirstArgument 方法会将属性 $tokens 里第一个不包含 "-" 的成员返回,而 $tokens 属性的值是在构造函数里生成的,所以可以知道 getCommandName 的结果就是 serve 。

  39. 接下来 Artisan 对象调用了父类的 run 方法(篇幅太长,省略掉一点):

  40. </>复制代码

    1. public function run(InputInterface $input = null, OutputInterface $output = null)
    2. {
    3. ......
    4. try {
    5. $exitCode = $this->doRun($input, $output);
    6. } catch (Exception $e) {
    7. if (!$this->catchExceptions) {
    8. throw $e;
    9. ......
    10. }
    11. public function doRun(InputInterface $input, OutputInterface $output)
    12. {
    13. ......
    14. $name = $this->getCommandName($input);
    15. ......
    16. try {
    17. $e = $this->runningCommand = null;
    18. // the command name MUST be the first element of the input
    19. $command = $this->find($name);
    20. ......
    21. $this->runningCommand = $command;
    22. $exitCode = $this->doRunCommand($command, $input, $output);
    23. $this->runningCommand = null;
    24. return $exitCode;
    25. }
    26. protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
    27. {
    28. ......
    29. if (null === $this->dispatcher) {
    30. return $command->run($input, $output);
    31. }
    32. ......
    33. }
  41. run 方法又会调用 doRun,而该方法会先使用 getCommandName 获取到命令的名字("serve"),然后使用 find 方法找出与该命令对应的 Command 对象(在 $commands 属性中查找,该属性的结构类似 "serve" => "ServeCommand"),被找出来的 Command 对象会被作为参数传递到 doRunCommand 方法,最后在其中调用该对象的 run 方法(ServeCommand 没有实现该方法,所以其实是调用父类 IlluminateConsoleCommandrun,但父类的方法实际也只有一行,那就是调用其父类的 run,所以贴出来的其实是 SymfonyComponentConsoleCommandCommandrun):

  42. </>复制代码

    1. public function run(InputInterface $input, OutputInterface $output)
    2. {
    3. ......
    4. if ($this->code) {
    5. $statusCode = call_user_func($this->code, $input, $output);
    6. } else {
    7. $statusCode = $this->execute($input, $output);
    8. }
    9. return is_numeric($statusCode) ? (int) $statusCode : 0;
    10. }
  43. $code 并没有赋值过,所以执行的是 $this->execute($input, $output);ServeCommand 没有实现该方法,IlluminateConsoleCommandexecute 方法如下:

  44. </>复制代码

    1. protected function execute(InputInterface $input, OutputInterface $output)
    2. {
    3. return $this->laravel->call([$this, "handle"]);
    4. }
  45. 也就是调用了 ServeCommandhandle 方法:

  46. </>复制代码

    1. public function handle()
    2. {
    3. chdir($this->laravel->publicPath());
    4. $this->line("Laravel development server started: host()}:{$this->port()}>");
    5. passthru($this->serverCommand());
    6. }
    7. protected function serverCommand()
    8. {
    9. return sprintf("%s -S %s:%s %s/server.php",
    10. ProcessUtils::escapeArgument((new PhpExecutableFinder)->find(false)),
    11. $this->host(),
    12. $this->port(),
    13. ProcessUtils::escapeArgument($this->laravel->basePath())
    14. );
    15. }
  47. 所以如果想打开一个简易的服务器做开发,把目录切换到根目录的 public 目录下,敲一下这个命令,效果是差不多的, php -S 127.0.0.1:8000 ../server.php

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/28181.html

相关文章

  • Laravel Artisan 命令

    摘要:显示帮助信息强制输出禁用输出 Laravel Framework version 5.1.3 (LTS) Usage: command [options] [arguments] Options: -h, --help 显示帮助信息 -q, --quiet Do not output any message -V, --ve...

    txgcwm 评论0 收藏0
  • Vue报错SyntaxError:TypeError:this.getOptionsisnotafunction的解决方法

      一、简单介绍  Vue 开发中会出现一些问题,比如:Vue报错SyntaxError:TypeError:this.getOptionsisnotafunction,要如何解决?  二、报错现象  ERROR Failed to compile with 1 error 上午10:39:05  error in ./src/views/Login.vue?vue&type=style&...

    3403771864 评论0 收藏0
  • Laravel 5.4 入门系列 1. 安装

    摘要:的安装与使用是什么是的一个依赖管理工具。它以项目为单位进行管理,你只需要声明项目所依赖的代码库,会自动帮你安装这些代码库。 Composer 的安装与使用 Composer 是什么 Composer 是 PHP 的一个依赖管理工具。它以项目为单位进行管理,你只需要声明项目所依赖的代码库,Composer 会自动帮你安装这些代码库。 安装 Composer Mac 下的安装只需要在命令行...

    hqman 评论0 收藏0
  • 源码解读:php artisan serve

    摘要:原文来自在学习的时候,可能很多人接触的第一个的命令就是,这样我们就可以跑起第一个的应用。本文来尝试解读一下这个命令行的源码。 原文来自:https://www.codecasts.com/blo... 在学习 Laravel 的时候,可能很多人接触的第一个 artisan 的命令就是:php artisan serve,这样我们就可以跑起第一个 Laravel 的应用。本文来尝试解读一...

    Loong_T 评论0 收藏0
  • 降低vue-router版本的2种解决方法实例

      在Vue.js官方的路由插件中,vue-router和vue.js是深度集成的,这类页面适合用于构建单页面应用。但要注意是由于无法注明版本,一般就默认安装router4.X,但我们创建的是vue2,只能结合 vue-router 3.x 版本才能使用。现在需要降低版本。  方法  我们知道vue-router 4.x 只能结合 vue3 进行使用,vue-router 3.x 只能结合 vue...

    3403771864 评论0 收藏0

发表评论

0条评论

TANKING

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<