php代碼編寫規範在php實際項目開發中是十分重要的,畢竟php代碼的規範可以省去很多不必要的bug檢查,下面的這篇文章我給大家分享了五十個PHP代碼編寫規範的技巧。
1,使用絕對路徑,方便代碼的遷移:
define('ROOT' , pathinfo(__FILE__, PATHINFO_DIRNAME)); require_once(ROOT . '../../lib/some_class.php'); * PATHINFO_DIRNAME 只返回 dirname * PATHINFO_BASENAME 只返回 basename * PATHINFO_EXTENSION 只返回 extension
2,不要直接使用 require, include, includeonce, requiredonce
$path = ROOT . '/lib/' . $class_name . '.php');require_once( $path );* if(file_exists($path)){ require_once( $path ); }
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){//systemif (function_exists('system')) { ob_start(); // 開啟緩衝區 system($command, $return_var); $output = ob_get_contents(); ob_end_clean(); // 清空(擦除)緩衝區並關閉輸出緩衝} //passthruelse if (function_exists('passthru')) { ob_start(); passthru($command, $return_var); $output = ob_get_contents(); ob_end_clean();} //execelse if (function_exists('exec')) { exec($command, $output, $return_var); $output = implode("\n", $output);} //shell_execelse 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');
5,靈活編寫函數(判斷是否是數組來編寫邏輯)
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關閉標籤
like: <?php ......................
7, 在某地方收集所有輸入, 一次輸出給瀏覽器 <重點>
你可以儲存在函數的局部變數中, 也可以使用ob_start和ob_end_clean
8,發送正確的mime類型頭資訊, 如果輸出非html內容的話. <重點>
$xml = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>';$xml = "<response><code>0</code></response>";//Send xml dataheader("content-type: text/xml"); //注意header頭部echo $xml;
9,為mysql串連設定正確的字元編碼
mysqli_set_charset(UTF8);
10,使用 htmlentities 設定正確的編碼選項 <重點>
php5.4前, 字元的預設編碼是ISO-8859-1, 不能直接輸出如À â等.$value = htmlentities($this->value , ENT_QUOTES , CHARSET);php5.4後, 預設編碼為UTF-8, 這將解決很多問題. 但如果你的應用是多語言的, 仍要留意編碼問題.
11,不要在應用中使用gzip壓縮輸出, 讓apache處理 <重點>
使用apache的mod_gzip/mod_deflate 模組壓縮內容. 開啟就行了。用途:壓縮和解壓縮swf檔案的代碼等,PHP的zip擴充也行
12,使用json_encode輸出動態javascript內容 而不是 echo
13,寫檔案前, 檢查目錄寫入權限
linux系統is_readable($file_path)is_writable($file_path)
14,更改應用建立的檔案許可權
chmod("/somedir/somefile", 0755);
15,不要依賴submit按鈕值來檢查表單提交行為
if( $_SERVER['REQUEST_METHOD'] == 'POST' and isset($_POST['submit']) ){ //Save the things}
16,為函數內總具有相同值的變數定義成靜態變數
static $sync_delay = null;
17,不要直接使用 $_SESSION 變數
不同的應用之前加上 不同的 首碼
18,將工具函數封裝到類中(同個類維護多個版本, 而不導致衝突)
class Utility{ public static function utility_a() { } public static function utility_b() { } public static function utility_c() { }} $a = Utility::utility_a(); $b = Utility::utility_b();
19,Bunch of silly tips
>> 使用echo取代print >> 使用str_replace取代preg_replace, 除非你絕對需要 >> 不要使用 short tag >> 簡單字串用單引號取代雙引號 >> head重新導向後記得使用exit >> 不要在迴圈中調用函數 >> isset比strlen快 >> 始中如一的格式化代碼 >> 不要刪除迴圈或者if-else的括弧
20,使用array_map快速處理數組
$arr = array_map('trim' , $string);
21,使用 php filter 驗證資料 <重點> 可以嘗試
22,強制類型檢查: intval (int) (string)......
23, 如果需要,使用profiler( 最佳化PHP代碼 ) 如 xdebug
24,小心處理大數組
確保通過引用傳遞, 或儲存在類變數中:$a = get_large_array();pass_to_function(&$a); // 之後unset掉 釋放資源
25,由始至終使用單一資料庫串連
26,避免直接寫SQL, 抽象之;自己封裝函數數組,注意轉義
27,將資料庫產生的內容緩衝到靜態檔案中
28,在資料庫中儲存session
29,避免使用全域變數
>> 使用 defines/constants >> 使用函數擷取值 >> 使用類並通過$this訪問
30,在head中使用base標籤
> www.domain.com/store/home.php > www.domain.com/store/products/ipad.php 改為:// 基礎路由<base href="http://www.domain.com/store/"><a href="home.php">Home</a><a href="products/ipad.php">Ipad</a>
31,永遠不要將 error_reporting 設為 0
error_reporting(~E_WARNING & ~E_NOTICE & ~E_STRICT);
32,注意平台體繫結構
integer在32位和64位體繫結構中長度是不同的. 因此某些函數如 strtotime 的行為會不同.
33,不要過分依賴 settimelimit() <重要>
注意任何外部的執行, 如系統調用,socket操作, 資料庫操作等, 就不在set_time_limits的控制之下* 一個php指令碼通過crontab每5分鐘執行一次* sleep函數暫停時間也是不計入指令碼的執行時間的
9,使用擴充庫 <重要>
>> mPDF — 能通過html產生pdf文檔 >> PHPExcel — 讀寫excel >> PhpMailer — 輕鬆處理髮送包含附近的郵件 >> pChart — 使用php產生報表
34,使用MVC架構
35,時常看看 phpbench
可以 php基本操作的基準測試結果,一般PHP架構 多是有的,具體看文檔
36,如何正確的建立一個網站的Index頁面
學習一種更高效的方式來實現PHP編程,可以採用“index.php?page=home”模式如在CI中,可以通過 .htaccess /apache/nginx 的配置隱藏index.php
37,使用Request Global Array抓取資料
$action = isset($_REQUEST['action']) ? $_REQUEST['action'] : 0;
38,利用var_dump進行PHP代碼調試
39,PHP處理代碼邏輯,Smarty處理展現層
PHP原生內建的Smarty渲染模板,laravel架構中是 balde模板(同理)
40,的確需要使用全域數值時,建立一個Config檔案
41,如果未定義,禁止訪問! (仿造Java等編譯語言,PHP是弱類型的指令碼語言的緣故)
like define('wer',1);在其他頁面調用時會 if (!defined('wer')) die('Access Denied');
42,建立一個資料庫類 (PHP架構一般整合了,不過封裝原生的時候,可以參考)
43,一個php檔案處理輸入,一個class.php檔案處理具體功能
44,瞭解你的SQL語句,並總是對其審查(Sanitize)
45, 當你只需要一個對象時,使用單例模式 (三私一公)
46,關於PHP重新導向 方法一:header("Location:index.php");
// 方法二 會引發瀏覽器的安全機制,不允許彈窗彈出 方法二:echo"<script>window.location=\"$PHP_SELF\";</script>"; 方法三:echo"<METAHTTP-EQUIV=\"Refresh\"CONTENT=\"0;URL=index.php\">";
47,擷取訪問者瀏覽器
functionbrowse_infor(){ $browser = ""; $browserver = ""; $Browsers = array("Lynx", "MOSAIC", "AOL", "Opera", "JAVA", "MacWeb", "WebExplorer", "OmniWeb"); $Agent = $GLOBALS["HTTP_USER_AGENT"];for ($i = 0; $i <= 7; $i++) { if (strpos($Agent, $Browsers[$i])) { $browser = $Browsers[$i]; $browserver = ""; }}if (ereg("Mozilla", $Agent) && !ereg("MSIE", $Agent)) { $temp = explode("(", $Agent); $Part = $temp[0]; $temp = explode("/", $Part); $browserver = $temp[1]; $temp = explode("", $browserver); $browserver = $temp[0]; $browserver = preg_replace("/([\d\.]+)/", "\1", $browserver); $browserver = "$browserver"; $browser = "NetscapeNavigator";}if (ereg("Mozilla", $Agent) && ereg("Opera", $Agent)) { $temp = explode("(", $Agent); $Part = $temp[1]; $temp = explode(")", $Part); $browserver = $temp[1]; $temp = explode("", $browserver); $browserver = $temp[2]; $browserver = preg_replace("/([\d\.]+)/", "\1", $browserver); $browserver = "$browserver"; $browser = "Opera";}if (ereg("Mozilla", $Agent) && ereg("MSIE", $Agent)) { $temp = explode("(", $Agent); $Part = $temp[1]; $temp = explode(";", $Part); $Part = $temp[1]; $temp = explode("", $Part); $browserver = $temp[2]; $browserver = preg_replace("/([\d\.]+)/", "\1", $browserver); $browserver = "$browserver"; $browser = "InternetExplorer";}if ($browser != "") { $browseinfo = "$browser$browserver";} else { $browseinfo = "Unknown";}return $browseinfo;}//調用方法$browser=browseinfo();直接返回結果
48.擷取訪問者作業系統
<?php functionosinfo(){ $os = ""; $Agent = $GLOBALS["HTTP_USER_AGENT"]; if (eregi('win', $Agent) && strpos($Agent, '95')) { $os = "Windows95"; } elseif (eregi('win9x', $Agent) && strpos($Agent, '4.90')) { $os = "WindowsME"; } elseif (eregi('win', $Agent) && ereg('98', $Agent)) { $os = "Windows98"; } elseif (eregi('win', $Agent) && eregi('nt5\.0', $Agent)) { $os = "Windows2000"; } elseif (eregi('win', $Agent) && eregi('nt', $Agent)) { $os = "WindowsNT"; } elseif (eregi('win', $Agent) && eregi('nt5\.1', $Agent)) { $os = "WindowsXP"; } elseif (eregi('win', $Agent) && ereg('32', $Agent)) { $os = "Windows32"; } elseif (eregi('linux', $Agent)) { $os = "Linux"; } elseif (eregi('unix', $Agent)) { $os = "Unix"; } elseif (eregi('sun', $Agent) && eregi('os', $Agent)) { $os = "SunOS"; } elseif (eregi('ibm', $Agent) && eregi('os', $Agent)) { $os = "IBMOS/2"; } elseif (eregi('Mac', $Agent) && eregi('PC', $Agent)) { $os = "Macintosh"; } elseif (eregi('PowerPC', $Agent)) { $os = "PowerPC"; } elseif (eregi('AIX', $Agent)) { $os = "AIX"; } elseif (eregi('HPUX', $Agent)) { $os = "HPUX"; } elseif (eregi('NetBSD', $Agent)) { $os = "NetBSD"; } elseif (eregi('BSD', $Agent)) { $os = "BSD"; } elseif (ereg('OSF1', $Agent)) { $os = "OSF1"; } elseif (ereg('IRIX', $Agent)) { $os = "IRIX"; } elseif (eregi('FreeBSD', $Agent)) { $os = "FreeBSD"; } if ($os == '') $os = "Unknown"; return $os; } //調用方法$os=os_infor();
49,檔案格式類
$mime_types=array( 'gif'=>'image/gif', 'jpg'=>'image/jpeg', 'jpeg'=>'image/jpeg', 'jpe'=>'image/jpeg', 'bmp'=>'image/bmp', 'png'=>'image/png', 'tif'=>'image/tiff', 'tiff'=>'image/tiff', 'pict'=>'image/x-pict', 'pic'=>'image/x-pict', 'pct'=>'image/x-pict', 'tif'=>'image/tiff', 'tiff'=>'image/tiff', 'psd'=>'image/x-photoshop', 'swf'=>'application/x-shockwave-flash', 'js'=>'application/x-javascript', 'pdf'=>'application/pdf', 'ps'=>'application/postscript', 'eps'=>'application/postscript', 'ai'=>'application/postscript', 'wmf'=>'application/x-msmetafile', 'css'=>'text/css', 'htm'=>'text/html', 'html'=>'text/html', 'txt'=>'text/plain', 'xml'=>'text/xml', 'wml'=>'text/wml', 'wbmp'=>'image/vnd.wap.wbmp', 'mid'=>'audio/midi', 'wav'=>'audio/wav', 'mp3'=>'audio/mpeg', 'mp2'=>'audio/mpeg', 'avi'=>'video/x-msvideo', 'mpeg'=>'video/mpeg', 'mpg'=>'video/mpeg', 'qt'=>'video/quicktime', 'mov'=>'video/quicktime', 'lha'=>'application/x-lha', 'lzh'=>'application/x-lha', 'z'=>'application/x-compress', 'gtar'=>'application/x-gtar', 'gz'=>'application/x-gzip', 'gzip'=>'application/x-gzip', 'tgz'=>'application/x-gzip', 'tar'=>'application/x-tar', 'bz2'=>'application/bzip2', 'zip'=>'application/zip', 'arj'=>'application/x-arj', 'rar'=>'application/x-rar-compressed', 'hqx'=>'application/mac-binhex40', 'sit'=>'application/x-stuffit', 'bin'=>'application/x-macbinary', 'uu'=>'text/x-uuencode', 'uue'=>'text/x-uuencode', 'latex'=>'application/x-latex', 'ltx'=>'application/x-latex', 'tcl'=>'application/x-tcl', 'pgp'=>'application/pgp', 'asc'=>'application/pgp', 'exe'=>'application/x-msdownload', 'doc'=>'application/msword', 'rtf'=>'application/rtf', 'xls'=>'application/vnd.ms-excel', 'ppt'=>'application/vnd.ms-powerpoint', 'mdb'=>'application/x-msaccess', 'wri'=>'application/x-mswrite', );
50.php產生excel文檔
<?php header("Content-type:application/vnd.ms-excel"); header("Content-Disposition:filename=test.xls"); echo"test1\t"; echo"test2\t\n"; echo"test1\t"; echo"test2\t\n"; echo"test1\t"; echo"test2\t\n"; echo"test1\t"; echo"test2\t\n"; echo"test1\t"; echo"test2\t\n"; echo"test1\t"; echo"test2\t\n"; ?> //改動相應檔案頭就可以輸出.doc.xls等檔案格式了