欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  php教程

php中的foreach问题

程序员文章站 2022-06-16 11:04:54
...

前言:

php4中引入了foreach结构,这是一种遍历数组的简单方式。相比传统的for循环,foreach能够更加便捷的获取键值对。在php5之前,foreach仅能用于数组;php5之后,利用foreach还能遍历对象(详见:遍历对象)。本文中仅讨论遍历数组的情况。

foreach虽然简单,不过它可能会出现一些意外的行为,特别是代码涉及引用的情况下。

下面列举了几种case,有助于我们进一步认清foreach的本质。

问题1:

$arr = array(,,($arr  $k => &= $v * 

($arr  $k =>,  , 

先从简单的开始,如果我们尝试运行上述代码,就会发现最后输出为0=>2 1=>4 2=>4

为何不是0=>2 1=>4 2=>6 ?

其实,我们可以认为 ( => 隐含了如下操作,分别将数组当前的'键'和当前的'值'赋给变量$k和$v。具体展开形如:

(   =>  =     =
    

根据上述理论,现在我们重新来分析下第一个foreach:

第1遍循环,由于$v是一个引用,因此$v = &$arr[0],$v=$v*2相当于$arr[0]*2,因此$arr变成2,2,3

第2遍循环,$v = &$arr[1],$arr变成2,4,3

第3遍循环,$v = &$arr[2],$arr变成2,4,6

随后代码进入了第二个foreach:

第1遍循环,隐含操作$v=$arr[0]被触发,由于此时$v仍然是$arr[2]的引用,即相当于$arr[2]=$arr[0],$arr变成2,4,2

第2遍循环,$v=$arr[1],即$arr[2]=$arr[1],$arr变成2,4,4

第3遍循环,$v=$arr[2],即$arr[2]=$arr[2],$arr变成2,4,4

OK,分析完毕。

如何解决类似问题呢?php手册上有一段提醒:

Warning : 数组最后一个元素的 $value 引用在 foreach 循环之后仍会保留。建议使用unset()来将其销毁。
 = (1,2,3(   => & =  * 2((   =>  "", " => ", ""2  1=>4  2=>6

从这个问题中我们可以看出,引用很有可能会伴随副作用。如果不希望无意识的修改导致数组内容变更,最好及时unset掉这些引用。

问题2:

 = ('a','b','c'(   =>  (), "=>", ()
// 打印 1=>b 1=>b 1=>b

这个问题更加诡异。按照手册的说法,key和current分别是取数组中当前元素的的键值。

那为何key($arr)一直是1,current($arr)一直是b呢?

先用vld查看编译之后的opcode:

我们从第3行的ASSIGN指令看起,它代表将array('a','b','c')赋值给$arr。

由于$arr为CV,array('a','b','c')为TMP,因此ASSIGN指令找到实际执行的函数为ZEND_ASSIGN_SPEC_CV_TMP_HANDLER。这里需要特别指出,CV是PHP5.1之后才增加的一种变量cache,它采用数组的形式来保存zval**,被cache住的变量再次使用时无需去查找active符号表,而是直接去CV数组中获取,由于数组访问速度远超hash表,因而可以提高效率。

 *opline =*value = _get_zval_ptr_tmp(&opline->op2, EX(Ts), &
    zval **variable_ptr_ptr = _get_zval_ptr_ptr_cv(&opline-> (IS_CV == IS_VAR && !
         value = zend_assign_to_variable(variable_ptr_ptr, value,  (!RETURN_VALUE_UNUSED(&opline->->result.u.).

ASSIGN指令完成之后,CV数组中被加入zval**指针,指针指向实际的array,这表示$arr已经被CV缓存了起来。

接下来执行数组的循环操作,我们来看FE_RESET指令,它对应的执行函数为ZEND_FE_RESET_SPEC_CV_HANDLER:

 
        array_ptr = _get_zval_ptr_cv(&opline->array的指针保存到zend_execute_data->Ts中(Ts用于存放代码执行期的temp_variable)
    AI_SET_PTR(EX_T(opline->result.u.).  ((fe_ht = HASH_OF(array_ptr)) !=
= zend_hash_has_more_elements(fe_ht) !=result.u.var).fe.fe_pos用于保存数组内部指针
        zend_hash_get_pointer(fe_ht, &EX_T(opline->result.u.

这里主要将2个重要的指针存入了Ts中:

  • EX_T(opline->result.u.var).var ---- 指向array的指针
  • EX_T(opline->result.u.var).fe.fe_pos ---- 指向array内部元素的指针

FE_RESET指令执行完毕之后,内存中实际情况如下:

接下来我们继续查看FE_FETCH,它对应的执行函数为ZEND_FE_FETCH_SPEC_VAR_HANDLER:

 *opline =op1.u.var).var.ptr获取的
    zval *array = EX_T(opline->op1.u.). (zend_iterator_unwrap(array, &=op1.u.var).fe.fe_pos
            
            zend_hash_set_pointer(fe_ht, &EX_T(opline->op1.u.
             (zend_hash_get_current_data(fe_ht, ( **) &value)==->opcodes+opline->= zend_hash_get_current_key_ex(fe_ht, &str_key, &str_key_len, &int_key, 
op1.u.var).fe.fe_pos
            zend_hash_get_pointer(fe_ht, &EX_T(opline->op1.u.

根据FE_FETCH的实现,我们大致上明白了foreach($arr as $k => $v)所做的事情。它会根据Ts的指针去获取数组元素,在获取成功之后,将该指针移动到下一个位置再重新保存。

简单来说,由于第一遍循环中FE_FETCH中已经将数组的内部指针移动到了第二个元素,所以在foreach内部调用key($arr)和current($arr)时,实际上获取的便是1和'b'。

那为何会输出3遍1=>b呢?

我们继续看第9行和第13行的SEND_REF指令,它表示将$arr参数压栈。紧接着一般会使用DO_FCALL指令去调用key和current函数。PHP并非被编译成本地机器码,因此php采用这样的opcode指令去模拟实际CPU和内存的工作方式。

查阅PHP源码中的SEND_REF:

 
    varptr_ptr = _get_zval_ptr_ptr_cv(&opline->
= *

上述代码中的

 SEPARATE_ZVAL_TO_MAKE_IS_REF(ppzv)    \
     (!PZVAL_IS_REF(*

的主要作用为,如果变量不是一个引用,则在内存中copy出一份新的。本例中它将array('a','b','c')复制了一份。因此变量分离之后的内存为:

注意,变量分离完成之后,CV数组中的指针指向了新copy出来的数据,而通过Ts中的指针则依然可以获取旧的数据。

接下来的循环就不一一赘述了,结合上图来说:

  • foreach结构使用的是下方蓝色的array,会依次遍历a,b,c
  • key、current使用的是上方黄色的array,它的内部指针永远指向b

至此我们明白了为何key和current一直返回array的第二个元素,由于没有外部代码作用于copy出来的array,它的内部指针便永远不会移动。

问题3:

 = ('a','b','c'(   => & (), '=>', ()
b 2=>c =>

本题与问题2仅有一点区别:本题中的foreach使用了引用。用VLD查看本题,发现与问题2代码编译出来的opcode一样。因此我们采用问题2的跟踪方法,逐步查看opcode对应的实现。

首先foreach会调用FE_RESET:

  (opline->extended_value &
        array_ptr_ptr = _get_zval_ptr_ptr_cv(&opline-> (array_ptr_ptr == NULL || array_ptr_ptr == &  (Z_TYPE_PP(array_ptr_ptr) ==
             (Z_TYPE_PP(array_ptr_ptr) == (opline->extended_value &
= *

问题2中已经分析了一部分FE_RESET的实现。这里需要特别注意,本例foreach获取值采用了引用,因此在执行的时候FE_RESET中会进入与上题不同的另一个分支。

最终,FE_RESET会将array的is_ref设置为true,此时内存中只有一份array的数据。

接下来分析SEND_REF:

 
    varptr_ptr = _get_zval_ptr_ptr_cv(&opline->
= *

宏SEPARATE_ZVAL_TO_MAKE_IS_REF仅仅分离is_ref=false的变量。由于之前array已经被设置了is_ref=true,因此它不会被拷贝一份副本。换句话说,此时内存中依然只有一份array数据。

上图解释了前2次循环为何会输出1=>b 2=>C。在第3次循环FE_FETCH的时候,将指针继续向前移动。

ZEND_API  zend_hash_move_forward_ex(HashTable *ht, HashPosition **current = pos ? pos : &ht-> (**current = (*current)->
        

由于此时内部指针已经指向了数组的最后一个元素,因此再向前移动会指向NULL。将内部指针指向NULL之后,我们再对数组调用key和current,则分别会返回NULL和false,表示调用失败,此时是echo不出字符的。

问题4:

 = (1, 2, 3 = (  => & *= 2(, ); 

该题与foreach关系不大,不过既然涉及到了foreach,就一起拿来讨论吧:)

代码里首先创建了数组$arr,随后将该数组赋给了$tmp,在接下来的foreach循环中,对$v进行修改会作用于数组$tmp上,但是却并不作用到$arr。

为什么呢?

这是由于在php中,赋值运算是将一个变量的值拷贝到另一个变量中,因此修改其中一个,并不会影响到另一个。

题外话:这并不适用于object类型,从PHP5起,对象的便总是默认通过引用进行赋值,举例来说:

  = 1 =  = ->foo=100 ->foo; 

回到题目中的代码,现在我们可以确定$tmp=$arr其实是值拷贝,整个$arr数组会被再复制一份给$tmp。理论上讲,赋值语句执行完毕之后,内存中会有2份一样的数组。

也许有同学会疑问,如果数组很大,岂不是这种操作会很慢?

幸好php有更聪明的处理办法。实际上,当$tmp=$arr执行之后,内存中依然只有一份array。查看php源码中的zend_assign_to_variable实现(摘自php5.3.26):

 inline zval* zend_assign_to_variable(zval **variable_ptr_ptr, zval *value, *variable_ptr = *
     (Z_TYPE_P(variable_ptr) == IS_OBJECT && Z_OBJ_HANDLER_P(variable_ptr, 
    
         (Z_DELREF_P(variable_ptr)==*
             (! (PZVAL_IS_REF(value) && Z_REFCOUNT_P(value) > *variable_ptr_ptr =*variable_ptr = *                    // value为指向$arr里实际array数据的指针,variable_ptr_ptr为$tmp里指向数据指针的指针
                    
                    *variable_ptr_ptr =
 *

可见$tmp = $arr的本质就是将array的指针进行复制,然后将array的自动加1.用图表达出此时的内存,依然只有一份array数组:

既然只有一份array,那foreach循环中修改$tmp的时候,为何$arr没有跟着改变?

继续看PHP源码中的ZEND_FE_RESET_SPEC_CV_HANDLER函数,这是一个OPCODE HANDLER,它对应的OPCODE为FE_RESET。该函数负责在foreach开始之前,将数组的内部指针指向其第一个元素。

*opline =*array_ptr, ****iter = *ce = = 0
     (opline->extended_value &= _get_zval_ptr_ptr_cv(&opline->op1, EX(Ts), (array_ptr_ptr ==  || array_ptr_ptr == &
          (Z_TYPE_PP(array_ptr_ptr) == 
             (Z_TYPE_PP(array_ptr_ptr) ==                 // 它会重新复制一个数组出来
                // 真正分离$tmp和$arr,变成了内存中的2个数组
 (opline->extended_value &= *

从代码中可以看出,真正执行变量分离并不是在赋值语句执行的时候,而是推迟到了使用变量的时候,这也是Copy On Write机制在PHP中的实现。

FE_RESET之后,内存的变化如下:

上图解释了为何foreach并不会对原来的$arr产生影响。至于ref_count以及is_ref的变化情况,感兴趣的同学可以详细阅读ZEND_FE_RESET_SPEC_CV_HANDLER和ZEND_SWITCH_FREE_SPEC_VAR_HANDLER的具体实现(均位于php-src/zend/zend_vm_execute.h中),本文不做详细剖析:)