提高PHP程式碼質量的36計

玄學醬發表於2017-06-06
PHP

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

現在, 無論你移到哪個目錄, 如移到一個外網的伺服器上, 程式碼無須更改便可正確執行.

  1. 不要直接使用 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內容.

  1. 為應用保留除錯程式碼

在開發環境中, 我們列印資料庫查詢語句, 轉存有問題的變數值, 而一旦問題解決, 我們註釋或刪除它們. 然而更好的做法是保留除錯程式碼.

在開發環境中, 你可以:

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";
    }
}
  1. 使用可跨平臺的函式執行命令

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命令, 只要有一個系統函式可用, 這保持了程式碼的一致性.

  1. 靈活編寫函式
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) );

現在, 同個函式可以處理不同型別的輸入引數了. 可以參照上面的例子重構你的多處程式碼, 使其更智慧.

  1. 有意忽略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-->

這會更好.

  1. 在某地方收集所有輸入, 一次輸出給瀏覽器

這稱為輸出緩衝, 假如說你已在不同的函式輸出內容:

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的處理很糟糕. 你應該看到過有些站點的側邊欄或中間出現錯誤資訊. 知道為什麼會發生嗎? 因為處理和輸出混合了.
  1. 傳送正確的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; }";
  1. 為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. 你的應用如果要支援多語言, 這麼做是必須的.

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

php5.4前, 字元的預設編碼是ISO-8859-1, 不能直接輸出如À â等.

$value = htmlentities($this->value , ENT_QUOTES , CHARSET);

php5.4以後, 預設編碼為UTF-8, 這將解決很多問題. 但如果你的應用是多語言的, 仍然要留意編碼問題,.

  1. 不要在應用中使用gzip壓縮輸出, 讓apache處理

考慮過使用 ob_gzhandler 嗎? 不要那樣做. 毫無意義. php只應用來編寫應用. 不應操心伺服器和瀏覽器的資料傳輸優化問題.

使用apache的mod_gzip/mod_deflate 模組壓縮內容.

  1. 使用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"]

優雅乎?

  1. 寫檔案前, 檢查目錄寫許可權

寫或儲存檔案前, 確保目錄是可寫的, 假如不可寫, 輸出錯誤資訊. 這會節約你很多除錯時間. 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");
}

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

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

在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);
  1. 不要依賴submit按鈕值來檢查表單提交行為
if($_POST[`submit`] == `Save`)
{
    //Save the things
}

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

if( $_SERVER[`REQUEST_METHOD`] == `POST` and isset($_POST[`submit`]) )
{
    //Save the things
}

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

  1. 為函式內總具有相同值的變數定義成靜態變數
//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 ";
}
  1. 不要直接使用 $_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;
}
  1. 將工具函式封裝到類中

假如你在某檔案中定義了很多工具函式:

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內建有同名的函式, 這樣可以避免衝突.

另一種看法是, 你可以在同個應用中為同個類維護多個版本, 而不導致衝突. 這是封裝的基本好處, 無它.

  1. 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++;
}

不要嘗試省略一些語法來縮短程式碼. 而是讓你的邏輯簡短.

>>使用有高亮語法顯示的文字編輯器. 高亮語法能讓你減少錯誤.
  1. 使用array_map快速處理陣列

比如說你想 trim 陣列中的所有元素. 新手可能會:

foreach($arr as $c => $v)
{
    $arr[$c] = trim($v);
}

但使用 array_map 更簡單:

$arr = array_map(`trim` , $arr);

這會為$arr陣列的每個元素都申請呼叫trim. 另一個類似的函式是 array_walk. 請查閱文件學習更多技巧.

  1. 使用 php filter 驗證資料

你肯定曾使用過正規表示式驗證 email , ip地址等. 是的,每個人都這麼使用. 現在, 我們想做不同的嘗試, 稱為filter.

php的filter擴充套件提供了簡單的方式驗證和檢查輸入.

  1. 強制型別檢查
$amount = intval( $_GET[`amount`] );
$rate = (int) $_GET[`rate`];

這是個好習慣.

  1. 如果需要,使用profiler如xdebug

如果你使用php開發大型的應用, php承擔了很多運算量, 速度會是一個很重要的指標. 使用profile幫助優化程式碼. 可使用

xdebug和webgrid.

  1. 小心處理大陣列

對於大的陣列和字串, 必須小心處理. 常見錯誤是發生陣列拷貝導致記憶體溢位,丟擲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()
    {
        //process $this->a
    }
}

儘快的 unset 它們, 讓記憶體得以釋放,減輕指令碼負擔.

  1. 由始至終使用單一資料庫連線

確保你的指令碼由始至終都使用單一的資料庫連線. 在開始處正確的開啟連線, 使用它直到結束, 最後關閉它. 不要像下面這樣在函式中開啟連線:

function add_to_cart()
{
    $db = new Database();
    $db->query("INSERT INTO cart .....");
}

function empty_cart()
{
    $db = new Database();
    $db->query("DELETE FROM cart .....");
}

使用多個連線是個糟糕的, 它們會拖慢應用, 因為建立連線需要時間和佔用記憶體.

特定情況使用單例模式, 如資料庫連線.

  1. 避免直接寫SQL, 抽象之

不厭其煩的寫了太多如下的語句:

$query = "INSERT INTO users(name , email , address , phone) VALUES(`$name` , `$email` , `$address` , `$phone`)";
$db->query($query); //call to mysqli_query()

這不是個建壯的方案. 它有些缺點:

>>每次都手動轉義值

>>驗證查詢是否正確

>>查詢的錯誤會花很長時間識別(除非每次都用if-else檢查)

>>很難維護複雜的查詢

因此使用函式封裝:

function insert_record($table_name , $data)
{
    foreach($data as $key => $value)
    {
    //mysqli_real_escape_string
        $data[$key] = $db->mres($value);
    }

    $fields = implode(`,` , array_keys($data));
    $values = "`" . implode("`,`" , array_values($data)) . "`";

    //Final query
    $query = "INSERT INTO {$table}($fields) VALUES($values)";

    return $db->query($query);
}

$data = array(`name` => $name , `email` => $email  , `address` => $address , `phone` => $phone);

insert_record(`users` , $data);

看到了嗎? 這樣會更易讀和擴充套件. record_data 函式小心的處理了轉義.

最大的優點是資料被預處理為一個陣列, 任何語法錯誤都會被捕獲.

該函式應該定義在某個database類中, 你可以像 $db->insert_record這樣呼叫.

檢視本文, 看看怎樣讓你處理資料庫更容易.

類似的也可以編寫update,select,delete方法. 試試吧.

  1. 將資料庫生成的內容快取到靜態檔案中

如果所有的內容都是從資料庫獲取的, 它們應該被快取. 一旦生成了, 就將它們儲存在臨時檔案中. 下次請求該頁面時, 可直接從快取中取, 不用再查資料庫.

好處:

>>節約php處理頁面的時間, 執行更快

>>更少的資料庫查詢意味著更少的mysql連線開銷
  1. 在資料庫中儲存session

基於檔案的session策略會有很多限制. 使用基於檔案的session不能擴充套件到叢集中, 因為session儲存在單個伺服器中. 但資料庫可被多個伺服器訪問, 這樣就可以解決問題.

在資料庫中儲存session資料, 還有更多好處:

>>處理username重複登入問題. 同個username不能在兩個地方同時登入.

>>能更準備的查詢線上使用者狀態.
  1. 避免使用全域性變數
>>使用 defines/constants

>>使用函式獲取值

>>使用類並通過$this訪問
  1. 在head中使用base標籤

沒聽說過? 請看下面:

<img alt="" data-original="happy.jpg" />

base 標籤非常有用. 假設你的應用分成幾個子目錄, 它們都要包括相同的導航選單.

www.domain.com/store/home.php

www.domain.com/store/products/ipad.php

在首頁中, 可以寫:

<a href="home.php">Home</a>
<a href="products/ipad.php">Ipad</a>

但在你的ipad.php不得不寫成:

<span style="color:#333333;font-family:``Helvetica, Arial, sans-serif``;"><a href="../home.php">Home</a>
<a href="ipad.php">Ipad</a></span>

因為目錄不一樣. 有這麼多不同版本的導航選單要維護, 很糟糕啊.

因此, 請使用base標籤.

<span style="color:#333333;font-family:``Helvetica, Arial, sans-serif``;"><head>
<base href="http://www.domain.com/store/">
</head>
<body>
<a href="home.php">Home</a>
<a href="products/ipad.php">Ipad</a>
</body>
</html></span>

現在, 這段程式碼放在應用的各個目錄檔案中行為都一致.

  1. 永遠不要將 error_reporting 設為 0

關閉不相的錯誤報告. E_FATAL 錯誤是很重要的.

ini_set(`display_errors`, 1);
error_reporting(~E_WARNING & ~E_NOTICE & ~E_STRICT);
  1. 注意平臺體系結構

integer在32位和64位體系結構中長度是不同的. 因此某些函式如 strtotime 的行為會不同.

在64位的機器中, 你會看到如下的輸出.

$ php -a
Interactive shell

php > echo strtotime("0000-00-00 00:00:00");
-62170005200
php > echo strtotime(`1000-01-30`);
-30607739600
php > echo strtotime(`2100-01-30`);
4104930600

但在32位機器中, 它們將是bool(false).

  1. 不要過分依賴 set_time_limit

如果你想限制最小時間, 可以使用下面的指令碼:

<span style="color:#333333;font-family:``Helvetica, Arial, sans-serif``;">set_time_limit(30);

//Rest of the code</span>

高枕無憂嗎? 注意任何外部的執行, 如系統呼叫,socket操作, 資料庫操作等, 就不在set_time_limits的控制之下.

因此, 就算資料庫花費了很多時間查詢, 指令碼也不會停止執行. 視情況而定.

  1. 使用擴充套件庫

一些例子:

>>mPDF — 能通過html生成pdf文件

>>PHPExcel — 讀寫excel

>>PhpMailer — 輕鬆處理髮送包含附近的郵件

>>pChart — 使用php生成報表

使用開源庫完成複雜任務, 如生成pdf, ms-excel檔案, 報表等.

  1. 使用MVC框架

是時候使用像 codeigniter 這樣的MVC框架了. MVC框架並不強迫你寫物件導向的程式碼. 它們僅將php程式碼與html分離.

>>明確區分php和html程式碼. 在團隊協作中有好處, 設計師和程式設計師可以同時工作.

>>物件導向設計的函式能讓你更容易維護

>>內建函式完成了很多工作, 你不需要重複編寫

>>開發大的應用是必須的

>>很多建議, 技巧和hack已被框架實現了
  1. 時常看看 phpbench

phpbench 提供了些php基本操作的基準測試結果, 它展示了一些徽小的語法變化是怎樣導致巨大差異的.

檢視php站點的評論, 有問題到IRC提問, 時常閱讀開原始碼, 使用Linux開發.

====================================分割線================================
文章轉載自 開源中國社群[http://www.oschina.net]


相關文章