提高PHP代码质量36计

1.不要使用相对路径

创新互联-专业网站定制、快速模板网站建设、高性价比鱼台网站开发、企业建站全套包干低至880元,成熟完善的模板库,直接使用。一站式鱼台网站制作公司更省心,省钱,快速模板网站建设找我们，业务覆盖鱼台地区。费用合理售后完善，十余年实体公司更值得信赖。

常常会看到:

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

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

 
 
 
  
  
  /**  
  
  
      Method to execute a command in the terminal  
  
  
      Uses :  
  
  
   
  
  
      1. system  
  
  
      2. passthru  
  
  
      3. exec  
  
  
      4. shell_exec  
  
  
   
  
  
  */ 
  
  
  function terminal($command)  
  
  
  {  
  
  
      //system  
  
  
      if(function_exists('system'))  
  
  
      {  
  
  
          ob_start();  
  
  
          system($command , $return_var);  
  
  
          $output = ob_get_contents();  
  
  
          ob_end_clean();  
  
  
      }  
  
  
      //passthru  
  
  
      else if(function_exists('passthru'))  
  
  
      {  
  
  
          ob_start();  
  
  
          passthru($command , $return_var);  
  
  
          $output = ob_get_contents();  
  
  
          ob_end_clean();  
  
  
      }  
  
  
   
  
  
      //exec  
  
  
      else if(function_exists('exec'))  
  
  
      {  
  
  
          exec($command , $output , $return_var);  
  
  
          $output = implode("\n" , $output);  
  
  
      }  
  
  
   
  
  
      //shell_exec  
  
  
      else if(function_exists('shell_exec'))  
  
  
      {  
  
  
          $output = shell_exec($command) ;  
  
  
      }  
  
  
   
  
  
      else 
  
  
      {  
  
  
          $output = 'Command execution not possible on this system';  
  
  
          $return_var = 1;  
  
  
      }  
  
  
   
  
  
      return array('output' => $output , 'status' => $return_var);  
  
  
  }  
  
  
   
  
  
  terminal('ls');

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

5. 灵活编写函数

 
 
 
  
  
  function add_to_cart($item_id , $qty) 
  
  
  { 
  
  
   $_SESSION['cart']['item_id'] = $qty; 
  
  
  } 
  
  
   
  
  
  add_to_cart( 'IPHONE3' , 2 );

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

 
 
 
  
  
  function add_to_cart($item_id , $qty)  
  
  
  {  
  
  
      if(!is_array($item_id))  
  
  
      {  
  
  
          $_SESSION['cart']['item_id'] = $qty;  
  
  
      }  
  
  
   
  
  
      else 
  
  
      {  
  
  
          foreach($item_id as $i_id => $qty)  
  
  
          {  
  
  
              $_SESSION['cart']['i_id'] = $qty;  
  
  
          }  
  
  
      }  
  
  
  }  
  
  
   
  
  
  add_to_cart( 'IPHONE3' , 2 );  
  
  
  add_to_cart( array('IPHONE3' => 2 , 'IPAD' => 5) );

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

6. 有意忽略php关闭标签

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

 
 
 
  
  
  
  
  
  
 
  
  
  echo "Hello";  
  
  
   
  
  
  //Now dont close this tag

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

一个 super_class.php 文件

 
 
 
  
  
  
  
  
  
class super_class  
  
  
  {  
  
  
      function super_function()  
  
  
      {  
  
  
          //super code  
  
  
      }  
  
  
  }  
  
  
  ?>  
  
  
  //super extra character after the closing tag

index.php

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

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

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

 
 
 
  
  
  
  
  
  
class super_class  
  
  
  {  
  
  
      function super_function()  
  
  
      {  
  
  
          //super code  
  
  
      }  
  
  
  }  
  
  
   
  
  
  //No closing tag

这会更好.

7. 在某地方收集所有输入, 一次输出给浏览器

这称为输出缓冲, 假如说你已在不同的函数输出内容:

    
 
 
     
  
  function print_header()  
     
  
  {  
     
  
      echo "Site Log and Login links

}

function print_footer()

{

echo "Site was made by me

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

//Attempt to connect to database
$c = mysqli_connect($this->host , $this->username, $this->password);
//Check connection validity
if (!$c)
{
die ("Could not connect to the database host: ". mysqli_connect_error());
}
//Set the character set of the connection
if(!mysqli_set_charset ( $c , 'UTF8' ))
{
die('mysqli_set_charset() failed');
}

$images = array(
'myself.png' , 'friends.png' , 'colleagues.png'
);
$js_code = '';
foreach($images as $image)
{
$js_code .= "'$image' ,";
}
$js_code = 'var images = [' . $js_code . ']; ';
echo $js_code;
//Output is var images = ['myself.png' ,'friends.png' ,'colleagues.png' ,];

$images = array(
'myself.png' , 'friends.png' , 'colleagues.png'
);
$js_code = 'var images = ' . json_encode($images);
echo $js_code;
//Output is : var images = ["myself.png","friends.png","colleagues.png"]

$contents = "All the content";
$dir = '/var/www/project';
$file_path = $dir . "/content.txt";
if(is_writable($dir))
{
file_put_contents($file_path , $contents);
}
else
{
die("Directory $dir is not writable, or does not exist. Please check");
}

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

//Delay for some time
function delay()
{
$sync_delay = get_option('sync_delay');
echo "Delaying for $sync_delay seconds...";
sleep($sync_delay);
echo "Done ";
}

//Delay for some time
function delay()
{
static $sync_delay = null;
if($sync_delay == null)
{
$sync_delay = get_option('sync_delay');
}
echo "Delaying for $sync_delay seconds...";
sleep($sync_delay);
echo "Done ";
}

define('APP_ID' , 'abc_corp_ecommerce');
//Function to get a session variable
function session_get($key)
{
$k = APP_ID . '.' . $key;
if(isset($_SESSION[$k]))
{
return $_SESSION[$k];
}
return false;
}
//Function set the session variable
function session_set($key , $value)
{
$k = APP_ID . '.' . $key;
$_SESSION[$k] = $value;
return true;
}

function utility_a()
{
//This function does a utility thing like string processing
}
function utility_b()
{
//This function does nother utility thing like database processing
}
function utility_c()
{
//This function is ...
}

class Utility
{
public static function utility_a()
{
}
public static function utility_b()
{
}
public static function utility_c()
{
}
}
//and call them as
$a = Utility::utility_a();
$b = Utility::utility_b();

$db_records_in_array_format; //This is a big array holding 1000 rows from a table each having 20 columns , every row is atleast 100 bytes , so total 1000 * 20 * 100 = 2MB
$cc = $db_records_in_array_format; //2MB more
some_function($cc); //Another 2MB ?

class A
{
function first()
{
$this->a = get_large_array();
$this->pass_to_function();
}
function pass_to_function()
{
//process $this->a
}
}

function add_to_cart()
{
$db = new Database();
$db->query("INSERT INTO cart .....");
}
function empty_cart()
{
$db = new Database();
$db->query("DELETE FROM cart .....");
}

$query = "INSERT INTO users(name , email , address , phone) VALUES('$name' , '$email' , '$address' , '$phone')";
$db->query($query); //call to mysqli_query()

function insert_record($table_name , $data)
{
foreach($data as $key => $value)
{
//mysqli_real_escape_string
$data[$key] = $db->mres($value);
}
$fields = implode(',' , array_keys($data));
$values = "'" . implode("','" , array_values($data)) . "'";
//Final query
$query = "INSERT INTO {$table}($fields) VALUES($values)";
return $db->query($query);
}
$data = array('name' => $name , 'email' => $email , 'address' => $address , 'phone' => $phone);
insert_record('users' , $data);

$ php -a
Interactive shell
php > echo strtotime("0000-00-00 00:00:00");
-62170005200
php > echo strtotime('1000-01-30');
-30607739600
php > echo strtotime('2100-01-30');
4104930600