CI框架源代码阅读笔记2 一切的入口 index.php

Posted 2020-09-24 cynchanpin

    上一节（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__));
}

　　这段代码是干嘛的呢？首先。STDIN、STDOUT、STDERR是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框架可以正常执行的关键。

　　最后。依照惯例。贴一下整个文件的源代码（简化凝视版）：

 1 <?
php
 2 
 3 define(\'ENVIRONMENT\', \'development\');
 4 
 5 if (defined(\'ENVIRONMENT\'))
 6 {
 7     switch (ENVIRONMENT)
 8     {
 9         case \'development\':
10             error_reporting(E_ALL);
11         break;
12     
13         case \'testing\':
14         case \'production\':
15             error_reporting(0);
16         break;
17 
18         default:
19             exit(\'The application environment is not set correctly.\');
20     }
21 }
22 
23 /*
24  * SYSTEM FOLDER NAME
25  */
26 $system_path = \'system\';
27 
28 /*
29  * APPLICATION FOLDER NAME
30  */
31 $application_folder = \'application\';
32 
33 /*
34  *  Resolve the system path for increased reliability
35  */
36 if (defined(\'STDIN\'))
37 {
38     chdir(dirname(__FILE__));
39 }
40 
41 if (realpath($system_path) !== FALSE)
42 {
43     $system_path = realpath($system_path).\'/\';
44 }
45 
46 $system_path = rtrim($system_path, \'/\').\'/\';
47 
48 if ( ! is_dir($system_path))
49 {
50     exit("xxxxxxxx");
51 }
52 
53 /*
54  *  set the main path constants
55  */
56 // The name of THIS file
57 define(\'SELF\', pathinfo(__FILE__, PATHINFO_BASENAME));
58 
59 // this global constant is deprecataaed.
60 define(\'EXT\', \'.php\');
61 
62 // Path to the system folder
63 define(\'BASEPATH\', str_replace("\\\\", "/", $system_path));
64 
65 // Path to the front controller (this file)
66 define(\'FCPATH\', str_replace(SELF, \'\', __FILE__));
67 
68 // Name of the "system folder"
69 define(\'SYSDIR\', trim(strrchr(trim(BASEPATH, \'/\'), \'/\'), \'/\'));
70 
71 // The path to the "application" folder
72 if (is_dir($application_folder))
73 {
74     define(\'APPPATH\', $application_folder.\'/\');
75 }
76 else
77 {
78     if ( ! is_dir(BASEPATH.$application_folder.\'/\'))
79     {
80         exit("Your application folder path does not appear to be set correctly. Please open the following file and correct this: ".SELF);
81     }
82 
83     define(\'APPPATH\', BASEPATH.$application_folder.\'/\');
84 }
85 
86 require_once BASEPATH.\'core/CodeIgniter.php\';