深刻理解PHP之require/include顺序

 深刻理解PHP之require/include顺序

• 做者: Laruence(   )
• 本文地址: http://www.laruence.com/2010/05/04/1450.html
• 转载请注明出处

在大型的Web项目中, include_path是一个模块化设计的根本中的根本(固然,如今也有不少基于autoload的设计, 这个不影响本文的探讨), 可是正是由于include_path, 常常会让咱们遇到一些由于没有找到正确的文件而致使的看似”诡异”的问题.

也就有了以下的疑问:

include_path是怎么起做用的?

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

什么状况下include_path不起做用?

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

以下的目录结构:

在1.php中:

 

  root
    ├ 1.php
    ├ 3.php
    └ subdir
         ├ 2.php
          └ 3.php

而在2.php中:

 

<?php
require("3.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)寻找此文件.

接下来, 在_php_stream_fopen_with_path中, 会作以下判断:

要包含的文件路径是相对路径么(形如./file, ../dir/file, 如下用"目录相对路径代替")?
 若是是, 则跳过include_path的做用逻辑, 直接解析相对路径(随后单独介绍).

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

".:path_to_subdir:current_script_dir"

而后, 依次从待选列表头部开始, 根据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,

<?php
ini_set("include_path", '');
require("3.php");
?>

那么将会是current_script_dir起做用, 而这个时候current_script_dir是2.php的路径, 因此仍是会获得”subdir”的输出.

目录相对路径

在使用目录相对路径的状况下, 相对路径的基点, 永远都是当前工做目录.

为了说明在目录相对路径下的状况,咱们再看个列子, 仍是上面的目录结构, 只不过1.php变成了:

<?php
ini_set("include_path", "/");
require("./subdir/2.php");
?>

2.php变成了:

<?php
require("./3.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__常量)从而使用绝对路径.