深入解析PHP中foreach语句控制数组循环的用法

这篇文章主要介绍了深入解析PHP中foreach语句控制数组循环的用法,是PHP入门学习中的基础知识,需要的朋友可以参考下。

foreach是PHP中很常用的一个用作数组循环的控制语句。

因为它的方便和易用,自然也就在后端隐藏着很复杂的具体实现方式(对用户透明)

今天,我们就来一起分析分析,foreach是如何实现数组(对象)的遍历的。

我们知道PHP是一个脚本语言,也就是说,用户编写的PHP代码最终都是会被PHP解释器解释执行,特别的,对于PHP来说,所有的用户编写的PHP代码,都会被翻译成PHP的虚拟机ZE的虚拟指令(OPCODES)来执行,不论细节的话,就是说,我们所编写的任何PHP脚本,都会最终被翻译成一条条的指令,从而根据指令,由相应的C编写的函数来执行。

那么foreach会被翻译成什么样子呢?

  1. foreach($arr as $key => $val){
  2. echo $key . '=>' . $val . "\n";
  3. }

在词法分析阶段,foreach会被识别为一个TOKEN:T_FOREACH,

在语法分析阶段,会被规则:

  1. unticked_statement: //没有被绑定ticks的语句
  2. //有省略
  3. | T_FOREACH '(' variable T_AS
  4. { zend_do_foreach_begin(&$1, &$2, &$3, &$4, 1 TSRMLS_CC); }
  5. foreach_variable foreach_optional_arg ')' { zend_do_foreach_cont(&$1, &$2, &$4, &$6, &$7 TSRMLS_CC); }
  6. foreach_statement { zend_do_foreach_end(&$1, &$4 TSRMLS_CC); }
  7. | T_FOREACH '(' expr_without_variable T_AS
  8. { zend_do_foreach_begin(&$1, &$2, &$3, &$4, 0 TSRMLS_CC); }
  9. variable foreach_optional_arg ')' { zend_check_writable_variable(&$6); zend_do_foreach_cont(&$1, &$2, &$4, &$6, &$7 TSRMLS_CC); }
  10. foreach_statement { zend_do_foreach_end(&$1, &$4 TSRMLS_CC); }
  11. //有省略
  12. ;

仔细分析这段语法规则,我们可以发现,对于:

  1. foreach($arr as $key => $val){
  2. echo $key . ‘=>' . $val .”\n”;
  3. }

会被分析为:

  1. T_FOREACH '(' variable T_AS { zend_do_foreach_begin('foreach', '(', $arr, 'as', 1 TSRMLS_CC); }
  2. foreach_variable foreach_optional_arg(T_DOUBLE_ARROW foreach_variable) ')' { zend_do_foreach_cont('foreach', '(', 'as', $key, $val TSRMLS_CC); }
  3. foreach_satement {zend_do_foreach_end('foreach', 'as');}

然后,让我们来看看foreach_statement:

它其实就是一个代码块,体现了我们的 echo $key . ‘=>' . $val .”\n”;

T_ECHO expr;

显然,实现foreach的核心就是如下3个函数:

zend_do_foreach_begin

zend_do_foreach_cont

zend_do_foreach_end

其中,zend_do_foreach_begin (代码太长,直接写伪码) 主要做了:

1. 记录当前的opline行数(为以后跳转而记录)

2. 对数组进行RESET(讲内部指针指向第一个元素)

3. 获取临时变量 ($val)

4. 设置获取变量的OPCODE FE_FETCH,结果存第3步的临时变量

5. 记录获取变量的OPCODES的行数

而对于 zend_do_foreach_cont来说:

1. 根据foreach_variable的u.EA.type来判断是否引用

2. 根据是否引用来调整zend_do_foreach_begin中生成的FE_FETCH方式

3. 根据zend_do_foreach_begin中记录的取变量的OPCODES的行数,来初始化循环(主要处理在循环内部的循环:do_begin_loop)

最后zend_do_foreach_end:

1. 根据zend_do_foreach_begin中记录的行数信息,设置ZEND_JMP OPCODES

2. 根据当前行数,设置循环体下一条opline, 用以跳出循环

3. 结束循环(处理循环内循环:do_end_loop)

4. 清理临时变量

当然, 在zend_do_foreach_cont 和 zend_do_foreach_end之间 会在语法分析阶段被填充foreach_satement的语句代码。

这样,就实现了foreach的OPCODES line。

比如对于我们开头的实例代码,最终生成的OPCODES是:

  1. filename: /home/huixinchen/foreach.php
  2. function name: (null)
  3. number of ops: 17
  4. compiled vars: !0 = $arr, !1 = $key, !2 = $val
  5. line # op fetch ext return operands
  6. -------------------------------------------------------------------------------
  7. 2 0 SEND_VAL 1
  8. 1 SEND_VAL 100
  9. 2 DO_FCALL 2 'range'
  10. 3 ASSIGN !0, $0
  11. 3 4 FE_RESET $2 !0, ->14
  12. 5 FE_FETCH $3 $2, ->14
  13. 6 ZEND_OP_DATA ~5
  14. 7 ASSIGN !2, $3
  15. 8 ASSIGN !1, ~5
  16. 4 9 CONCAT ~7 !1, '-'
  17. 10 CONCAT ~8 ~7, !2
  18. 11 CONCAT ~9 ~8, '%0A'
  19. 12 ECHO ~9
  20. 5 13 JMP ->5
  21. 14 SWITCH_FREE $2
  22. 7 15 RETURN 1
  23. 16* ZEND_HANDLE_EXCEPTION

我们注意到FE_FETCH的op2的操作数是14,也就是JMP后一条opline,也就是说,在获取完最后一个数组元素以后,FE_FETCH失败的情况下,会跳到第14行opline,从而实现了循环的结束。

而15行opline的op1的操作数是指向了FE_FETCH,也就是无条件跳转到第5行opline,从而实现了循环。

附录:

  1. void zend_do_foreach_begin(znode *foreach_token, znode *open_brackets_token, znode *array, znode *as_token, int variable TSRMLS_DC)
  2. {
  3. zend_op *opline;
  4. zend_bool is_variable;
  5. zend_bool push_container = 0;
  6. zend_op dummy_opline;
  7. if (variable) {
  8. //是否是匿名数组
  9. if (zend_is_function_or_method_call(array)) {
  10. //是否是函数返回值
  11. is_variable = 0;
  12. } else {
  13. is_variable = 1;
  14. }
  15. /* 使用括号记录FE_RESET的opline行数 */
  16. open_brackets_token->u.opline_num = get_next_op_number(CG(active_op_array));
  17. zend_do_end_variable_parse(BP_VAR_W, 0 TSRMLS_CC); //获取数组/对象和zend_do_begin_variable_parse对应
  18. if (CG(active_op_array)->last > 0 &&
  19. CG(active_op_array)->opcodes[CG(active_op_array)->last-1].opcode == ZEND_FETCH_OBJ_W) {
  20. /* Only lock the container if we are fetching from a real container and not $this */
  21. if (CG(active_op_array)->opcodes[CG(active_op_array)->last-1].op1.op_type == IS_VAR) {
  22. CG(active_op_array)->opcodes[CG(active_op_array)->last-1].extended_value |= ZEND_FETCH_ADD_LOCK;
  23. push_container = 1;
  24. }
  25. }
  26. } else {
  27. is_variable = 0;
  28. open_brackets_token->u.opline_num = get_next_op_number(CG(active_op_array));
  29. }
  30. foreach_token->u.opline_num = get_next_op_number(CG(active_op_array)); //记录数组Reset Opline number
  31. opline = get_next_op(CG(active_op_array) TSRMLS_CC); //生成Reset数组Opcode
  32. opline->opcode = ZEND_FE_RESET;
  33. opline->result.op_type = IS_VAR;
  34. opline->result.u.var = get_temporary_variable(CG(active_op_array));
  35. opline->op1 = *array;
  36. SET_UNUSED(opline->op2);
  37. opline->extended_value = is_variable ? ZEND_FE_RESET_VARIABLE : 0;
  38. dummy_opline.result = opline->result;
  39. if (push_container) {
  40. dummy_opline.op1 = CG(active_op_array)->opcodes[CG(active_op_array)->last-2].op1;
  41. } else {
  42. znode tmp;
  43. tmp.op_type = IS_UNUSED;
  44. dummy_opline.op1 = tmp;
  45. }
  46. zend_stack_push(&CG(foreach_copy_stack), (void *) &dummy_opline, sizeof(zend_op));
  47. as_token->u.opline_num = get_next_op_number(CG(active_op_array)); //记录循环起始点
  48. opline = get_next_op(CG(active_op_array) TSRMLS_CC);
  49. opline->opcode = ZEND_FE_FETCH;
  50. opline->result.op_type = IS_VAR;
  51. opline->result.u.var = get_temporary_variable(CG(active_op_array));
  52. opline->op1 = dummy_opline.result; //被操作数组
  53. opline->extended_value = 0;
  54. SET_UNUSED(opline->op2);
  55. opline = get_next_op(CG(active_op_array) TSRMLS_CC);
  56. opline->opcode = ZEND_OP_DATA; //当使用key的时候附属操作数,当foreach中不包含key时忽略
  57. SET_UNUSED(opline->op1);
  58. SET_UNUSED(opline->op2);
  59. SET_UNUSED(opline->result);
  60. }
  61. void zend_do_foreach_cont(znode *foreach_token, const znode *open_brackets_token, const znode *as_token, znode *value, znode *key TSRMLS_DC)
  62. {
  63. zend_op *opline;
  64. znode dummy, value_node;
  65. zend_bool assign_by_ref=0;
  66. opline = &CG(active_op_array)->opcodes[as_token->u.opline_num]; //获取FE_FETCH Opline
  67. if (key->op_type != IS_UNUSED) {
  68. znode *tmp;//交换key和val
  69. tmp = key;
  70. key = value;
  71. value = tmp;
  72. opline->extended_value |= ZEND_FE_FETCH_WITH_KEY; //表明需要同时获取key和val
  73. }
  74. if ((key->op_type != IS_UNUSED) && (key->u.EA.type & ZEND_PARSED_REFERENCE_VARIABLE)) {
  75. //key不能以引用方式获取
  76. zend_error(E_COMPILE_ERROR, "Key element cannot be a reference");
  77. }
  78. if (value->u.EA.type & ZEND_PARSED_REFERENCE_VARIABLE) {
  79. //以引用方式获取值
  80. assign_by_ref = 1;
  81. if (!(opline-1)->extended_value) {
  82. //根据FE_FETCH的上一条Opline也就是获取数组的扩展值来判断数组是否是匿名数组
  83. zend_error(E_COMPILE_ERROR, "Cannot create references to elements of a temporary array expression");
  84. }
  85. opline->extended_value |= ZEND_FE_FETCH_BYREF; //指明按引用取
  86. CG(active_op_array)->opcodes[foreach_token->u.opline_num].extended_value |= ZEND_FE_RESET_REFERENCE; //重置原数组
  87. } else {
  88. zend_op *foreach_copy;
  89. zend_op *fetch = &CG(active_op_array)->opcodes[foreach_token->u.opline_num];
  90. zend_op *end = &CG(active_op_array)->opcodes[open_brackets_token->u.opline_num];
  91. /* Change "write context" into "read context" */
  92. fetch->extended_value = 0; /* reset ZEND_FE_RESET_VARIABLE */
  93. while (fetch != end) {
  94. --fetch;
  95. if (fetch->opcode == ZEND_FETCH_DIM_W && fetch->op2.op_type == IS_UNUSED) {
  96. zend_error(E_COMPILE_ERROR, "Cannot use [] for reading");
  97. }
  98. fetch->opcode -= 3; /* FETCH_W -> FETCH_R */
  99. }
  100. /* prevent double SWITCH_FREE */
  101. zend_stack_top(&CG(foreach_copy_stack), (void **) &foreach_copy);
  102. foreach_copy->op1.op_type = IS_UNUSED;
  103. }
  104. value_node = opline->result;
  105. if (assign_by_ref) {
  106. zend_do_end_variable_parse(value, BP_VAR_W, 0 TSRMLS_CC); //获取值(引用)
  107. zend_do_assign_ref(NULL, value, &value_node TSRMLS_CC);//指明value node的type是IS_VAR
  108. } else {
  109. zend_do_assign(&dummy, value, &value_node TSRMLS_CC); //获取copy值
  110. zend_do_free(&dummy TSRMLS_CC);
  111. }
  112. if (key->op_type != IS_UNUSED) {
  113. znode key_node;
  114. opline = &CG(active_op_array)->opcodes[as_token->u.opline_num+1];
  115. opline->result.op_type = IS_TMP_VAR;
  116. opline->result.u.EA.type = 0;
  117. opline->result.u.opline_num = get_temporary_variable(CG(active_op_array));
  118. key_node = opline->result;
  119. zend_do_assign(&dummy, key, &key_node TSRMLS_CC);
  120. zend_do_free(&dummy TSRMLS_CC);
  121. }
  122. do_begin_loop(TSRMLS_C);
  123. INC_BPC(CG(active_op_array));
  124. }
  125. void zend_do_foreach_end(znode *foreach_token, znode *as_token TSRMLS_DC)
  126. {
  127. zend_op *container_ptr;
  128. zend_op *opline = get_next_op(CG(active_op_array) TSRMLS_CC); //生成JMP opcode
  129. opline->opcode = ZEND_JMP;
  130. opline->op1.u.opline_num = as_token->u.opline_num; //设置JMP到FE_FETCH opline行
  131. SET_UNUSED(opline->op1);
  132. SET_UNUSED(opline->op2);
  133. CG(active_op_array)->opcodes[foreach_token->u.opline_num].op2.u.opline_num = get_next_op_number(CG(active_op_array)); //设置跳出循环的opline行
  134. CG(active_op_array)->opcodes[as_token->u.opline_num].op2.u.opline_num = get_next_op_number(CG(active_op_array)); //同上
  135. do_end_loop(as_token->u.opline_num, 1 TSRMLS_CC); //为循环嵌套而设置
  136. zend_stack_top(&CG(foreach_copy_stack), (void **) &container_ptr);
  137. generate_free_foreach_copy(container_ptr TSRMLS_CC);
  138. zend_stack_del_top(&CG(foreach_copy_stack));
  139. DEC_BPC(CG(active_op_array)); //为PHP interactive模式而设置
  140. }

同时还要注意的是,foreach在使用中是值还是传引用的问题。

php 中遍历一个array时可以使用for或foreach,foreach的语法为:foreach ($arr as $k => $v)。遍历数组,把index赋给$k,数组的值赋给$v,那么此处的赋值是传值还是传引用呢。先看下面的例子:

  1. $arr = array(
  2. array('id' => 1, 'name' => 'name1'),
  3. array('id' => 2, 'name' => 'name2'),
  4. );
  5. foreach ($arr as $obj) {
  6. $obj['id'] = $obj['id'];
  7. $obj['name'] = $obj['name'] . '-modify';
  8. }
  9. print_r($arr); //输出的结果
  10. Array(
  11. [0] => Array (
  12. [id] => 1
  13. [name] => name1
  14. )
  15. [1] => Array(
  16. [id] => 2
  17. [name] => name2
  18. )
  19. )

观察可以发现在foreach循环中对$arr操作并没有影响到$arr的元素,所以这里的赋值是传值而不是传引用。那如果需要修改$arr中元素的值该怎么办呢?可以在变量前面加一个”&”符号,例如:

  1. foreach ($arr as &$obj) {
  2. $obj['id'] = $obj['id'];
  3. $obj['name'] = $obj['name'] . '-modify';
  4. }

再看另外一个例子,array里面存放的是object

  1. $arr = array(
  2. (object)(array('id' => 1, 'name' => 'name1')),
  3. (object)(array('id' => 2, 'name' => 'name2')),
  4. );
  5. foreach ($arr as $obj) {
  6. $obj->name = $obj->name . '-modify';
  7. }
  8. print_r($arr); //输出的结果
  9. Array
  10. (
  11. [0] => stdClass Object
  12. (
  13. [id] => 1
  14. [name] => name1-modify
  15. )
  16. [1] => stdClass Object
  17. (
  18. [id] => 2
  19. [name] => name2-modify
  20. )
  21. )

此时可以看到原始数组中的object对象已经修改了,所以这里的赋值又是传引用而不是传值。

综合上述,得出的结论:如果数组里面存放的是普通类型的元素就是采用传值的方式,存放对象类型元素采用的方式为传地址。