本文來自 Binarytides 博主 Silver Moon 的整理分享。
1.不要使用相對路徑
常常會看到:
1 | require_once('../../lib/some_class.php'); |
該方法有很多缺點:
它首先查找指定的php包含路徑, 然後查找當前目錄.
因此會檢查過多路徑.
如果該腳本被另一目錄的腳本包含, 它的基本目錄變成了另一腳本所在的目錄.
另一問題, 當定時任務運行該腳本, 它的上級目錄可能就不是工作目錄了.
因此最佳選擇是使用絕對路徑:
1 2 3 4 | view sourceprint? define('ROOT' , '/var/www/project/'); require_once(ROOT . '../../lib/some_class.php'); //rest of the code |
我們定義了一個絕對路徑, 值被寫死了. 我們還可以改進它. 路徑 /var/www/project 也可能會改變, 那麼我們每次都要改變它嗎? 不是的, 我們可以使用__FILE__常量, 如:
1 2 3 4 5 | //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
可以在腳本頭部引入多個文件, 像類庫, 工具文件和助手函數等, 如:
1 2 3 | require_once('lib/Database.php'); require_once('lib/Mail.php'); require_once('helpers/utitlity_functions.php'); |
這種用法相當原始. 應該更靈活點. 應編寫個助手函數包含文件. 例如:
1 2 3 4 5 6 7 8 | 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'); |
有什麼不一樣嗎? 該代碼更具可讀性.
?⒗茨憧梢園蔥櫪┱垢煤?? 如:
1 2 3 4 5 6 7 8 9 | 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. 為應用保留調試代碼
在開發環境中, 我們列印資料庫查詢語句, 轉存有問題的變數值, 而一旦問題解決, 我們註釋或刪除它們. 然而更好的做法是保留調試代碼.
在開發環境中, 你可以:
1 2 3 4 5 6 7 8 9 10 11 12 | define('ENVIRONMENT' , 'development'); if(! $db->query( $query ) { if(ENVIRONMENT == 'development') { echo "$query failed"; } else { echo "Database error. Please contact administrator"; } } |
在伺服器中, 你可以:
1 2 3 4 5 6 7 8 9 10 11 12 | 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個函數可用於執行系統命令. 每個的行為都有細微差別. 問題在於, 當在共享主機中, 某些函數可能被選擇性的禁用. 大多數新手趨於每次首先檢查哪個函數可用, 然而再使用它.
更好的方案是封成函數一個可跨平台的函數.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | /** 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'); |
上面的函數?⒃誦?hell命令, 只要有一個系統函數可用, 這保持了代碼的一致性.
5. 靈活編寫函數
function add_to_cart($item_id , $qty)
1 2 3 4 | { $_SESSION['cart']['item_id'] = $qty; } add_to_cart( 'IPHONE3' , 2 ); |
使用上面的函數添加單個項目. 而當添加項列表的時候,你要創建另一個函數嗎? 不用, 只要稍加留意不同類型的參數, 就會更靈活. 如:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | 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建議的博客文章都沒提到這點.
1 2 3 | <?php echo "Hello"; //Now dont close this tag |
這?⒔讜寄愫芏嗍奔? 我們舉個例子:
一個 super_class.php 文件
1 2 3 4 5 6 7 8 9 10 | <?php class super_class { function super_function() { //super code } } ?> //super extra character after the closing tag |
index.php
1 2 | 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 的位置.
因此, 養成省略關閉符的習慣:
1 2 3 4 5 6 7 8 9 | <?php class super_class { function super_function() { //super code } } //No closing tag |
這會更好.
7. 在某地方收集所有輸入, 一次輸出給瀏覽器
這稱為輸出緩衝, 假如說你已在不同的函數輸出內容:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | function print_header() { echo "<div id='header'>Site Log and Login links</div>"; } function print_footer() { echo "<div id='footer'>Site was made by me</div>"; } print_header(); for($i = 0 ; $i < 100; $i++) { echo "I is : $i '; } print_footer(); |
替代方案, 在某地方集中收集輸出. 你可以存儲在函數的局部變數中, 也可以使用ob_start和ob_end_clean. 如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | function print_header() { $o = "<div id='header'>Site Log and Login links</div>"; return $o; } function print_footer() { $o = "<div id='footer'>Site was made by me</div>"; 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.
1 2 3 4 5 6 | $xml = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>'; $xml = "<response> <code>0</code> </response>"; //Send xml data echo $xml; |
工作得不錯. 但需要一些改進.
1 2 3 4 5 6 7 | $xml = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>'; $xml = "<response> <code>0</code> </response>"; //Send xml data header("content-type: text/xml"); echo $xml; |
注意header行. 該行告知瀏覽器發送的是xml類型的內容. 所以瀏覽器能正確的處理. 很多的javascript庫也依賴頭信息.
類似的有 javascript , css, jpg image, png image:
1 2 3 4 5 6 | 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連接的字元編碼.
1 2 3 4 5 6 7 8 9 10 11 12 | //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, 不能直接輸出如À â等.
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內容:
1 2 3 4 5 6 7 8 9 10 11 | $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:
1 2 3 4 5 6 | $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系統中, 需要處理許可權, 目錄許可權不當會導致很多很多的問題, 文件也有可能無法讀取等等.
確保你的應用足夠智能, 輸出某些重要信息.
1 2 3 | $contents = "All the content"; $file_path = "/var/www/project/content.txt"; file_put_contents($file_path , $contents); |
這大體上正確. 但有些間接的問題. file_put_contents 可能會由於幾個原因失敗:
>>父目錄不存在
>>目錄存在, 但不可寫
>>文件被寫鎖住?
所以寫文件前做明確的檢查更好.
1 2 3 4 5 6 7 8 9 10 11 | $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"); } |
[火星人 ] 提高PHP代碼質量的36個技巧已經有700次圍觀