上一節(CI框架原始碼閱讀筆記1 - 環境準備、基本術語和框架流程)中,我們提到了CI框架的基本流程,這裡再次貼出流程圖,以備參考:


作為CI框架的入口檔案,原始碼閱讀,自然由此開始。在原始碼閱讀的過程中,我們並不會逐行進行解釋,而只解釋核心的功能和實現。

1.       設定應用程式環境

define('ENVIRONMENT', 'development');

這裡的development可以是任何你喜歡的環境名稱(比如dev,再如test),相對應的,你要在下面的switch case程式碼塊中,對設定的環境做相關的錯誤控制,否則,CI框架會認為你沒有配置好相應的環境,從而退出程序並給出對應的錯誤資訊:

default:     exit('The application environment is not set correctly.');

為什麼一開始就要配置ENVIRONMENT?這是因為,CI框架中很多元件都依賴於ENVIRONMENT的配置,我們看一下system中,引用ENVIRONMENT的地方:


可以看到,很多元件都依賴於ENVIRONMENT.例如,檢視system/config/Common.php, 這其中有一段引入配置檔案的程式碼,是這樣實現的:

if ( ! defined('ENVIRONMENT') OR ! file_exists($file_path = APPPATH.'config/'.ENVIRONMENT.'/config.php'))
{
$file_path = APPPATH.'config/config.php';
}

在CI框架中,很多配置檔案都是通過這種方式引入的,因此ENVRIONMENT對於CI框架的正確執行時必須的,所以需要在開始的時候配置好ENVIRONMENT。設定ENVIRONMENT的一個好處是:可以很方便的切換系統的配置而不必修改系統程式碼。例如,在系統進入測試階段時,database配置為測試的資料庫,而在系統測試完畢時,database切換到線上的資料庫。這好比是用一個開關控制了系統的環境切換,自然是非常方便的。

2.  配置系統目錄和應用程式目錄

CI框架允許你將系統核心原始碼和應用程式程式碼分開放置,但是你必須設定好系統的system資料夾和application資料夾(同樣,資料夾名字可以是任何合法的資料夾名稱,而不一定使用’system’和’application’):

$system_path = 'system';
$application_folder = 'application';

接下來,有這麼一段程式碼:

if (defined('STDIN'))
{
chdir(dirname(__FILE__));
}

這段程式碼是幹嘛的呢?首先,STDINSTDOUTSTDERR是PHP以 CLI(Command Line Interface)模式執行而定義的三個常量,這三個常量類似於Shell的stdin,stdout,stdout,分別是PHP CLI模式下的標準輸入標準輸出標準錯誤流。也就是說,這三行程式碼是為了保證命令列模式下,CI框架可以正常執行。關於PHP CLI的更多細節可以參考:http://www.php-cli.com/

3.       system目錄的正確性驗證和application目錄驗證

(1).       system目錄的正確性驗證
  Realpath返回的是目錄或檔案的絕對目錄名(沒有最後的/)

if (realpath($system_path) !== FALSE)
{
$system_path = realpath($system_path).'/';
}
$system_path = rtrim($system_path, '/').'/';
if ( ! is_dir($system_path))
{
exit("xxxxxxxx");
}

幾個定義的常量(PATH結尾的常量表示目錄路徑,DIR結尾的變量表示目錄名):
a.       SELF(這裡指index.php檔案)
b.       EXT(deprecated,廢棄的,不必關注)
c.       BASEPATH(system資料夾的路徑)
d.       FCPATH(前端控制器的路徑)
e.       SYSDIR(系統system目錄名)
f.        APPPATH(應用程式路徑)

檢視所有定義的常量的方法:

Print_r(get_defined_constants());

(2)application的目錄驗證。

程式碼較簡單,不做過多的解釋:

if (is_dir($application_folder))
{
define('APPPATH', $application_folder.'/');
}
else
{
if ( ! is_dir(BASEPATH.$application_folder.'/'))
{
exit("Your application folder path does not appear to be set correctly. Please open the following file and correct this: ".SELF);
} define('APPPATH', BASEPATH.$application_folder.'/');
}

入口檔案的最後一行,引入CodeIgniter.php(也是下一步閱讀的關鍵)。CodeIgniter.php被稱為bootstrap file,也就是它是一個引導檔案,是CI框架執行流程的核心檔案。

require_once BASEPATH.'core/CodeIgniter.php';

總結一下,index.php並沒有做太多複雜的工作,而是類似一個後勤,為CI框架的執行提供了一系列配置引數和正確性驗證,而這些配置和驗證,是CI框架能夠正常執行的關鍵。

最後,按照慣例,貼一下整個檔案的原始碼(簡化註釋版):

<?php

define('ENVIRONMENT', 'development');

if (defined('ENVIRONMENT'))
{
switch (ENVIRONMENT)
{
case 'development':
error_reporting(E_ALL);
break; case 'testing':
case 'production':
error_reporting(0);
break; default:
exit('The application environment is not set correctly.');
}
} /*
* SYSTEM FOLDER NAME
*/
$system_path = 'system'; /*
* APPLICATION FOLDER NAME
*/
$application_folder = 'application'; /*
* Resolve the system path for increased reliability
*/
if (defined('STDIN'))
{
chdir(dirname(__FILE__));
} if (realpath($system_path) !== FALSE)
{
$system_path = realpath($system_path).'/';
} $system_path = rtrim($system_path, '/').'/'; if ( ! is_dir($system_path))
{
exit("xxxxxxxx");
} /*
* set the main path constants
*/
// The name of THIS file
define('SELF', pathinfo(__FILE__, PATHINFO_BASENAME)); // this global constant is deprecataaed.
define('EXT', '.php'); // Path to the system folder
define('BASEPATH', str_replace("\\", "/", $system_path)); // Path to the front controller (this file)
define('FCPATH', str_replace(SELF, '', __FILE__)); // Name of the "system folder"
define('SYSDIR', trim(strrchr(trim(BASEPATH, '/'), '/'), '/')); // The path to the "application" folder
if (is_dir($application_folder))
{
define('APPPATH', $application_folder.'/');
}
else
{
if ( ! is_dir(BASEPATH.$application_folder.'/'))
{
exit("Your application folder path does not appear to be set correctly. Please open the following file and correct this: ".SELF);
} define('APPPATH', BASEPATH.$application_folder.'/');
} require_once BASEPATH.'core/CodeIgniter.php';