PHP程式設計中10個最常見的錯誤

codecloud發表於2014-08-05

  PHP是一種非常流行的開源伺服器端指令碼語言,你在全球資訊網看到的大多數網站都是使用php開發的。本篇經將為大家介紹PHP開發中10個最常見的問題,希望能夠對朋友有所幫助。

 錯誤1:foreach迴圈後留下懸掛指標

  在foreach迴圈中,如果我們需要更改迭代的元素或是為了提高效率,運用引用是一個好辦法:

$arr = array(1, 2, 3, 4); 
foreach ($arr as &$value) { 
    $value = $value * 2; 
} 
// $arr is now array(2, 4, 6, 8)

  這裡有個問題很多人會迷糊。迴圈結束後,$value並未銷燬,$value其實是陣列中最後一個元素的引用,這樣在後續對$value的使用中,如果不知道這一點,會引發一些莫名奇妙的錯誤:)看看下面這段程式碼:

$array = [1, 2, 3]; 
echo implode(',', $array), "\n"; 

foreach ($array as &$value) {}    // by reference 
echo implode(',', $array), "\n"; 

foreach ($array as $value) {}     // by value (i.e., copy) 
echo implode(',', $array), "\n";

  上面程式碼的執行結果如下:

1,2,3 
1,2,3 
1,2,2

  你猜對了嗎?為什麼是這個結果呢?

  我們來分析下。第一個迴圈過後,$value是陣列中最後一個元素的引用。第二個迴圈開始:

  • 第一步:複製$arr[0]到$value(注意此時$value是$arr[2]的引用),這時陣列變成[1,2,1]
  • 第二步:複製$arr[1]到$value,這時陣列變成[1,2,2]
  • 第三步:複製$arr[2]到$value,這時陣列變成[1,2,2]

  綜上,最終結果就是1,2,2

  避免這種錯誤最好的辦法就是在迴圈後立即用unset函式銷燬變數:

$arr = array(1, 2, 3, 4); 
foreach ($arr as &$value) { 
    $value = $value * 2; 
} 
unset($value);   // $value no longer references $arr[3]

 錯誤2:對isset()函式行為的錯誤理解

  對於isset()函式,變數不存在時會返回false,變數值為null時也會返回false。這種行為很容易把人弄迷糊。。。看下面的程式碼:

$data = fetchRecordFromStorage($storage, $identifier); 
if (!isset($data['keyShouldBeSet']) { 
    // do something here if 'keyShouldBeSet' is not set 
}

  寫這段程式碼的人本意可能是如果$data['keyShouldBeSet']未設定,則執行對應邏輯。但問題在於即使$data['keyShouldBeSet']已設定,但設定的值為null,還是會執行對應的邏輯,這就不符合程式碼的本意了。

  下面是另外一個例子:

if ($_POST['active']) { 
    $postData = extractSomething($_POST); 
} 

// ... 

if (!isset($postData)) { 
    echo 'post not active'; 
}

  上面的程式碼假設$_POST['active']為真,那麼$postData應該被設定,因此isset($postData)會返回true。反之,上 面程式碼假設isset($postData)返回false的唯一途徑就是$_POST['active']也返回false。

  真是這樣嗎?當然不是!

  即使$_POST['active']返回true,$postData也有可能被設定為null,這時isset($postData)就會返回false。這就不符合程式碼的本意了。

  如果上面程式碼的本意僅是檢測$_POST['active']是否為真,下面這樣實現會更好:

if ($_POST['active']) { 
    $postData = extractSomething($_POST); 
} 

// ... 

if ($_POST['active']) { 
    echo 'post not active'; 
}

  判斷一個變數是否真正被設定(區分未設定和設定值為null),array_key_exists()函式或許更好。重構上面的第一個例子,如下:

$data = fetchRecordFromStorage($storage, $identifier); 
if (! array_key_exists('keyShouldBeSet', $data)) { 
    // do this if 'keyShouldBeSet' isn't set 
}

  另外,結合get_defined_vars()函式,我們可以更加可靠的檢測變數在當前作用域內是否被設定:

if (array_key_exists('varShouldBeSet', get_defined_vars())) { 
    // variable $varShouldBeSet exists in current scope 
}

 錯誤3:混淆返回值和返回引用

  考慮下面的程式碼:

class Config 
{ 
    private $values = []; 

    public function getValues() { 
        return $this->values; 
    } 
} 

$config = new Config(); 

$config->getValues()['test'] = 'test'; 
echo $config->getValues()['test'];

  執行上面的程式碼,將會輸出下面的內容:

PHP Notice:  Undefined index: test in /path/to/my/script.php on line 21

  問題出在哪呢?問題就在於上面的程式碼混淆了返回值和返回引用。在PHP中,除非你顯示的指定返回引用,否則對於陣列PHP是值返回,也就是陣列的拷貝。因此上面程式碼對返回陣列賦值,實際是對拷貝陣列進行賦值,非原陣列賦值。

// getValues() returns a COPY of the $values array, so this adds a 'test' element 
// to a COPY of the $values array, but not to the $values array itself. 
$config->getValues()['test'] = 'test'; 

// getValues() again returns ANOTHER COPY of the $values array, and THIS copy doesn't 
// contain a 'test' element (which is why we get the "undefined index" message). 
echo $config->getValues()['test'];

  下面是一種可能的解決辦法,輸出拷貝的陣列,而不是原陣列:

$vals = $config->getValues(); 
$vals['test'] = 'test'; 
echo $vals['test'];

  如果你就是想要改變原陣列,也就是要反回陣列引用,那應該如何處理呢?辦法就是顯示指定返回引用即可:

class Config 
{ 
    private $values = []; 

    // return a REFERENCE to the actual $values array 
    public function &getValues() { 
        return $this->values; 
    } 
} 

$config = new Config(); 

$config->getValues()['test'] = 'test'; 
echo $config->getValues()['test'];

  經過改造後,上面程式碼將會像你期望那樣會輸出test。

  我們再來看一個例子會讓你更迷糊的例子:

class Config 
{ 
    private $values; 

    // using ArrayObject rather than array 
    public function __construct() { 
        $this->values = new ArrayObject(); 
    } 

    public function getValues() { 
        return $this->values; 
    } 
} 

$config = new Config(); 

$config->getValues()['test'] = 'test'; 
echo $config->getValues()['test'];

  如果你想的是會和上面一樣輸出“ Undefined index”錯誤,那你就錯了。程式碼會正常輸出“test”。原因在於PHP對於物件預設就是按引用返回的,而不是按值返回。

  綜上所述,我們在使用函式返回值時,要弄清楚是值返回還是引用返回。PHP中對於物件,預設是引用返回,陣列和內建基本型別預設均按值返回。這個要與其它語言區別開來(很多語言對於陣列是引用傳遞)。

  像其它語言,比如java或C#,利用getter或setter來訪問或設定類屬性是一種更好的方案,當然PHP預設不支援,需要自己實現:

class Config 
{ 
    private $values = []; 

    public function setValue($key, $value) { 
        $this->values[$key] = $value; 
    } 

    public function getValue($key) { 
        return $this->values[$key]; 
    } 
} 

$config = new Config(); 

$config->setValue('testKey', 'testValue'); 
echo $config->getValue('testKey');    // echos 'testValue'

  上面的程式碼給呼叫者可以訪問或設定陣列中的任意值而不用給與陣列public訪問許可權。感覺怎麼樣:)

 錯誤4:在迴圈中執行sql查詢

  在PHP程式設計中發現類似下面的程式碼並不少見:

$models = []; 

foreach ($inputValues as $inputValue) { 
    $models[] = $valueRepository->findByValue($inputValue); 
}

  當然上面的程式碼是沒有什麼錯誤的。問題在於我們在迭代過程中$valueRepository->findByValue()可能每次都執行了sql查詢:

$result = $connection->query("SELECT `x`,`y` FROM `values` WHERE `value`=" . $inputValue);

  如果迭代了10000次,那麼你就分別執行了10000次sql查詢。如果這樣的指令碼在多執行緒程式中被呼叫,那很可能你的系統就掛了。。。

  在編寫程式碼過程中,你應該要清楚什麼時候應該執行sql查詢,儘可能一次sql查詢取出所有資料。

  有一種業務場景,你很可能會犯上述錯誤。假設一個表單提交了一系列值(假設為IDs),然後為了取出所有ID對應的資料,程式碼將遍歷IDs,分別對每個ID執行sql查詢,程式碼如下所示:

$data = []; 
foreach ($ids as $id) { 
    $result = $connection->query("SELECT `x`, `y` FROM `values` WHERE `id` = " . $id); 
    $data[] = $result->fetch_row(); 
}

  但同樣的目的可以在一個sql中更加高效的完成,程式碼如下:

$data = []; 
if (count($ids)) { 
    $result = $connection->query("SELECT `x`, `y` FROM `values` WHERE `id` IN (" . implode(',', $ids)); 
    while ($row = $result->fetch_row()) { 
        $data[] = $row; 
    } 
}

 錯誤5:記憶體使用低效和錯覺

  一次sql查詢獲取多條記錄比每次查詢獲取一條記錄效率肯定要高,但如果你使用的是php中的mysql擴充套件,那麼一次獲取多條記錄就很可能會導致記憶體溢位。

  我們可以寫程式碼來實驗下(測試環境: 512MB RAM、MySQL、php-cli):

// connect to mysql 
$connection = new mysqli('localhost', 'username', 'password', 'database'); 

// create table of 400 columns 
$query = 'CREATE TABLE `test`(`id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT'; 
for ($col = 0; $col < 400; $col++) { 
    $query .= ", `col$col` CHAR(10) NOT NULL"; 
} 
$query .= ');'; 
$connection->query($query); 

// write 2 million rows 
for ($row = 0; $row < 2000000; $row++) { 
    $query = "INSERT INTO `test` VALUES ($row"; 
    for ($col = 0; $col < 400; $col++) { 
        $query .= ', ' . mt_rand(1000000000, 9999999999); 
    } 
    $query .= ')'; 
    $connection->query($query); 
}

  現在來看看資源消耗:

// connect to mysql 
$connection = new mysqli('localhost', 'username', 'password', 'database'); 
echo "Before: " . memory_get_peak_usage() . "\n"; 

$res = $connection->query('SELECT `x`,`y` FROM `test` LIMIT 1'); 
echo "Limit 1: " . memory_get_peak_usage() . "\n"; 

$res = $connection->query('SELECT `x`,`y` FROM `test` LIMIT 10000'); 
echo "Limit 10000: " . memory_get_peak_usage() . "\n";

  輸出結果如下:

Before: 224704 
Limit 1: 224704 
Limit 10000: 224704

  根據記憶體使用量來看,貌似一切正常。為了更加確定,試著一次獲取100000條記錄,結果程式得到如下輸出:

PHP Warning:  mysqli::query(): (HY000/2013): 
              Lost connection to MySQL server during query in /root/test.php on line 11

  這是怎麼回事呢?

  問題出在php的mysql模組的工作方式,mysql模組實際上就是libmysqlclient的一個代理。在查詢獲取多條記錄的同時,這些記錄會直接 儲存在記憶體中。由於這塊記憶體不屬於php的記憶體模組所管理,所以我們呼叫memory_get_peak_usage()函式所獲得的值並非真實使用記憶體 值,於是便出現了上面的問題。

  我們可以使用mysqlnd來代替mysql,mysqlnd編譯為php自身擴充套件,其記憶體使用由php記憶體管理模組所控制。如果我們用mysqlnd來實現上面的程式碼,則會更加真實的反應記憶體使用情況:

Before: 232048 
Limit 1: 324952 
Limit 10000: 32572912

  更加糟糕的是,根據php的官方文件,mysql擴充套件儲存查詢資料使用的記憶體是mysqlnd的兩倍,因此原來的程式碼使用的記憶體是上面顯示的兩倍左右。

  為了避免此類問題,可以考慮分幾次完成查詢,減小單次查詢資料量:

$totalNumberToFetch = 10000; 
$portionSize = 100; 

for ($i = 0; $i <= ceil($totalNumberToFetch / $portionSize); $i++) { 
    $limitFrom = $portionSize * $i; 
    $res = $connection->query( 
                         "SELECT `x`,`y` FROM `test` LIMIT $limitFrom, $portionSize"); 
}

  聯絡上面提到的錯誤4可以看出,在實際的編碼過程中,要做到一種平衡,才能既滿足功能要求,又能保證效能。

 錯誤6:忽略Unicode/UTF-8問題

  php程式設計中,在處理非ascii字元時,會遇到一些問題,要很小心的去對待,要不然就會錯誤遍地。舉個簡單的例子,strlen($name),如果$name包含非ascii字元,那結果就有些出乎意料。在此給出一些建議,儘量避免此類問題:

  • 如果你對unicode和utf-8不是很瞭解,那麼你至少應該瞭解一些基礎。推薦閱讀這篇文章
  • 最好使用mb_*函式來處理字串,避免使用老的字串處理函式。這裡要確保PHP的“multibyte”擴充套件已開啟。
  • 資料庫和表最好使用unicode編碼。
  • 知道jason_code()函式會轉換非ascii字元,但serialize()函式不會。
  • php程式碼原始檔最好使用不含bom的utf-8格式。

  在此推薦一篇文章,更詳細的介紹了此類問題: UTF-8 Primer for PHP and MySQL

 錯誤7:假定$_POST總是包含POST資料

  PHP中的$_POST並非總是包含表單POST提交過來的資料。假設我們通過 jQuery.ajax() 方法向伺服器傳送了POST請求:

// js 
$.ajax({ 
    url: 'http://my.site/some/path', 
    method: 'post', 
    data: JSON.stringify({a: 'a', b: 'b'}), 
    contentType: 'application/json' 
});

  注意程式碼中的 contentType: ‘application/json’ ,我們是以json資料格式來傳送的資料。在服務端,我們僅輸出$_POST陣列:

// php 
var_dump($_POST);

  你會很驚奇的發現,結果是下面所示:

array(0) { }

  為什麼是這樣的結果呢?我們的json資料 {a: ‘a’, b: ‘b’} 哪去了呢?

  答案就是PHP僅僅解析Content-Type為 application/x-www-form-urlencoded 或 multipart/form-data的Http請求。之所以這樣是因為歷史原因,PHP最初實現$_POST時,最流行的就是上面兩種型別。因此雖說現在有些型別(比如application/json)很流行,但PHP中還是沒有去實現自動處理。

  因為$_POST是全域性變數,所以更改$_POST會全域性有效。因此對於Content-Type為 application/json 的請求,我們需要手工去解析json資料,然後修改$_POST變數。

// php 
$_POST = json_decode(file_get_contents('php://input'), true);

  此時,我們再去輸出$_POST變數,則會得到我們期望的輸出:

array(2) { ["a"]=> string(1) "a" ["b"]=> string(1) "b" }

 錯誤8:認為PHP支援字元資料型別

  看看下面的程式碼,猜測下會輸出什麼:

for ($c = 'a'; $c <= 'z'; $c++) { 
    echo $c . "\n"; 
}

  如果你的回答是輸出’a'到’z',那麼你會驚奇的發現你的回答是錯誤的。

  不錯,上面的程式碼的確會輸出’a'到’z',但除此之外,還會輸出’aa’到’yz’。我們來分析下為什麼會是這樣的結果。

  在PHP中不存在char資料型別,只有string型別。明白這點,那麼對’z'進行遞增操作,結果則為’aa’。對於字串比較大小,學過C的應該都知道,’aa’是小於’z'的。這也就解釋了為何會有上面的輸出結果。

  如果我們想輸出’a'到’z',下面的實現是一種不錯的辦法:

for ($i = ord('a'); $i <= ord('z'); $i++) { 
    echo chr($i) . "\n"; 
}

  或者這樣也是OK的:

$letters = range('a', 'z'); 

for ($i = 0; $i < count($letters); $i++) { 
    echo $letters[$i] . "\n"; 
}

 錯誤9:忽略編碼標準

  雖說忽略編碼標準不會導致錯誤或是bug,但遵循一定的編碼標準還是很重要的。

  沒有統一的編碼標準會使你的專案出現很多問題。最明顯的就是你的專案程式碼不具有一致性。更壞的地方在於,你的程式碼將更加難以除錯、擴充套件和維護。這也就意味著你的團隊效率會降低,包括做一些很多無意義的勞動。

  對於PHP開發者來說,是比較幸運的。因為有PHP編碼標準推薦(PSR),由下面5個部分組成:

  • PSR-0:自動載入標準
  • PSR-1:基本編碼標準
  • PSR-2:編碼風格指南
  • PSR-3:日誌介面標準
  • PSR-4:自動載入

  PSR最初由PHP社群的幾個大的團體所建立並遵循。Zend, Drupal, Symfony, Joomla及其它的平臺都為此標準做過貢獻並遵循這個標準。即使是PEAR,早些年也想讓自己成為一個標準,但現在也加入了PSR陣營。

  在某些情況下,使用什麼編碼標準是無關緊要的,只要你使用一種編碼風格並一直堅持使用即可。但是遵循PSR標準不失為一個好辦法,除非你有什麼特殊的原因要 自己弄一套。現在越來越多的專案都開始使用PSR,大部分的PHP開發者也在使用PSR,因此使用PSR會讓新加入你團隊的成員更快的熟悉專案,寫程式碼時 也會更加舒適。

 錯誤10:錯誤使用empty()函式

  一些PHP開發人員喜歡用empty()函式去對變數或表示式做布林判斷,但在某些情況下會讓人很困惑。

  首先我們來看看PHP中的陣列Array和陣列物件ArrayObject。看上去好像沒什麼區別,都是一樣的。真的這樣嗎?

// PHP 5.0 or later: 
$array = []; 
var_dump(empty($array));        // outputs bool(true)  
$array = new ArrayObject(); 
var_dump(empty($array));        // outputs bool(false) 
// why don't these both produce the same output?

  讓事情變得更復雜些,看看下面的程式碼:

// Prior to PHP 5.0: 
$array = []; 
var_dump(empty($array));        // outputs bool(false)  
$array = new ArrayObject(); 
var_dump(empty($array));        // outputs bool(false)

  很不幸的是,上面這種方法很受歡迎。例如,在Zend Framework 2中,Zend\Db\TableGateway 在 TableGateway::select() 結果集上呼叫 current() 方法返回資料集時就是這麼幹的。開發人員很容易就會踩到這個坑。

  為了避免這些問題,檢查一個陣列是否為空最後的辦法是用 count() 函式:

// Note that this work in ALL versions of PHP (both pre and post 5.0): 
$array = []; 
var_dump(count($array));        // outputs int(0) 
$array = new ArrayObject(); 
var_dump(count($array));        // outputs int(0)

  在這順便提一下,因為PHP中會將數值0認為是布林值false,因此 count() 函式可以直接用在 if 條件語句的條件判斷中來判斷陣列是否為空。另外,count() 函式對於陣列來說複雜度為O(1),因此用 count() 函式是一個明智的選擇。

  再來看一個用 empty() 函式很危險的例子。當在魔術方法 __get() 中結合使用 empty() 函式時,也是很危險的。我們來定義兩個類,每個類都有一個 test 屬性。

  首先我們定義 Regular 類,有一個 test 屬性:

class Regular 
{ 
    public $test = 'value'; 
}

  然後我們定義 Magic 類,並用 __get() 魔術方法來訪問它的 test 屬性:

class Magic 
{ 
    private $values = ['test' => 'value']; 

    public function __get($key) 
    { 
        if (isset($this->values[$key])) { 
            return $this->values[$key]; 
        } 
    } 
}

  好了。我們現在來看看訪問各個類的 test 屬性會發生什麼:

$regular = new Regular(); 
var_dump($regular->test);    // outputs string(4) "value" 
$magic = new Magic(); 
var_dump($magic->test);      // outputs string(4) "value"

  到目前為止,都還是正常的,沒有讓我們感到迷糊。

  但在 test 屬性上使用 empty() 函式會怎麼樣呢?

var_dump(empty($regular->test));    // outputs bool(false) 
var_dump(empty($magic->test));      // outputs bool(true)

  結果是不是很意外?

  很不幸的是,如果一個類使用魔法 __get() 函式來訪問類屬性的值,沒有簡單的方法來檢查屬性值是否為空或是不存在。在類作用域外,你只能檢查是否返回 null 值,但這並不一定意味著沒有設定相應的鍵,因為鍵值可以被設定為 null 。

  相比之下,如果我們訪問 Regular 類的一個不存在的屬性,則會得到一個類似下面的Notice訊息:

Notice: Undefined property: Regular::$nonExistantTest in /path/to/test.php on line 10 

Call Stack: 
    0.0012     234704   1. {main}() /path/to/test.php:0

  因此,對於 empty() 函式,我們要小心的使用,要不然的話就會結果出乎意料,甚至潛在的誤導你。

  By: Eddy  譯自:10 Most Common PHP Mistakes

相關文章