1.不要使用相對路徑
經常會看到:javascript
require_once('../../lib/some_class.php');
該方法有不少缺點:php
它首先查找指定的php包含路徑, 而後查找當前目錄.css
所以會檢查過多路徑.html
若是該腳本被另外一目錄的腳本包含, 它的基本目錄變成了另外一腳本所在的目錄.前端
另外一問題, 當定時任務運行該腳本, 它的上級目錄可能就不是工做目錄了.java
所以最佳選擇是使用絕對路徑:python
define('ROOT' , '/var/www/project/'); require_once(ROOT . '../../lib/some_class.php'); //rest of the code
咱們定義了一個絕對路徑, 值被寫死了. 咱們還能夠改進它. 路徑 /var/www/project 也可能會改變, 那麼咱們每次都要改變它嗎? 不是的, 咱們可使用__FILE__常量, 如:mysql
//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
如今, 不管你移到哪一個目錄, 如移到一個外網的服務器上, 代碼無須更改即可正確運行.linux
2. 不要直接使用 require, include, include_once, required_once
能夠在腳本頭部引入多個文件, 像類庫, 工具文件和助手函數等, 如:web
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建議的博客文章都沒提到這點.
<?php
echo "Hello"; //Now dont close this tag
這將節約你不少時間. 咱們舉個例子:一個 super_class.php 文件
//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 的位置.所以, 養成省略關閉符的習慣:
<!--?php
class super_class
{
function super_function()
{
//super code
}
}
//No closing tag</pre-->
這會更好.
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 '; } 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 '; } 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; }
18. 將工具函數封裝到類中
假如你在某文件中定義了不少工具函數:
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();
顯而易見的好處是, 若是php內建有同名的函數, 這樣能夠避免衝突.另外一種見解是, 你能夠在同個應用中爲同個類維護多個版本, 而不致使衝突. 這是封裝的基本好處, 無它.
19. Bunch of silly tips
>>使用echo取代print
>>使用str_replace取代preg_replace, 除非你絕對須要
>>不要使用 short tag
>>簡單字符串用單引號取代雙引號
>>head重定向後記得使用exit
>>不要在循環中調用函數
>>isset比strlen快
>>始中如一的格式化代碼
>>不要刪除循環或者if-else的括號
不要這樣寫代碼:
if($a == true) $a_count++;
這絕對WASTE.寫成:
if($a == true) { $a_count++; }
不要嘗試省略一些語法來縮短代碼. 而是讓你的邏輯簡短.>>使用有高亮語法顯示的文本編輯器. 高亮語法能讓你減小錯誤.
20. 使用array_map快速處理數組
好比說你想 trim 數組中的全部元素. 新手可能會:
foreach($arr as $c => $v) { $arr[$c] = trim($v); }
但使用 array_map 更簡單:
$arr = array_map('trim' , $arr);
這會爲$arr數組的每一個元素都申請調用trim. 另外一個相似的函數是 array_walk. 請查閱文檔學習更多技巧.
21. 使用 php filter 驗證數據
你確定曾使用過正則表達式驗證 email , ip地址等. 是的,每一個人都這麼使用. 如今, 咱們想作不一樣的嘗試, 稱爲filter.php的filter擴展提供了簡單的方式驗證和檢查輸入.
22. 強制類型檢查
$amount = intval( $_GET['amount'] ); $rate = (int) $_GET['rate'];
這是個好習慣.
23. 若是須要,使用profiler如xdebug
若是你使用php開發大型的應用, php承擔了不少運算量, 速度會是一個很重要的指標. 使用profile幫助優化代碼. 可以使用xdebug和webgrid.
24. 當心處理大數組
對於大的數組和字符串, 必須當心處理. 常見錯誤是發生數組拷貝致使內存溢出,拋出Fatal Error of Memory size 信息:
$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 ?
當導入或導出csv文件時, 經常會這麼作.
不要認爲上面的代碼會常常因內存限制致使腳本崩潰. 對於小的變量是沒問題的, 但處理大數組的時候就必須避免.
確保經過引用傳遞, 或存儲在類變量中:
$a = get_large_array();
pass_to_function(&$a);
這麼作後, 向函數傳遞變量引用(而不是拷貝數組). 查看文檔.
class A { function first() { $this->a = get_large_array(); $this->pass_to_function(); } function pass_to_function() { %
如需轉載請註明： 轉載自26點的博客
本文連接地址: 提升PHP開發質量的36個方法