1.不要實用相對路徑
常常會看到:
1 require_once('../../lib/some_class.php');
該方法有很多缺點:它首先查找指定的php包含路徑,然后查找當前目錄,因此會檢查過多路徑。如果該腳本被另一目錄的腳本包含,它的基本目錄變成了另一腳本所在的目錄。
另一問題,當定時任務運行該腳本,它的上級目錄可能就不是工作目錄了。因此最佳選擇是使用絕對路徑:
1 define('ROOT', '/var/www/project/'); 2 require_once(ROOT . '../../lib/some_class.php');
我們定義了一個絕對路徑,值被寫死了。我們還可以改進它,路徑 /var/www/project 也可能會改變,那么我們每次都要改變它嗎?不是的,我們可以使用__FILE__常量,如:
1 //suppose your script is /var/www/project/index.php 2 //Then __FILE__ will always have that full path. 3 define('ROOT', pathinfo(__FILE__, PATHINFO_DIRNAME)); 4 require_once(ROOT . '../../lib/some_class.php');
現在,無論你移到哪個目錄,如移到一個外網的服務器上,代碼無須更改便可正確運行。
2. 不要直接使用require, include
可以在腳本頭部引入多個文件、像類庫、工具文件和助手函數等,如:
1 require_once('lib/Database.php'); 2 require_once('lib/Mail.php'); 3 require_once('helpers/utitlity_functions.php');
這種用法相當原始,應該更靈活一點,應編寫一個助手函數包含文件. 例如:
1 function load_class($class_name) { 2 //path to the class file 3 $path = ROOT . 'lib' . $class_name . '.php'; 4 require_once($path); 5 } 6 load_class('Database'); 7 load_class('Mail');
有什么不一樣嗎? 該代碼更具可讀性,將來你可以按需擴展該函數,如:
1 function load_class($class_name) { 2 //path to the class file 3 $path = ROOT . 'lib' . $class_name . '.php'; 4 if(file_exists($path)) { 5 require_once($path); 6 } 7 }
還可做得更多:為同樣文件查找多個目錄。能很容易的改變放置類文件的目錄,無須在代碼各處一一修改。可使用類似的函數加載文件,如html內容。
3. 為應用保留調試代碼
在開發環境中,我們打印數據庫查詢語句,轉存有問題的變量值,而一旦問題解決,我們注釋或刪除它們。然而,更好的做法是保留調試代碼。在開發環境中,你可以:
1 define('ENVIRONMENT', 'development'); 2 if(! $db->query($query)) { 3 if(ENVIRONMENT === 'development') { 4 echo $query, ' failed'; 5 } 6 }else { 7 echo 'Database error. Please contact administrator'; 8 }
在服務器中,你可以:
1 define('ENVIRONMENT', 'production'); 2 if(! $db->query($query)) { 3 if(ENVIRONMENT === 'development') { 4 echo $query, ' failed'; 5 } 6 }else { 7 echo 'Database error. Please contact administrator'; 8 }
4. 使用可跨平台的函數執行命令
system, exec, passthru, shell_exec 這4個函數可用於執行系統命令。每個的行為都有細微差別,問題在於,當在共享主機中,某些函數可能被選擇性的禁用。大多數新手趨於每次首先檢查哪個函數可用,然而再使用它。更好的方案是封成函數一個可跨平台的函數
1 /** 2 Method to execute a command in the terminal 3 Uses : 4 1. system 5 2. passthru 6 3. exec 7 4. shell_exec 8 9 use : terminal('ls'); 10 */ 11 function terminal($command){ 12 //system 13 if(function_exists('system')){ 14 ob_start(); 15 system($command, $return_var); 16 $output = ob_get_contents(); 17 ob_end_clean(); 18 } 19 //passthru 20 else if(function_exists('passthru')){ 21 ob_start(); 22 passthru($command, $return_var); 23 $output = ob_get_contents(); 24 ob_end_clean(); 25 } 26 //exec 27 else if(function_exists('exec')){ 28 exec($command, $output, $return_var); 29 $output = implode("\n", $output); 30 } 31 //shell_exec 32 else if(function_exists('shell_exec')){ 33 $output = shell_exec($command); 34 } 35 else{ 36 $output = 'Command exection not possible on this system'; 37 $return_var = 1; 38 } 39 40 return array('output' => $output, 'status' => $return_var); 41 }
上面的函數將運行shell命令,只要有一個系統函數可用,這保持了代碼的一致性。
5. 靈活編寫函數
1 function add_to_cart($item_id, $qty) { 2 $_SESSION['cart'][$item_id] = $qty; 3 } 4 add_to_cart('IPHOME3', 2);
使用上面的函數添加單個項目。而當添加項列表的時候,你要創建另一個函數嗎?不用,只要稍加留意不同類型的參數,就會更靈活,如:
1 function add_to_cart($item_id, $qty) { 2 if(!is_array($item_id)) { 3 $_SESSION['cart'][$item_id] = $qty; 4 } 5 else { 6 foreach ($item_id as $i_id => $qty) { 7 $_SESSION['cart'][$i_id] = $qty; 8 } 9 } 10 } 11 add_to_cart('IPHOME3', 2); 12 add_to_cart(array('IPHOME3'=>2, 'IPAD'=>5));
現在,同個函數可以處理不同類型的輸入參數了。可以參照上面的例子重構你的多處代碼,使其更智能。
6. 有意忽略php關閉標簽
1 <?php 2 echo 'Hello'; 3 //Now dont close this tag
這將節約你很多時間,我們舉個例子:
//一個 super_class.php 文件
1 <?php 2 class super_class { 3 function super_function() { 4 //pass 5 } 6 } 7 ?>
//super extra character after the closing tag
1 index.php 2 3 require_once('super_class.php'); 4 //echo an image or pdf, or set the cookies or session data
這樣,你將會得到一個 Headers already send error。為什么?因為 “super extra character” 已經被輸出了。現在你得開始調試啦。這會花費大量時間尋找 super extra 的位置。因此,養成省略關閉符的習慣:
1 <?php 2 class super_class { 3 function super_function() { 4 //pass 5 } 6 } 7 //No closing tag
這回更好.
7. 在某些地方手機所有輸入,一次輸出給瀏覽器
這稱為輸出緩沖,假如說你已在不同的函數輸出內容:
1 function print_header() { 2 echo '<div id="header">Site Log and Login links</div>'; 3 } 4 function print_footer() { 5 echo '<div id="footer">Site was made by me</div>'; 6 } 7 print_header(); 8 for($i = 0; $i < 100; $i++) { 9 echo 'I is : ' , $i ; 10 } 11 print_footer();
替代方案,在某地方集中收集輸出。你可以存儲在函數的局部變量中,也可以使用ob_start和ob_end_clean。如下:
為什么需要輸出緩沖:
>>可以在發送給瀏覽器前更改輸出, 如 str_replaces 函數或可能是 preg_replaces 或添加些監控/調試的html內容。
>>輸出給瀏覽器的同時又做php的處理很糟糕。你應該看到過有些站點的側邊欄或中間出現錯誤信息. 知道為什么會發生嗎?因為處理和輸出混合了。
8. 發送正確的mime類型頭信息
輸出一些xml
1 $xml = '<?xml version="1.0" encoding="utf-8" standalone="yes">'; 2 $xml .= ' 3 <response> 4 <code>0</code> 5 </response>'; 6 //Send xml data 7 echo $xml;
工作得不錯,但需要一些改進。
1 $xml = '<?xml version="1.0" encoding="utf-8" standalone="yes">'; 2 $xml .= ' 3 <response> 4 <code>0</code> 5 </response>'; 6 //Send xml data 7 header("content-type: text/xml"); 8 echo $xml;
注意header行,該行告知瀏覽器發送的是xml類型的內容,所以瀏覽器能正確的處理。很多的javascript庫也依賴頭信息。
類似的有 javascript , css, jpg image, png image:
1 //JavaScript 2 header("content-type: application/x-javascript"); 3 echo "var a = 10;"; 4 //CSS 5 header("content-type: text/css"); 6 echo "#div id { background: #000; }"
9. 為mysql連接設置正確的字符編碼
曾經遇到過在mysql表中設置了unicode/utf-8編碼,phpadmin也能正確顯示。但當你獲取內容並在頁面輸出的時候,會出現亂碼,這里的問題出在mysql連接的字符編碼。
1 //Attempt to connect to database 2 $c = mysqli_connect($this->host, $this->username, $this->password); 3 //Check connection validity 4 if(!$c) { 5 die("Could not connect to the database host: " . mysqli_connect_error()); 6 } 7 if(!mysqli_set_charset($c, 'UTF-8')) { 8 die('mysqli_set_charset() failed'); 9 }
一旦連接數據庫,最好設置連接的 characterset。你的應用如果要支持多語言,這么做是必須的。
10. 使用htmlentites 設置正確的編碼選項
php5.4前,字符的默認編碼是ISO-8859-1,不能直接輸出如À â等。
1 $value = htmlentities($this->value, ENT_QUOTES, CHARSET);
php5.4以后,默認編碼為UTF-8,這將解決很多問題。但如果你的應用是多語言的,仍然要留意編碼問題。
11. 不要在應用中使用gzip壓縮輸出
考慮過使用 ob_gzhandler 嗎?不要那樣做,毫無意義。php只應用來編寫應用,不應操心服務器和瀏覽器的數據傳輸優化問題。
使用apache的mod_gzip/mod_deflate 模塊壓縮內容。
12寫文件前,檢查目錄權限
在寫文件或保存文件前,確保目錄是可寫的,假如不可寫,則輸出錯誤信息,這會節約你很多調試時間。linux系統中,需要處理權限,目錄權限不當會導致很多很多的問題,文件也有可能無法讀取等等。
確保你的應用足夠智能,輸出某些重要信息。
1 $contents = "All the content"; 2 $file_path = "/var/www/project/content.txt"; 3 file_put_contents($file_path, $contents);
這大體上正確,但有些間接的問題,file_put_contents 可能會由於幾個原因失敗:
>>父目錄不存在
>>目錄存在,但不可寫
>>文件被寫鎖住?
所以寫文件前做明確的檢查更好。
1 $contents = "All the content"; 2 $dir = "/var/www/project/"; 3 $file_path = $dir . "content.txt" 4 if(is_writable($dir)) { 5 file_put_contents($file_path, $contents); 6 }else { 7 die("Directory $dir is not writable, or does not exist. Please check"); 8 }
這么做后,你會得到一個文件在何處寫及為什么失敗的明確信息
13. 更改應用創建的文件權限
在linux環境中,權限問題可能會浪費你很多時間。從今往后,無論何時,當你創建一些文件后,確保使用chmod設置正確權限。否則的話,可能文件先是由”php”用戶創建,但你用其它的用戶登錄工作,系統將會拒絕訪問或打開文件,你不得不奮力獲取root權限,更改文件的權限等等。
1 //Read and write for owner, read for everybody else 2 chmod('somedir/somefile', 0644); 3 //Everything for owner, read and exceute for others 4 chmod('somedir/somefile', 0755);
14. 不要依賴submit按鈕值
新媒體排版是一個在線圖文編輯工具,大量節省您排版的時間,讓工作更輕松高效。
1 if($_POST['submit'] === 'Save') { 2 //pass 3 }
上面大多數情況正確,除了應用是多語言的, ‘Save’ 可能代表其它含義,你怎么區分它們呢。因此,不要依賴於submit按鈕的值。
1 if($_SERVER['REQUEST_METHOD'] === 'POST' AND isset($_POST['submit'])) { 2 //pass 3 }
現在你從submit按鈕值中解脫出來了。
15. 不要直接使用$_SESSION 變量
1 $_SESSION['username'] = $username; 2 $username = $_SESSION['username'];
這會導致某些問題。如果在同個域名中運行了多個應用,session 變量可能會沖突。兩個不同的應用可能使用同一個session key。例如,一個前端門戶和一個后台管理系統使用同一域名。從現在開始,使用應用相關的key和一個包裝函數:
1 define('APP_ID', 'abc_corp_ecommerce'); 2 //Function to get a session variable 3 function session_get($key) { 4 $k = APP_ID . '.' . $key; 5 if(isset($_SESSION[$k])){ 6 return $_SESSION[$k]; 7 } 8 return false; 9 } 10 //Function set the session variable 11 function session_set($key, $value) { 12 $k = APP_ID . '.' . $key; 13 $_SESSION[$k] = $value; 14 return true; 15 }
16. 將工具函數封裝到類中
加入你在某文件中定義了很多工具函數
1 function utility_a() { 2 //pass 3 } 4 function utility_b() { 5 //pass 6 } 7 function utility_c() { 8 //pass 9 }
這些函數的使用分散到應用各處. 你可能想將他們封裝到某個類中:
1 class Utility { 2 public static function utility_a() { 3 //pass 4 } 5 public static function utility_b() { 6 //pass 7 } 8 public static function utility_c() { 9 //pass 10 } 11 } 12 //and call them as 13 $a = Utility::utility_a(); 14 $b = Utility::utility_b();
顯而易見的好處是,如果php內建有同名的函數,這樣可以避免沖突。
另一種看法是,你可以在同個應用中為同個類維護多個版本,而不導致沖突,這是封裝的基本好處。
17 Bunch of silly tips
>>使用echo取代print
>>使用str_replace取代preg_replace,除非你絕對需要
>>不要使用 short tag
>>簡單字符串用單引號取代雙引號
>>head重定向后記得使用exit
>>不要在循環中調用函數
>>isset比strlen快
>>始中如一的格式化代碼
>>不要刪除循環或者if-else的括號
不要這樣寫代碼:
<span style="color:#333333; font-family:'Helvetica, arial, sans-serif'"><?php if($a == true) $a_count++;?></span>
這絕對WASTE。寫成:
1 <span style="color:#333333; font-family:'Helvetica, arial, sans-serif'"> 2 <?php if($a == true) {$a_count++;}?> 3 </span>
不要嘗試省略一些語法來縮短代碼,而是讓你的邏輯簡短。
>>使用有高亮語法顯示的文本編輯器,高亮語法能讓你減少錯誤。
18. 使用array_map快速處理數組
比如說你想 trim 數組中的所有元素. 新手可能會:
1 foreach ($arr as $key => $value) { 2 $arr[$key] = trim($value); 3 }
但使用 array_map 更簡單:
1 $arr = array_map('trim', $arr);
這會為$arr數組的每個元素都申請調用trim。另一個類似的函數是 array_walk. 請查閱文檔學習更多技巧。