深入理解PHP之foreach

行易難發表於2018-07-26

語言基礎

foreach 語法結構提供了遍歷陣列的簡單方式。

php5之前, foreach僅能用於陣列 php5+, 利用foreach可以遍歷物件

foreach僅能夠應用於資料和物件，如果嘗試應用於其他資料型別的變數，或者未初始化的變數將發出錯誤資訊。

有兩種語法：

/*
  遍歷給定的 array_expression 資料。每次迴圈中， 當前單元的值被賦給$value並且陣列內部的指標向前移一步（因此下次迴圈中將會得到下一個單元）
*/
foreach (array_expression as $value) {
    // statement
}

foreach (array_expression as $value) :
    // statement
endforeach;
複製程式碼

/*
  同上，只除了當前單元格的鍵名也會在每次迴圈中被賦給變數$key
*/
foreach (array_expression as $key => $value) {
    // statement
}

foreach (array_expression as $key => $value) :
    // statement
endforeach;
複製程式碼

還能夠自定義遍歷物件!

當foreach開始執行時, 陣列內部的指標會自動指向第一個單元. 這意味著不需要在foreach迴圈之前呼叫reset() 由於foreach依賴內部陣列指標, 在迴圈中修改其值將可能導致意外的行為

可以很容易通過在 $value 之前加上 & 來修改陣列元素. 此方法將以引用 賦值, 而不是拷貝一個值.

<?php

$arr = [1, 2, 3, 4];
foreach($arr as &$value) {
    $value = $value * 2;
}

// $arr is now [2, 4, 6, 8]
unset($value); // 最後取消掉引用

複製程式碼

$value的引用僅在被遍歷的陣列可以被引用時才可用(例如是個變數)。

以下程式碼無法執行：

<?php
/*
  此段程式碼可以執行
  執行結果:
    1-2
    2-4
    3-6
    4-8
*/
foreach (array(1, 2, 3, 4) as &$value) {
    echo $value, '-';
    $value = $value * 2;
    echo $value, PHP_EOL;
}
複製程式碼

Warning: 陣列最後一個元素的 $value 引用在 foreach 迴圈之後仍會保留。建議使用 unset() 來將其銷燬。

Note: foreach 不支援用 @ 來抑制錯誤資訊的能力

foreach 雖然簡單, 不過它可能出現一些意外行為，特別是程式碼涉及到引用的時候。

問題研究

問題一: 如下程式碼執行結果為何不是 2/4/6 ?

<?php
$arr = [1, 2, 3];

foreach ($arr as $k => &$v) {
    $v = $v * 2;
}

foreach ($arr as $k => $v) {
    echo $v, PHP_EOL;
}

/*
輸出:
    2
    4
    4
*/
複製程式碼

我們可以認為 foreach($arr as &$v) 結構隱含了如下操作, 分別將陣列當前的 鍵 和 值 賦值給 $k 和 $v. 具體展開形如:

<?php
foreach ($arr as $k => $v) {
    $k = currentKey();
    $v = currentVal();
    // 繼續執行使用者程式碼
} 
複製程式碼

根據上述理論, 現在我們重新來分析下第一個foreach:

迴圈	備註	$arr值
迴圈 1-1	由於`$v`是一個引用, 因此 `$v = &$arr[0]`, `$v = $v * 2` 相當於 `$arr[0] * 2`	[2, 2, 3]
迴圈 1-2	`$v = &$arr[1]`	[2, 4, 3]
迴圈 1-3	`$v = &$arr[2]`	[2, 4, 6]
迴圈 2-1	隱含操作 `$v = $arr[0]` 被觸發, 由於此時 `$v` 仍是 `$arr[2]` 的引用, 相當於 `$arr[2] = $arr[0]`	[2, 4, 2]
迴圈 2-2	`$v = $arr[1]`, 即`$arr[2] = $arr[1]`	[2, 4, 4]
迴圈 2-3	`$v = $arr[2]`, 即`$arr[2] = $arr[2]`	[2, 4, 4]

如何解決此類問題呢? PHP手冊上有一段提醒:

Warning: 陣列最後一個元素的 $value 引用在 foreach 迴圈之後仍會保留。建議使用 unset() 來將其銷燬。

<?php
$arr = [1, 2, 3];

foreach ($arr as $k => &$v) {
    $v = $v * 2;
}
unset($v);
foreach ($arr as $k => $v) {
    echo $v, PHP_EOL;
}

/*
輸出:
    2
    4
    6
*/
複製程式碼

從這個問題可以看出, 引用很可能會伴隨副作用。如果不希望無意識的修改導致資料內容變更，最好及時unset掉這些引用。

問題二: 如下程式碼執行結果為何不是 0=>a 1=>b 2=>c

<?php
$arr = ['a', 'b', 'c'];

foreach ($arr as $k => $v) {
    echo key($arr), "=>", current($arr), PHP_EOL;
}

foreach ($arr as $k => &$v) {
    echo key($arr), "=>", current($arr), PHP_EOL;
}
/*
#php5.6
1=>b 1=>b 1=>b
1=>b 2=>c =>

#php7
0=>a 0=>a 0=>a
0=>a 0=>a 0=>a
*/
複製程式碼

按照手冊中的說法, key和current分別是獲取資料中當前元素的鍵值。那為何 key($arr) 一直是0，current($arr) 一直是'a'呢？

先用vld檢視編譯後的 opcode:

➜  demo /usr/local/Cellar/php/7.2.7/bin/php -dvld.active=1 a.php
Finding entry points
Branch analysis from position: 0
Jump found. (Code = 77) Position 1 = 2, Position 2 = 15
Branch analysis from position: 2
Jump found. (Code = 78) Position 1 = 3, Position 2 = 15
Branch analysis from position: 3
Jump found. (Code = 42) Position 1 = 2
Branch analysis from position: 2
Branch analysis from position: 15
Jump found. (Code = 62) Position 1 = -2
Branch analysis from position: 15
filename:       /Users/jianyong/demo/a.php
function name:  (null)
number of ops:  17
compiled vars:  !0 = $arr, !1 = $v, !2 = $k
line     #* E I O op                           fetch          ext  return  operands
-------------------------------------------------------------------------------------
   2     0  E >   ASSIGN                                                   !0, <array>
   4     1      > FE_RESET_R                                       $4      !0, ->15
         2    > > FE_FETCH_R                                       ~5      $4, !1, ->15
         3    >   ASSIGN                                                   !2, ~5
   5     4        INIT_FCALL                                               'key'
         5        SEND_VAR                                                 !0
         6        DO_ICALL                                         $7
         7        ECHO                                                     $7
         8        ECHO                                                     '%3D%3E'
         9        INIT_FCALL                                               'current'
        10        SEND_VAR                                                 !0
        11        DO_ICALL                                         $8
        12        ECHO                                                     $8
        13        ECHO                                                     '%0A'
        14      > JMP                                                      ->2
        15    >   FE_FREE                                                  $4
   7    16      > RETURN                                                   1

branch: #  0; line:     2-    4; sop:     0; eop:     1; out1:   2; out2:  15
branch: #  2; line:     4-    4; sop:     2; eop:     2; out1:   3; out2:  15
branch: #  3; line:     4-    5; sop:     3; eop:    14; out1:   2
branch: # 15; line:     5-    7; sop:    15; eop:    16; out1:  -2
path #1: 0, 2, 3, 2, 15,
path #2: 0, 2, 15,
path #3: 0, 15,
0=>a
0=>a
0=>a
複製程式碼

PHP7新特性之foreach

[x] foreach 迴圈對陣列內部指標不再起作用, 在PHP7之前, 當資料通過foreach迭代時, 陣列指標會移動。

<?php
$array = [0, 1, 2];
foreach ($array as &$val) {
    var_dump(current($array));
}
複製程式碼

版本	結果	說明
PHP5	int(1) int(2) bool(false)	陣列指標會移動
PHP7	int(0) int(0) int(0)	資料指標不再移動

[x] 按照值進行迴圈時, 對陣列的修改是不會影響迴圈。

foreach按照值進行迴圈的時候(by-value), foreach是對該陣列的一個拷貝進行操作. 所以在迴圈過程中修改不影響迴圈結果

<?php
$arr = [0, 1, 2];
$ref = &$arr;

foreach ($arr as $val) {
    var_dump($val);
    unset($arr[1]);
}
複製程式碼

版本	結果	說明
PHP5	int(0) int(2)	會將unset的資料跳過
PHP7	int(0) int(1) int(2)	對陣列的改動不影響迴圈

[x] 按照引用進行迴圈的時候, 對陣列的修改會影響迴圈

<?php
$arr = [0, 1, 2];
$ref = &$arr;

foreach ($arr as &$val) {
    var_dump($val);
    unset($arr[1]);
}
複製程式碼

版本	結果
PHP5	int(0) int(2)
PHP7	int(0) int(2)

[x] 對簡單物件plain(non-Traversable)的迴圈

在簡單物件的迴圈, 不管是按照值迴圈還是引用迴圈, 和按照引用對陣列迴圈的行為是一樣的, 不過對位置的管理會更加精確

[x] 對迭代物件(Traversable objects)物件行為和之前一致

stackoverflow 上面的解釋, Traversable objects is one that implements Iterator or IteratorAggregate interface

如果一個物件實現了 Iterator 或者 IteratorAggregate 介面, 即可稱之為迭代物件

參考

https://wiki.php.net/rfc/php7_foreach
97fe15db4356f8fa1b3b8eb9bb1baa8141376077

深入理解PHP之strpos
2019-02-16
PHP
深入理解PHP物件注入
2016-04-09
PHP物件
我理解的foreach, for in, for of 之間的異同
2018-10-25
深入理解PHP之isset和array_key_exists對比
2018-10-08
PHP
深入理解PHP之：Nginx 與 FPM 的工作機制
2016-04-05
PHPNginx
深入理解PHP物件導向之後期靜態繫結
2021-01-17
PHP物件
深入理解 PHP opcode 優化
2017-06-02
PHP優化
深入瞭解C#（TPL）之Parallel.ForEach非同步
2020-06-20
C#Parallel非同步
深入理解Javascript之Promise
2018-11-13
JavaScriptPromise
深入理解Javascript之Module
2018-12-24
JavaScript
深入理解JVM之OOM
2015-03-10
JVMOOM
php中foreach的使用
2021-09-11
PHP
深入理解PHP中賦值與引用
2015-01-06
PHP賦值
深入理解 Golang 之 context
2020-03-01
GolangContext
深入理解 Javascript 之作用域
2019-02-24
JavaScript
SQL Server之深入理解STUFF
2021-09-09
SQLServer
深入理解MySQL系列之鎖
2020-12-26
MySql
深入理解MySQL系列之索引
2020-12-24
MySql索引
深入理解JavaScript之Event Loop
2018-06-27
JavaScriptOOP
CSS深入理解之absolute定位
2018-05-25
CSS
深入理解python之self
2016-11-20
Python
PHP 中的 foreach 工作原理
2018-07-31
PHP
深入理解Golang之interface和reflect
2019-10-13
Golang
深入理解GCD之dispatch_group
2019-02-27
GC
深入理解GCD之dispatch_queue
2019-02-27
GC
深入理解Javascript之Callstack&EventLoop
2019-03-02
JavaScriptOOP
深入理解Javascript之Execution Context
2018-12-06
JavaScriptContext
深入理解GlusterFS之資料均衡
2018-07-31
CSS深入理解之relative定位
2018-05-25
CSS
CSS 深入理解之 float 浮動
2018-05-25
CSS
iOS學習之深入理解RunLoop
2017-12-25
iOSOOP
深入理解Hystrix之文件翻譯
2017-07-24
深入理解JVM之類載入
2014-03-25
JVM
bootstrap深入理解之格子布局
2016-05-12
boot
PHP中foreach讀取順序
2021-12-28
PHP
深入理解 PHP 的 7 個預定義介面
2018-12-16
PHP
深入理解 JVM 之垃圾收集器
2019-02-25
JVM
深入理解 JVM 之垃圾回收機制
2019-02-25
JVM