36计教您如何提高PHP代码质量

作者Silver Moon在 binarytides 上发表的一篇《 40 Techniques to enhance your php code 》，文中主要探讨了如何提高PHP代码质量，供开发者学习与参考。 1.不要使用相对路径 常常会看到: require_once('../../lib/some_class.php'); 该方法有很多缺点: 它首

作者Silver Moon在binarytides上发表的一篇《40+ Techniques to enhance your php code》，文中主要探讨了如何提高PHP代码质量，供开发者学习与参考。

1.不要使用相对路径

常常会看到:

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

该方法有很多缺点:

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

因此会检查过多路径.

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

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

因此最佳选择是使用绝对路径:

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

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

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

现在, 无论你移到哪个目录, 如移到一个外网的服务器上, 代码无须更改便可正确运行.

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

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

require_once('lib/Database.php');  
require_once('lib/Mail.php');  
require_once('helpers/utitlity_functions.php'); 

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

function load_class($class_name)  
{  
 //path to the class file  

 $path = ROOT . '/lib/' . $class_name . '.php');  

 require_once( $path );  
}  
       
load_class('Database');  
load_class('Mail'); 

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

將来你可以按需扩展该函数, 如:

function load_class($class_name)  
{  
  //path to the class file  

    $path = ROOT . '/lib/' . $class_name . '.php');  

   
  if(file_exists($path))  
    {  
 require_once( $path );  
        }  
} 

还可做得更多:

为同样文件查找多个目录

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

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

3. 为应用保留调试代码

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

在开发环境中, 你可以:

define('ENVIRONMENT' , 'development');  
   

if(! $db->query( $query )  

{  

   if(ENVIRONMENT == 'development')  

   {  
      echo "$query failed";  
  }  
   else  
    {  
       echo "Database error. Please contact administrator";  
    }  
} 

在服务器中, 你可以:

define('ENVIRONMENT' , 'production');  

if(! $db->query( $query )  

{  

   if(ENVIRONMENT == 'development')  

   {  
       echo "$query failed";  
   }  
    else  
    {  
        echo "Database error. Please contact administrator";  
    }  
} 

4. 使用可跨平台的函数执行命令

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

更好的方案是封成函数一个可跨平台的函数。

01  /**  
02      Method to execute a command in the terminal  
03      Uses :  
04     
05      1. system  
06      2. passthru  
07      3. exec  
08      4. shell_exec  
09     
10  */  
11  function terminal($command)  
12  {  
13      //system  
14      if(function_exists('system'))  
15      {  
16          ob_start();  
17          system($command , $return_var);  

18          $output = ob_get_contents();  

19          ob_end_clean();  
20      }  
21      //passthru  
22      else if(function_exists('passthru'))  
23      {  
24          ob_start();  
25          passthru($command , $return_var);  

26          $output = ob_get_contents();  

27          ob_end_clean();  
28      }  
29     
30      //exec  
31      else if(function_exists('exec'))  
32      {  
33          exec($command , $output , $return_var);  

34          $output = implode("\n" , $output);  

35      }  
36     
37      //shell_exec  
38      else if(function_exists('shell_exec'))  
39      {  

40          $output = shell_exec($command) ;  

41      }  
42     
43      else  
44      {  

45          $output = 'Command execution not possible on this system';  


46          $return_var = 1;  

47      }  
48     

49      return array('output' => $output , 'status' => $return_var);  

50  }  
51     
52  terminal('ls'); 

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

5. 灵活编写函数

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

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

01  function add_to_cart($item_id , $qty)  
02  {  
03      if(!is_array($item_id))  
04      {  
05          $_SESSION['cart']['item_id'] = $qty;  
06      }  
07     
08      else  
09      {  

10          foreach($item_id as $i_id => $qty)  

11          {  
12              $_SESSION['cart']['i_id'] = $qty;  
13          }  
14      }  
15  }  
16     
17  add_to_cart( 'IPHONE3' , 2 );  

18  add_to_cart( array('IPHONE3' => 2 , 'IPAD' => 5) ); 

现在, 同个函数可以处理不同类型的输入参数了. 可以参照上面的例子重构你的多处代码, 使其更智能.

我很想知道为什么这么多关于php建议的博客文章都没提到这点.

1   php 
2      
3   echo "Hello";  
4      
5   //Now dont close this tag 

这將节约你很多时间. 我们举个例子:

一个 super_class.php 文件

01  php 
02  class super_class  
03  {  
04      function super_function()  
05      {  
06          //super code  
07      }  
08  }  

09  ?> 

10  //super extra character after the closing tag 

index.php

1   require_once('super_class.php');  
2      
3   //echo an image or pdf , or set the cookies or session data 

这样, 你將会得到一个 Headers already send error. 为什么? 因为 “super extra character” 已经被输出了. 现在你得开始调试啦. 这会花费大量时间寻找 super extra 的位置.

因此, 养成省略关闭符的习惯：

01  php 
02  class super_class  
03  {  
04      function super_function()  
05      {  
06          //super code  
07      }  
08  }  
09     
10  //No closing tag 

这会更好。

7. 在某地方收集所有输入, 一次输出给浏览器这称为输出缓冲, 假如说你已在不同的函数输出内容:

01  function print_header()  
02  {  

03      echo "div id='header'>Site Log and Login linksdiv>";  

04  }  
05     
06  function print_footer()  
07  {  

08      echo "div id='footer'>Site was made by mediv>";  

09  }  
10     
11  print_header();  

12  for($i = 0 ; $i  100; $i++)  

13  {  

14      echo "I is : $i br />';  

15  }  
16  print_footer(); 

替代方案, 在某地方集中收集输出. 你可以存储在函数的局部变量中, 也可以使用ob_start和ob_end_clean. 如下:

01  function print_header()  
02  {  

03      $o = "
Site Log and Login links
";  

04      return $o;  
05  }  
06     
07  function print_footer()  
08  {  

09      $o = "
Site was made by me
";  

10      return $o;  
11  }  
12     
13  echo print_header();  

14  for($i = 0 ; $i  100; $i++)  

15  {  

16      echo "I is : $i br />';  

17  }  
18  echo print_footer(); 

为什么需要输出缓冲:

>>可以在发送给浏览器前更改输出. 如 str_replaces 函数或可能是 preg_replaces 或添加些监控/调试的html内容.

>>输出给浏览器的同时又做php的处理很糟糕. 你应该看到过有些站点的侧边栏或中间出现错误信息. 知道为什么会发生吗? 因为处理和输出混合了.

8. 发送正确的mime类型头信息, 如果输出非html内容的话。

输出一些xml.

1   $xml = '';  

2   $xml = "response> 


3     code>0code> 


4   response>";  

5      
6   //Send xml data  
7   echo $xml; 

工作得不错. 但需要一些改进.

1   $xml = '';  

2   $xml = "response> 


3     code>0code> 


4   response>";  

5      
6   //Send xml data  
7   header("content-type: text/xml");  
8   echo $xml; 

注意header行. 该行告知浏览器发送的是xml类型的内容. 所以浏览器能正确的处理. 很多的javascript库也依赖头信息.

类似的有 javascript , css, jpg image, png image:

JavaScript

1   header("content-type: application/x-javascript");  

2   echo "var a = 10"; 

CSS

1   header("content-type: text/css");  
2   echo "#div id { background:#000; }"; 

9. 为mysql连接设置正确的字符编码曾经遇到过在mysql表中设置了unicode/utf-8编码, phpadmin也能正确显示, 但当你获取内容并在页面输出的时候,会出现乱码. 这里的问题出在mysql连接的字符编码.

01  //Attempt to connect to database  

02  $c = mysqli_connect($this->host , $this->username, $this->password);  

03     
04  //Check connection validity  
05  if (!$c)   
06  {  

07      die ("Could not connect to the database host: br />". mysqli_connect_error());  

08  }  
09     
10  //Set the character set of the connection  
11  if(!mysqli_set_charset ( $c , 'UTF8' ))  
12  {  
13      die('mysqli_set_charset() failed');  
14  } 

一旦连接数据库, 最好设置连接的 characterset. 你的应用如果要支持多语言, 这么做是必须的.

10. 使用 htmlentities 设置正确的编码选项php5.4前, 字符的默认编码是ISO-8859-1, 不能直接输出如à a等.

1 $value = htmlentities($this->value , ENT_QUOTES , CHARSET);  

php5.4以后, 默认编码为UTF-8, 这將解决很多问题. 但如果你的应用是多语言的, 仍然要留意编码问题,.

11. 不要在应用中使用gzip压缩输出, 让apache处理考虑过使用 ob_gzhandler 吗? 不要那样做. 毫无意义. php只应用来编写应用. 不应操心服务器和浏览器的数据传输优化问题.

使用apache的mod_gzip/mod_deflate 模块压缩内容。

12. 使用json_encode输出动态javascript内容时常会用php输出动态javascript内容:

01  $images = array(  
02   'myself.png' , 'friends.png' , 'colleagues.png'  
03  );  
04     

05  $js_code = '';  

06     
07  foreach($images as $image)  
08  {  

09  $js_code .= "'$image' ,";  

10  }  
11     

12  $js_code = 'var images = [' . $js_code . ']; ';  

13     
14  echo $js_code;  
15     

16  //Output is var images = ['myself.png' ,'friends.png' ,'colleagues.png' ,]; 

更聪明的做法, 使用 json_encode:

1   $images = array(  
2    'myself.png' , 'friends.png' , 'colleagues.png'  
3   );  
4      

5   $js_code = 'var images = ' . json_encode($images);  

6      
7   echo $js_code;  
8      

9   //Output is : var images = ["myself.png","friends.png","colleagues.png"] 

优雅乎?

13. 写文件前, 检查目录写权限写或保存文件前, 确保目录是可写的, 假如不可写, 输出错误信息. 这会节约你很多调试时间. linux系统中, 需要处理权限, 目录权限不当会导致很多很多的问题, 文件也有可能无法读取等等.

确保你的应用足够智能, 输出某些重要信息.

1   $contents = "All the content";  

2   $file_path = "/var/www/project/content.txt";  

3      
4   file_put_contents($file_path , $contents); 

这大体上正确. 但有些间接的问题. file_put_contents 可能会由于几个原因失败:

>>父目录不存在

>>目录存在, 但不可写

>>文件被写锁住?

所以写文件前做明确的检查更好.

01  $contents = "All the content";  

02  $dir = '/var/www/project';  


03  $file_path = $dir . "/content.txt";  

04     
05  if(is_writable($dir))  
06  {  
07      file_put_contents($file_path , $contents);  
08  }  
09  else  
10  {  
11      die("Directory $dir is not writable, or does not exist. Please check");  
12  } 

这么做后, 你会得到一个文件在何处写及为什么失败的明确信息.

14. 更改应用创建的文件权限在 linux环境中, 权限问题可能会浪费你很多时间. 从今往后, 无论何时, 当你创建一些文件后, 确保使用chmod设置正确权限. 否则的话, 可能文件先是由"php"用户创建, 但你用其它的用户登录工作, 系统將会拒绝访问或打开文件, 你不得不奋力获取root权限, 更改文件的权限等等.

1   // Read and write for owner, read for everybody else  
2   chmod("/somedir/somefile", 0644);  
3      
4   // Everything for owner, read and execute for others  
5   chmod("/somedir/somefile", 0755); 

15. 不要依赖submit按钮值来检查表单提交行为

1   if($_POST['submit'] == 'Save')  
2   {  
3       //Save the things  
4   } 

上面大多数情况正确, 除了应用是多语言的. 'Save' 可能代表其它含义. 你怎么区分它们呢. 因此, 不要依赖于submit按钮的值.

1   if( $_SERVER['REQUEST_METHOD'] == 'POST' and isset($_POST['submit']) )  
2   {  
3       //Save the things  
4   } 

现在你从submit按钮值中解脱出来了.

16. 为函数内总具有相同值的变量定义成静态变量

1   //Delay for some time  
2   function delay()  
3   {  

4       $sync_delay = get_option('sync_delay');  

5      

6       echo "br />Delaying for $sync_delay seconds...";  

7       sleep($sync_delay);  

8       echo "Done br />";  

9   } 

17. 不要直接使用 $_SESSION 变量

某些简单例子:

1 $_SESSION['username'] = $username;  
 

2 $username = $_SESSION['username'];  

 

这会导致某些问题. 如果在同个域名中运行了多个应用, session 变量可能会冲突. 两个不同的应用可能使用同一个session key. 例如, 一个前端门户, 和一个后台管理系统使用同一域名.

从现在开始, 使用应用相关的key和一个包装函数:

01  define('APP_ID' , 'abc_corp_ecommerce');  
02     
03  //Function to get a session variable  
04  function session_get($key)  
05  {  

06      $k = APP_ID . '.' . $key;  

07     
08      if(isset($_SESSION[$k]))  
09      {  
10          return $_SESSION[$k];  
11      }  
12     
13      return false;  
14  }  
15     
16  //Function set the session variable  
17  function session_set($key , $value)  
18  {  

19      $k = APP_ID . '.' . $key;  

20      $_SESSION[$k] = $value;  
21     
22      return true;  
23  } 

18. 將工具函数封装到类中

假如你在某文件中定义了很多工具函数:

01  function utility_a()  
02  {  
03      //This function does a utility thing like string processing  
04  }  
05     
06  function utility_b()  
07  {  
08      //This function does nother utility thing like database processing  
09  }  
10     
11  function utility_c()  
12  {  
13      //This function is ...  
14  } 

这些函数的使用分散到应用各处. 你可能想將他们封装到某个类中:

01  class Utility  
02  {  
03      public static function utility_a()  
04      {  
05     
06      }  
07     
08      public static function utility_b()  
09      {  
10     
11      }  
12     
13      public static function utility_c()  
14      {  
15     
16      }  
17  }  
18     
19  //and call them as  
20     

21  $a = Utility::utility_a();  


22  $b = Utility::utility_b(); 

显而易见的好处是, 如果php内建有同名的函数, 这样可以避免冲突.

另一种看法是, 你可以在同个应用中为同个类维护多个版本, 而不导致冲突. 这是封装的基本好处，无它。