提升php代码质量 36计(1)

 1.不要使用相对路径

经常会看到:

1	require_once('../../lib/some_class.php');

该方法有不少缺点:

它首先查找指定的php包含路径, 而后查找当前目录.

所以会检查过多路径.

若是该脚本被另外一目录的脚本包含, 它的基本目录变成了另外一脚本所在的目录.

另外一问题, 当定时任务运行该脚本, 它的上级目录可能就不是工做目录了.

所以最佳选择是使用绝对路径:

1	define('ROOT' , '/var/www/project/');
2	require_once(ROOT . '../../lib/some_class.php');

 

3
4	//rest of the code

 咱们定义了一个绝对路径, 值被写死了. 咱们还能够改进它. 路径 /var/www/project 也可能会改变, 那么咱们每次都要改变它吗? 不是的, 咱们可使用__FILE__常量, 如:

1	//suppose your script is /var/www/project/index.php
2	//Then __FILE__ will always have that full path.

 

3
4	define('ROOT' , pathinfo(__FILE__, PATHINFO_DIRNAME));

 

5	require_once(ROOT . '../../lib/some_class.php');
6

 

7	//rest of the code

如今, 不管你移到哪一个目录, 如移到一个外网的服务器上, 代码无须更改即可正确运行.

2. 不要直接使用 require, include, include_once, required_once

能够在脚本头部引入多个文件, 像类库, 工具文件和助手函数等, 如:

1	require_once('lib/Database.php');
2	require_once('lib/Mail.php');

 

3
4	require_once('helpers/utitlity_functions.php');

这种用法至关原始. 应该更灵活点. 应编写个助手函数包含文件. 例如:

1	function load_class($class_name)
2	{

 

3	//path to the class file
4	$path = ROOT . '/lib/' . $class_name . '.php');

 

5	require_once( $path );
6	}

 

7
8	load_class('Database');

 

9	load_class('Mail');

有什么不同吗? 该代码更具可读性.

將来你能够按需扩展该函数, 如:

01	function load_class($class_name)
02	{

 

03	//path to the class file
04	$path = ROOT . '/lib/' . $class_name . '.php');

 

05
06	if(file_exists($path))

 

07	{
08	require_once( $path );

 

09	}
10	}

还可作得更多:

为一样文件查找多个目录

能很容易的改变放置类文件的目录, 无须在代码各处一一修改

可以使用相似的函数加载文件, 如html内容.

3. 为应用保留调试代码

在开发环境中, 咱们打印数据库查询语句, 转存有问题的变量值, 而一旦问题解决, 咱们注释或删除它们. 然而更好的作法是保留调试代码.

在开发环境中, 你能够:

01	define('ENVIRONMENT' , 'development');
02

 

03	if(! $db->query( $query )
04	{

 

05	if(ENVIRONMENT == 'development')
06	{

 

07	echo "$query failed";
08	}

 

09	else
10	{

 

11	echo "Database error. Please contact administrator";
12	}

 

13

}

在服务器中, 你能够:

01	define('ENVIRONMENT' , 'production');
02

 

03	if(! $db->query( $query )
04	{

 

05	if(ENVIRONMENT == 'development')
06	{

 

07	echo "$query failed";
08	}

 

09	else
10	{

 

11	echo "Database error. Please contact administrator";
12	}

 

13

}