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框架能够正常运行的关键。

  最后,按照惯例,贴一下整个文件的源码(简化注释版):

 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‘;
时间: 2024-10-14 01:01:42

CI框架源码阅读笔记2 一切的入口 index.php的相关文章

CI框架源码阅读笔记3 全局函数Common.php

从本篇开始,将深入CI框架的内部,一步步去探索这个框架的实现.结构和设计. Common.php文件定义了一系列的全局函数(一般来说,全局函数具有最高的加载优先权,因此大多数的框架中BootStrap引导文件都会最先引入全局函数,以便于之后的处理工作). 打开Common.php中,第一行代码就非常诡异: if ( ! defined('BASEPATH')) exit('No direct script access allowed'); 上一篇(CI框架源码阅读笔记2 一切的入口 index

CI框架源码阅读笔记4 引导文件CodeIgniter.php

到了这里,终于进入CI框架的核心了.既然是"引导"文件,那么就是对用户的请求.参数等做相应的导向,让用户请求和数据流按照正确的线路各就各位.例如,用户的请求url: http://you.host.com/usr/reg 经过引导文件,实际上会交给Application中的UsrController控制器的reg方法去处理. 这之中,CodeIgniter.php做了哪些工作?我们一步步来看. 1.    导入预定义常量.框架环境初始化 之前的一篇博客(CI框架源码阅读笔记2 一切的入

CI框架源码阅读笔记5 基准测试 BenchMark.php

上一篇博客(CI框架源码阅读笔记4 引导文件CodeIgniter.php)中,我们已经看到:CI中核心流程的核心功能都是由不同的组件来完成的.这些组件类似于一个一个单独的模块,不同的模块完成不同的功能,各模块之间可以相互调用,共同构成了CI的核心骨架. 从本篇开始,将进一步去分析各组件的实现细节,深入CI核心的黑盒内部(研究之后,其实就应该是白盒了,仅仅对于应用来说,它应该算是黑盒),从而更好的去认识.把握这个框架. 按照惯例,在开始之前,我们贴上CI中不完全的核心组件图: 由于BenchMa

CI框架源码阅读笔记1 - 环境准备、基本术语和框架流程

最开始使用CI框架的时候,就打算写一个CI源码阅读的笔记系列,可惜虎头蛇尾,一直没有行动.最近项目少,总算是有了一些时间去写一些东西.于是准备将之前的一些笔记和经验记录下来,一方面权作备忘,另一方面时刻提醒自己:借鉴和学习才有出路,忘记过去意味着背叛! 基本术语说明 在本文开始之前,有必要对文中反复出现的术语做一个简单的说明,如果你对这一部分已经熟谙,完全可以略过.本文中反复出现和提及的术语包括: 前端控制器(Front Controller): 用于集中控制用户的所有请求的组件,将用户的请求发

CI框架源码阅读笔记8 控制器Controller.php

最近时间有些紧,源码阅读系列更新有些慢.鉴于Controller中代码比较少,本次Blog先更新该文件的源码分析. 在经过路由分发之后,实际的应用Controller接管用户的所有请求,并负责与用户数据的交互.CI中所有的应用控制器都应该是CI_Controller的子类(除非你扩展了CI的核心,那么你的Controller父类可以是MY_Controller). 在应用程序控制器中,我们经常会用到这样的代码: /* 加载配置文件 */ $this->load->config("co

CI框架源码阅读笔记9 CI的自动加载机制autoload

本篇并不是对某一组件的详细源码分析,而只是简单的跟踪了下CI的autoload的基本流程.因此,可以看做是Loader组件的分析前提. CI框架中,允许你配置autoload数组,这样,在你的应用程序初始化时,会自动加载相应的类库,例如,在application/config/autoload.php中,autoload的配置如下: $autoload['libraries'] = array("smarty", "redis"); 则CI框架初始化时,会自动加载l

CI框架源码阅读笔记6 扩展钩子 Hook.php

CI框架允许你在不修改系统核心代码的基础上添加或者更改系统的核心功能(如重写缓存.输出等).例如,在系统开启hook的条件下(config.php中$config['enable_hooks'] = TRUE;),通过添加特定的钩子,可以让系统在特定的时刻触发特定的脚本: $hook['post_system'] = array( 'class' => 'frameLog', 'function' => 'postLog', 'filename' => 'post_system.php'

****CI框架源码阅读笔记7 配置管理组件 Config.php

http://blog.csdn.net/ohmygirl/article/details/41041597 一个灵活可控的应用程序中,必然会存在大量的可控参数(我们称为配置),例如在CI的主配置文件中(这里指Application/Config/Config.php文件),有如下多项配置: $config['base_url'] = 'http://test.xq.com'; $config['index_page'] = ''; $config['uri_protocol'] = 'AUTO

PHP框架CodeIgniter CI框架源码学习笔记-index.php一切的入口

CI框架(CodeIgniter)的基本执行流程图以备参考: index.php作为CI框架的入口文件,源码阅读,自然由此开始.