也就有了如下的疑问:

include_path是怎么起作用的?

如果有多个include_path顺序是怎么样的?

什么情况下include_path不起作用?

今天,我就全面的介绍下这个问题,先从一个例子开始吧.

如下的目录结构:

PHP sh_sourceCode" name="code" linenum="off">
root
├ 1.PHP
├ 3.PHP
└ subdir
├ 2.PHP
└ 3.PHP

在1.PHP中:

而在2.PHP中:

而在root目录下的3.PHP打印出”root”,在subdir目录下的3.PHP打印出”subdir”;

现在,我的问题来了:
1. 当在root目录下运行1.PHP,会得到什么输出?
2. 在subdir下运行上一级目录的1.PHP,有会得到什么输出?
3. 当取消include_path中的当前目录path(也就是include_path=”path_to_subdir”),上面俩个问题又会是什么输出?

PHP中的include_path

PHP在遇到require(_once)/include(_once)的指令的时候,首先会做如下的判断:

接下来,在_PHP_stream_fopen_with_path中,会做如下判断:

会根据include_path,和当前执行文件的path组成一个待选的目录列表,比如对于文章前面的例子来说,会形成一个如下的待选列表

然后,依次从待选列表头部开始,根据DEFAULT_DIR_SEPARATOR(本文的环境是”:”)取出待选列表中的一个路径,然后把要包含的文件名附加在这个路径后面,进行尝试. 如果成功包含,则返回,否则继续下一个待选路径.
到现在为止,我们已经可以回答我开头提出的3个问题了.
1. 因为在root目录下执行,所以在1.PHP中包含2.PHP的时候,include_path的第二个待选路径起了作用(path_to_subdir),找到了path_to_subdir/2.PHP,而在2.PHP包含3.PHP的时候,当前工作目录是root下,所以在包含3.PHP的时候,include_path的第一个待选路径”.”(当前工作目录)下就找到的匹配的文件,所以得到的输出是”root”.
2. 同1,只不过当前的路径是subdir,所以得到的输出是”subdir”.
3. 因为没有了当前路径为include_path,所以在root目录下运行的时候2.PHP中包含3.PHP的时候,是path_to_subdir起了作用,所以无论在root还是subdir都将得到”subdir”的输出.
而如果在2.PHP中清空include_path,

那么将会是current_script_dir起作用,而这个时候current_script_dir是2.PHP的路径,所以还是会得到”subdir”的输出.

目录相对路径

在使用目录相对路径的情况下,相对路径的基点,永远都是当前工作目录.
为了说明在目录相对路径下的情况,我们再看个列子,还是上面的目录结构,只不过1.PHP变成了:

2.PHP变成了:

如果在root目录下执行,2.PHP中寻找3.PHP将会在当前目录的相对路径下寻找,所以得到的输出是”root”,而如果是在subdir下执行上一级目录的1.PHP(PHP -f ../1.PHP),将会因为在subdir下找不到”./subdir/2.PHP”而异常退出.

后记

1. 因为使用include_path和相对路径的情况下,性能会和寻找的次数有关,最坏的情况下,如果你有10个include_path,那么最多可能会重试11次才能找到要包含的文件,所以,在能使用绝对路径的情况下最好使用绝对路径.
2. 因为目录相对路径的basedir,永远都是当前工作路径,如果要使用,需要和实际部署路径相关,所以实际使用的很少(当然,也有借助chdir来完成的模块).
3. 在模块化的系统设计中,一般应该在模块内,通过获取模块的部署路径(dirname(__FILE__),PHP5.3以后更是提供了__DIR__常量)从而使用绝对路径.