Yii2.0教程應用結構篇 —— 入口指令碼
入口指令碼是應用啟動流程中的第一環,一個應用(不管是網頁應用還是控制檯應用)只有一個入口指令碼。終端使用者的請求通過入口指令碼例項化應用並將將請求轉發到應用。
Web 應用的入口指令碼必須放在終端使用者能夠訪問的目錄下,通常命名為 index.php,也可以使用 Web 伺服器能定位到的其他名稱。
控制檯應用的入口指令碼一般在應用根目錄下命名為 yii(字尾為.php),該檔案需要有執行許可權,這樣使用者就能通過命令 ./yii <route> [arguments] [options] 來執行控制檯應用。
入口指令碼主要完成以下工作:
定義全域性常量;
註冊 Composer 自動載入器;
包含 [[Yii]] 類檔案;
載入應用配置;
建立一個應用例項並配置;
呼叫 [[yii\base\Application::run()]] 來處理請求。
Web 應用
以下是基礎應用模版入口指令碼的程式碼:
<?php defined('YII_DEBUG') or define('YII_DEBUG', true); defined('YII_ENV') or define('YII_ENV', 'dev'); // 註冊 Composer 自動載入器 require(__DIR__ . '/../vendor/autoload.php'); // 包含 Yii 類檔案 require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php'); // 載入應用配置 $config = require(__DIR__ . '/../config/web.php'); // 建立、配置、執行一個應用 (new yii\web\Application($config))->run();
控制檯應用
以下是一個控制檯應用的入口指令碼:
#!/usr/bin/env php <?php /** * Yii console bootstrap file. * * @link http://www.yiiframework.com/ * @copyright Copyright (c) 2008 Yii Software LLC * @license http://www.yiiframework.com/license/ */ defined('YII_DEBUG') or define('YII_DEBUG', true); // fcgi 預設沒有定義 STDIN 和 STDOUT defined('STDIN') or define('STDIN', fopen('php://stdin', 'r')); defined('STDOUT') or define('STDOUT', fopen('php://stdout', 'w')); // 註冊 Composer 自動載入器 require(__DIR__ . '/vendor/autoload.php'); // 包含 Yii 類檔案 require(__DIR__ . '/vendor/yiisoft/yii2/Yii.php'); // 載入應用配置 $config = require(__DIR__ . '/config/console.php'); $application = new yii\console\Application($config); $exitCode = $application->run(); exit($exitCode);
定義常量
入口指令碼是定義全域性常量的最好地方,Yii 支援以下三個常量:
YII_DEBUG:標識應用是否執行在除錯模式。當在除錯模式下,應用會保留更多日誌資訊,如果丟擲異常,會顯示詳細的錯誤呼叫堆疊。因此,除錯模式主要適合在開發階段使用,YII_DEBUG 預設值為 false。
YII_ENV:標識應用執行的環境,詳情請查閱配置章節。YII_ENV 預設值為 'prod',表示應用執行在線上產品環境。
YII_ENABLE_ERROR_HANDLER:標識是否啟用 Yii 提供的錯誤處理,預設為 true。
當定義一個常量時,通常使用類似如下程式碼來定義:
defined('YII_DEBUG') or define('YII_DEBUG', true);
上面的程式碼等同於:
if (!defined('YII_DEBUG')) { define('YII_DEBUG', true); }
顯然第一段程式碼更加簡潔易懂。
常量定義應該在入口指令碼的開頭,這樣包含其他 PHP 檔案時,常量就能生效。