CI框架源碼閱讀筆記2 一切的入口 index.php


上一節(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';


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM