提高 PHP 代碼品質的 36 計（上）

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個函數可用於執行系統命令. 每個的行為都有細微差別. 問題在於, 當在共用主機中, 某些函數可能被選擇性的禁用. 大多數新手趨於每次首先檢查哪個函數可用, 然而再使用它.

更好的方案是封成函數一個可跨平台的函數.

/**

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

?

1

2

3

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";

}

print_header();

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

{

echo "I is : $i
';

}

print_footer();

替代方案, 在某地方集中收集輸出. 你可以儲存在函數的局部變數中, 也可以使用ob_start和ob_end_clean. 如下:

function print_header()

{

$o = "Site Log and Login links";

return $o;

}

function print_footer()

{

$o = "Site was made by me";

return $o;

}

echo print_header();

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

{

echo "I is : $i
';

}

echo print_footer();

為什麼需要輸出緩衝:

>>可以在發送給瀏覽器前更改輸出. 如 str_replaces 函數或可能是 preg_replaces 或添加些監控/調試的html內容.

>>輸出給瀏覽器的同時又做php的處理很糟糕. 你應該看到過有些網站的側邊欄或中間出現錯誤資訊. 知道為什麼會發生嗎? 因為處理和輸出混合了.

8. 發送正確的mime類型頭資訊, 如果輸出非html內容的話.

輸出一些xml.

$xml = '';

$xml = "

0

";

//Send xml data

echo $xml;

工作得不錯. 但需要一些改進.

$xml = '';

$xml = "

0

";

//Send xml data

header("content-type: text/xml");

echo $xml;

注意header行. 該行告知瀏覽器發送的是xml類型的內容. 所以瀏覽器能正確的處理. 很多的javascript庫也依賴頭資訊.

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

JavaScript

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

echo "var a = 10";

CSS

header("content-type: text/css");

echo "#div id { background:#000; }";

9. 為mysql串連設定正確的字元編碼

曾經遇到過在mysql表中設定了unicode/utf-8編碼, phpadmin也能正確顯示, 但當你擷取內容並在頁面輸出的時候,會出現亂碼. 這裡的問題出在mysql串連的字元編碼.

//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');

}

一旦串連資料庫, 最好設定串連的 characterset. 你的應用如果要支援多語言, 這麼做是必須的.

10. 使用 htmlentities 設定正確的編碼選項

php5.4前, 字元的預設編碼是ISO-8859-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內容:

$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' ,];

更聰明的做法, 使用 json_encode:

$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"]

優雅乎?

13. 寫檔案前, 檢查目錄寫入權限

寫或儲存檔案前, 確保目錄是可寫的, 假如不可寫, 輸出錯誤資訊. 這會節約你很多調試時間. linux系統中, 需要處理許可權, 目錄許可權不當會導致很多很多的問題, 檔案也有可能無法讀取等等.

確保你的應用足夠智能, 輸出某些重要訊息.

$contents = "All the content";

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

file_put_contents($file_path , $contents);

這大體上正確. 但有些間接的問題. file_put_contents 可能會由於幾個原因失敗:

>>父目錄不存在

>>目錄存在, 但不可寫

>>檔案被寫鎖住?

所以寫檔案前做明確的檢查更好.

$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");

}

這麼做後, 你會得到一個檔案在何處寫及為什麼失敗的明確資訊.

14. 更改應用建立的檔案許可權

在linux環境中, 許可權問題可能會浪費你很多時間. 從今往後, 無論何時, 當你建立一些檔案後, 確保使用chmod設定正確許可權. 否則的話, 可能檔案先是由"php"使用者建立, 但你用其它的使用者登入工作, 系統將會拒絕訪問或開啟檔案, 你不得不奮力擷取root許可權, 變更檔的許可權等等.

// 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);

15. 不要依賴submit按鈕值來檢查表單提交行為

if($_POST['submit'] == 'Save')

{

//Save the things

}

上面大多數情況正確, 除了應用是多語言的. 'Save' 可能代表其它含義. 你怎麼區分它們呢. 因此, 不要依賴於submit按鈕的值.

if( $_SERVER['REQUEST_METHOD'] == 'POST' and isset($_POST['submit']) )

{

//Save the things

}

現在你從submit按鈕值中解脫出來了.

16. 為函數內總具有相同值的變數定義成靜態變數

//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
";

}

17. 不要直接使用 $_SESSION 變數

某些簡單例子:

$_SESSION['username'] = $username;

$username = $_SESSION['username'];

這會導致某些問題. 如果在同個網域名稱中運行了多個應用, session 變數可能會衝突. 兩個不同的應用可能使用同一個session key. 例如, 一個前端門戶, 和一個後台管理系統使用同一網域名稱.

從現在開始, 使用應用相關的key和一個封裝函數:

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;

}

