入口脚本

入口脚本是应用启动流程中的第一环，一个应用（不管是网页应用还是控制台应用）只有一个入口脚本。终端用户的请求通过入口脚本实例化应用并将将请求转发到应用。

Web 应用的入口脚本必须放在终端用户能够访问的目录下，通常命名为 index.php，也可以使用 Web 服务器能定位到的其他名称。

控制台应用的入口脚本一般在应用根目录下命名为 yii（后缀为.php），该文件需要有执行权限，这样用户就能通过命令 ./yii <route> [arguments] [options] 来运行控制台应用。

入口脚本主要完成以下工作：

  • 定义全局常量；
  • 注册 Composer 自动加载器；
  • 包含 [[Yii]] 类文件；
  • 加载应用配置；
  • 创建一个应用实例并配置;
  • 调用 [[yii\base\Application::run()]] 来处理请求。

Web 应用

以下是基础应用模版入口脚本的代码：

  1. <?php
  3. defined('YII_DEBUG') or define('YII_DEBUG', true);
  4. defined('YII_ENV') or define('YII_ENV', 'dev');
  6. // 注册 Composer 自动加载器
  7. require(__DIR__ . '/../vendor/autoload.php');
  9. // 包含 Yii 类文件
  10. require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');
  12. // 加载应用配置
  13. $config = require(__DIR__ . '/../config/web.php');
  15. // 创建、配置、运行一个应用
  16. (new yii\web\Application($config))->run();

控制台应用

以下是一个控制台应用的入口脚本：

  1. #!/usr/bin/env php
  2. <?php
  3. /**
  4.  * Yii console bootstrap file.
  5.  *
  6.  * @link http://www.yiiframework.com/
  7.  * @copyright Copyright (c) 2008 Yii Software LLC
  8.  * @license http://www.yiiframework.com/license/
  9.  */
  11. defined('YII_DEBUG') or define('YII_DEBUG', true);
  13. // fcgi 默认没有定义 STDIN 和 STDOUT
  14. defined('STDIN') or define('STDIN', fopen('php://stdin', 'r'));
  15. defined('STDOUT') or define('STDOUT', fopen('php://stdout', 'w'));
  17. // 注册 Composer 自动加载器
  18. require(__DIR__ . '/vendor/autoload.php');
  20. // 包含 Yii 类文件
  21. require(__DIR__ . '/vendor/yiisoft/yii2/Yii.php');
  23. // 加载应用配置
  24. $config = require(__DIR__ . '/config/console.php');
  26. $application = new yii\console\Application($config);
  27. $exitCode = $application->run();
  28. exit($exitCode);

定义常量

入口脚本是定义全局常量的最好地方，Yii 支持以下三个常量：

  • YII_DEBUG：标识应用是否运行在调试模式。当在调试模式下，应用会保留更多日志信息，如果抛出异常，会显示详细的错误调用堆栈。因此，调试模式主要适合在开发阶段使用，YII_DEBUG 默认值为 false。
  • YII_ENV：标识应用运行的环境，详情请查阅配置章节。YII_ENV 默认值为 'prod'，表示应用运行在线上产品环境。
  • YII_ENABLE_ERROR_HANDLER：标识是否启用 Yii 提供的错误处理，默认为 true。

当定义一个常量时，通常使用类似如下代码来定义：

  1. defined('YII_DEBUG') or define('YII_DEBUG', true);

上面的代码等同于:

  1. if (!defined('YII_DEBUG')) {
  2.     define('YII_DEBUG', true);
  3. }

显然第一段代码更加简洁易懂。

常量定义应该在入口脚本的开头，这样包含其他 PHP 文件时，常量就能生效。