提高php代码质量 36计

luinstein

1.不要使用相对路径
  常常会看到:

2. require_once(\'../../lib/some_class.php\');

复制代码

该方法有很多缺点:
   它首先查找指定的php包含路径, 然后查找当前目录.
   因此会检查过多路径.
   如果该脚本被另一目录的脚本包含, 它的基本目录变成了另一脚本所在的目录.
   另一问题, 当定时任务运行该脚本, 它的上级目录可能就不是工作目录了.
   因此最佳选择是使用绝对路径:

2. define(\'ROOT\' , \'/var/www/project/\');
3. require_once(ROOT . \'../../lib/some_class.php\');
5. //rest of the code

复制代码

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

2. //suppose your script is /var/www/project/index.php
3. //Then __FILE__ will always have that full path.
5. define(\'ROOT\' , pathinfo(__FILE__, PATHINFO_DIRNAME));
6. require_once(ROOT . \'../../lib/some_class.php\');
8. //rest of the code

复制代码

现在, 无论你移到哪个目录, 如移到一个外网的服务器上, 代码无须更改便可正确运行.
  
   2. 不要直接使用 require, include, include_once, required_once
  可以在脚本头部引入多个文件, 像类库, 工具文件和助手函数等, 如:

2. require_once(\'lib/Database.php\');
3. require_once(\'lib/Mail.php\');
5. require_once(\'helpers/utitlity_functions.php\');

复制代码

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

2. function load_class($class_name)
3. {
4.     //path to the class file
5.     $path = ROOT . \'/lib/\' . $class_name . \'.php\');
6.     require_once( $path );
7. }
9. load_class(\'Database\');
10. load_class(\'Mail\');

复制代码

有什么不一样吗? 该代码更具可读性.
   將来你可以按需扩展该函数, 如:

2. function load_class($class_name)
3. {
4.     //path to the class file
5.     $path = ROOT . \'/lib/\' . $class_name . \'.php\');
7.     if(file_exists($path))
8.     {
9.         require_once( $path );
10.     }
11. }

复制代码

还可做得更多: 为同样文件查找多个目录
   能很容易的改变放置类文件的目录, 无须在代码各处一一修改
   可使用类似的函数加载文件, 如html内容.
  
   3. 为应用保留调试代码
  在开发环境中, 我们打印数据库查询语句, 转存有问题的变量值, 而一旦问题解决, 我们注释或删除它们. 然而更好的做法是保留调试代码.
   在开发环境中, 你可以:

2. define(\'ENVIRONMENT\' , \'development\');
4. if(! $db->query( $query )
5. {
6.     if(ENVIRONMENT == \'development\')
7.     {
8.         echo \"$query failed\";
9.     }
10.     else
11.     {
12.         echo \"Database error. Please contact administrator\";
13.     }
14. }

复制代码

在服务器中, 你可以:

2. define(\'ENVIRONMENT\' , \'production\');
4. if(! $db->query( $query )
5. {
6.     if(ENVIRONMENT == \'development\')
7.     {
8.         echo \"$query failed\";
9.     }
10.     else
11.     {
12.         echo \"Database error. Please contact administrator\";
13.     }
14. }

复制代码

  4. 使用可跨平台的函数执行命令
  system, exec, passthru, shell_exec 这4个函数可用于执行系统命令. 每个的行为都有细微差别. 问题在于, 当在共享主机中, 某些函数可能被选择性的禁用. 大多数新手趋于每次首先检查哪个函数可用, 然而再使用它.
   更好的方案是封成函数一个可跨平台的函数.

2. /**
3.         Method to execute a command in the terminal
4.         Uses :
6.         1. system
7.         2. passthru
8.         3. exec
9.         4. shell_exec
11. */
12. function terminal($command)
13. {
14.         //system
15.         if(function_exists(\'system\'))
16.         {
17.                 ob_start();
18.                 system($command , $return_var);
19.                 $output = ob_get_contents();
20.                 ob_end_clean();
21.         }
22.         //passthru
23.         else if(function_exists(\'passthru\'))
24.         {
25.                 ob_start();
26.                 passthru($command , $return_var);
27.                 $output = ob_get_contents();
28.                 ob_end_clean();
29.         }
31.         //exec
32.         else if(function_exists(\'exec\'))
33.         {
34.                 exec($command , $output , $return_var);
35.                 $output = implode(\"n\" , $output);
36.         }
38.         //shell_exec
39.         else if(function_exists(\'shell_exec\'))
40.         {
41.                 $output = shell_exec($command) ;
42.         }
44.         else
45.         {
46.                 $output = \'Command execution not possible on this system\';
47.                 $return_var = 1;
48.         }
50.         return array(\'output\' => $output , \'status\' => $return_var);
51. }
53. terminal(\'ls\');

复制代码

上面的函数將运行shell命令, 只要有一个系统函数可用, 这保持了代码的一致性.
  
   5. 灵活编写函数

2. function add_to_cart($item_id , $qty)
3. {
4.     $_SESSION[\'cart\'][\'item_id\'] = $qty;
5. }
7. add_to_cart( \'IPHONE3\' , 2 );

复制代码

使用上面的函数添加单个项目. 而当添加项列表的时候,你要创建另一个函数吗? 不用, 只要稍加留意不同类型的参数, 就会更灵活. 如:

2. function add_to_cart($item_id , $qty)
3. {
4.     if(!is_array($item_id))
5.     {
6.         $_SESSION[\'cart\'][\'item_id\'] = $qty;
7.     }
9.     else
10.     {
11.         foreach($item_id as $i_id => $qty)
12.         {
13.             $_SESSION[\'cart\'][\'i_id\'] = $qty;
14.         }
15.     }
16. }
18. add_to_cart( \'IPHONE3\' , 2 );
19. add_to_cart( array(\'IPHONE3\' => 2 , \'IPAD\' => 5) );

复制代码

现在, 同个函数可以处理不同类型的输入参数了. 可以参照上面的例子重构你的多处代码, 使其更智能.
  
   6. 有意忽略php关闭标签
   我很想知道为什么这么多关于php建议的博客文章都没提到这点.
  <div class=\"blockcode\"><div id=\"code_uQ4\"><ol>