PHP中require()文件包含的正确用法

时间:2021-10-09 11:19:53

以前看一些PHP框架源码的时候,很奇怪在文件包含的时候,会用dirname(__FILE__)来拼凑文件路 径,不知道这样做有什么好处,后来终于发现了其中的缘由。

我们来看一个简单的例子:

有a,b,c三个php文件。a.php在网站根目录,b.php在b文件夹下——b/b.php,c.php在 c文件夹下——c/c.php。有些混乱?看图就一目了然了:

PHP中require()文件包含的正确用法

a.php 和 b.php 都包含了 c.php,最后 c.php 包含了d文件夹下的一个php文件 ——d/d.php。

我们先来看a.php:

<?php 

    $file_name = 'a.php';

    echo "this is a.php";
echo "<hr>"; require('c/c.php'); ?>

很简单的代码,打印输出后,包含了c/c.php,接着,我们需要看c/c.php:

<?php
$c_file_name = 'c.php'; echo 'this is c.php, is required by ' . $file_name;
echo "<hr>"; require('../d/d.php');
?>

打印输出 "this is c.php, is required by a.php",$file_name是在a.php中定义的变 量。在最后,包含了d.php。因为d文件夹在当前c.php文件的上一层,所以,按照常理,我们会理所当 然的把路径写成 "../d/d.php"。但是很遗憾,会报错。原因在于,在被包含的文件中如 c.php,再去包含其他文件,路径是相对于最外层的父文件来说的,也就是相对于a.php,可以理解为因 为你被我包含了,所以你要以我为准。看起来很玄乎,原理其实很简单:你可以把 require ('c/c.php'); 看成是c/c.php文件里的代码,这样我们的a.php看起来可以是这个样子:

<?php
$file_name = 'a.php'; echo "this is a.php";
echo "<hr>"; // require('c/c.php');
$c_file_name = 'c.php'; echo 'this is c.php, is required by ' . $file_name;
echo "<hr>"; require('../d/d.php');
?>

到此,你可以看到,我们要包含d/d.php文件时,刚才的路径是不是错误的了?因为,现在是在 a.php的代码里,我们是相对于a.php文件来说的,当然,路径应该是 require('d/d.php'); 才对了。 我们修改代码如下:

<?php
$file_name = 'a.php'; echo "this is a.php";
echo "<hr>"; // require('c/c.php');
$c_file_name = 'c.php'; echo 'this is c.php, is required by ' . $file_name;
echo "<hr>"; require('d/d.php');
?>

此时,你还没有领悟到深意,需要往下看,我们再看b/b.php:

<?php
$file_name = 'b.php'; echo "this is b.php";
echo "<hr>"; require('../c/c.php');
?>

不需要解释了吧,没啥问题,但是当你把 require('../c/c.php'); 换成 c/c.php 里面的代码的时 候,你就会发现问题了,注意,我们刚才修改了c/c.php里的代码,把 require('../d/d.php'); 改成 了 require('d/d.php'); 看下面包含进来后的代码:

<?php
$file_name = 'b.php'; echo "this is b.php";
echo "<hr>"; // require('../c/c.php');
$c_file_name = 'c.php'; echo 'this is c.php, is required by ' . $file_name;
echo "<hr>"; require('d/d.php');
?>

那么,相对于 b/b.php 来说,require('d/d.php'); 的路径错了,应该是 require ('../d/d.php'); 才对。你回去修改 c/c.php 中的require路径,但是不对呀,你改了之后,b/b.php 可以正常运行了,但是 a/a.php 又不行了,是不是,它们共用 c/c.php ,牵一发动全身,怎么办呢。

这个时候,我们回到文章开头提到的 dirname(__FILE__),这可是个好东西,可以完全解决以上问 题。用了它,就可以不用关心包含你的文件是哪个文件、在哪个路径下面了,不需要顾虑父文件所在的 层级,因为,dirname(__FILE__)可以相对于当前文件指定路径。也就是说,我们需要将我们的 c/c.php 中的 require 路径换为:

<?php
$c_file_name = 'c.php'; echo 'this is c.php, is required by ' . $file_name;
echo "<hr>"; require(dirname(__FILE__) . '/../d/d.php');
?>

这里,我们只需要把 c/c.php 作为参照,相对于它来说,d/d.php 在上一层。这样,就只有一个标 准了,那就是,以我为准,管你包含我,还是他包含我,我只以我自己为准,我要包含的文件只相对于 我自己而言了。

对于 dirname(__FILE__) 不明白的同修,请google,很简单。

好了,PHP技术分享到此结束,有任何疑问或有错误之处,请留言。话说,这是我的第一个标准技术 博文。第一篇是水文,第二篇是准技术,今天终于写了篇技术的,欧也。