-
Notifications
You must be signed in to change notification settings - Fork 108
Expand file tree
/
Copy pathgenerators.xml
More file actions
560 lines (486 loc) · 14.2 KB
/
generators.xml
File metadata and controls
560 lines (486 loc) · 14.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 08e58ace7e5b538c8ed75d784a54885d5f785d30 Maintainer: 虾米 Status: ready -->
<!-- CREDITS: Luffy, mowangjuanzi -->
<chapter xml:id="language.generators" xmlns="http://docbook.org/ns/docbook">
<title>生成器</title>
<sect1 xml:id="language.generators.overview">
<title>生成器总览</title>
<?phpdoc print-version-for="generators"?>
<para>
生成器提供了一种更容易的方法来实现简单的<link
linkend="language.oop5.iterations">对象迭代</link>，相比较定义类实现
<classname>Iterator</classname> 接口的方式，性能开销和复杂性大大降低。
</para>
<para>
生成器提供了方便的方式来向 &foreach; 循环提供数据，而无需提前在内存中构建数组，这可能会导致程序超出内存限制或需要相当长的处理时间来生成。相反，可以使用生成器函数，与普通的
<link linkend="functions.user-defined">function</link> 相同，不同之处在于生成器不是 <link linkend="functions.returning-values">return</link>
一次，而是可以根据需要多次 &yield; 以提供要迭代的值。与迭代器一样，无法进行随机数据访问。
</para>
<para>
一个简单的例子就是使用生成器来重新实现 <function>range</function>
函数。 标准的 <function>range</function>
函数需要在内存中生成一个数组包含每一个在它范围内的值，然后返回该数组, 结果就是会产生多个很大的数组。 比如，调用
<command>range(0, 1000000)</command> 将导致内存占用超过 100 MB。
</para>
<para>
做为一种替代方法, 我们可以实现一个 <literal>xrange()</literal>
生成器, 只需要足够的内存来创建
<classname>Iterator</classname> 对象并在内部跟踪生成器的当前状态，这样只需要不到1K字节的内存。
</para>
<example>
<title>将 <function>range</function> 实现为生成器</title>
<programlisting role="php">
<![CDATA[
<?php
function xrange($start, $limit, $step = 1) {
if ($start <= $limit) {
if ($step <= 0) {
throw new LogicException('Step must be positive');
}
for ($i = $start; $i <= $limit; $i += $step) {
yield $i;
}
} else {
if ($step >= 0) {
throw new LogicException('Step must be negative');
}
for ($i = $start; $i >= $limit; $i += $step) {
yield $i;
}
}
}
/*
* 注意下面range()和xrange()输出的结果是一样的。
*/
echo 'Single digit odd numbers from range(): ';
foreach (range(1, 9, 2) as $number) {
echo "$number ";
}
echo "\n";
echo 'Single digit odd numbers from xrange(): ';
foreach (xrange(1, 9, 2) as $number) {
echo "$number ";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Single digit odd numbers from range(): 1 3 5 7 9
Single digit odd numbers from xrange(): 1 3 5 7 9
]]>
</screen>
</example>
<sect2 xml:id="language.generators.object">
<title><classname>Generator</classname> 对象</title>
<para>
调用生成器函数时会返回一个内部的 <classname>Generator</classname> 类的对象。
该对象实现了 <classname>Iterator</classname> 接口，基本上和仅向前的迭代器一样，
它提供的方法可以操控生成器的状态，包括发送值、返回值。
</para>
</sect2>
</sect1>
<sect1 xml:id="language.generators.syntax">
<title>生成器语法</title>
<para>
生成器函数看起来像普通函数——不同的是普通函数返回一个值，而生成器可以 &yield; 生成多个想要的值。
任何包含 &yield; 的函数都是一个生成器函数。
</para>
<para>
当一个生成器被调用的时候，它返回一个可以被遍历的对象.当你遍历这个对象的时候(例如通过一个&foreach;循环)，PHP 将会在每次需要值的时候调用对象的遍历方法，并在产生一个值之后保存生成器的状态，这样它就可以在需要产生下一个值的时候恢复调用状态。
</para>
<para>
一旦不再需要产生更多的值，生成器可以简单返回，而调用生成器的代码还可以继续执行，就像一个数组已经被遍历完了。
</para>
<note>
<para>
生成器能够返回多个值，通过 <methodname>Generator::getReturn</methodname> 可以获取到。
</para>
</note>
<sect2 xml:id="control-structures.yield">
<title><command>yield</command> 关键字</title>
<para>
生成器函数的核心是<command>yield</command>关键字。它最简单的调用形式看起来像一个return申明，不同之处在于普通return会返回值并终止函数的执行，而yield会返回一个值给循环调用此生成器的代码并且只是暂停执行生成器函数。
</para>
<example>
<title>一个简单的生成值的例子</title>
<programlisting role="php">
<![CDATA[
<?php
function gen_one_to_three() {
for ($i = 1; $i <= 3; $i++) {
//注意变量$i的值在不同的yield之间是保持传递的。
yield $i;
}
}
$generator = gen_one_to_three();
foreach ($generator as $value) {
echo "$value\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
1
2
3
]]>
</screen>
</example>
<note>
<para>
在内部会为生成的值配对连续的整型索引，就像一个非关联的数组。
</para>
</note>
<sect3 xml:id="control-structures.yield.associative">
<title>指定键名来生成值</title>
<para>
PHP的数组支持关联键值对数组，生成器也一样支持。所以除了生成简单的值，你也可以在生成值的时候指定键名。
</para>
<para>
如下所示，生成一个键值对与定义一个关联数组十分相似。
</para>
<example>
<title>生成一个键值对</title>
<programlisting role="php">
<![CDATA[
<?php
/*
* 下面每一行是用分号分割的字段组合，第一个字段将被用作键名。
*/
$input = <<<'EOF'
1;PHP;Likes dollar signs
2;Python;Likes whitespace
3;Ruby;Likes blocks
EOF;
function input_parser($input) {
foreach (explode("\n", $input) as $line) {
$fields = explode(';', $line);
$id = array_shift($fields);
yield $id => $fields;
}
}
foreach (input_parser($input) as $id => $fields) {
echo "$id:\n";
echo " $fields[0]\n";
echo " $fields[1]\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
1:
PHP
Likes dollar signs
2:
Python
Likes whitespace
3:
Ruby
Likes blocks
]]>
</screen>
</example>
</sect3>
<sect3 xml:id="control-structures.yield.null">
<title>生成 null 值</title>
<para>
Yield 可以在没有参数传入的情况下被调用来生成一个 &null; 值并配对一个自动的键名。
</para>
<example>
<title>生成&null;s</title>
<programlisting role="php">
<![CDATA[
<?php
function gen_three_nulls() {
foreach (range(1, 3) as $i) {
yield;
}
}
var_dump(iterator_to_array(gen_three_nulls()));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(3) {
[0]=>
NULL
[1]=>
NULL
[2]=>
NULL
}
]]>
</screen>
</example>
</sect3>
<sect3 xml:id="control-structures.yield.references">
<title>使用引用来生成值</title>
<para>
生成函数可以像使用值一样来使用引用生成。这个和<link linkend="functions.returning-values">从函数返回一个引用</link>一样：通过在函数名前面加一个引用符号。
</para>
<example>
<title>使用引用来生成值</title>
<programlisting role="php">
<![CDATA[
<?php
function &gen_reference() {
$value = 3;
while ($value > 0) {
yield $value;
}
}
/*
* 我们可以在循环中修改 $number 的值，而生成器是使用的引用值来生成，所以 gen_reference() 内部的 $value 值也会跟着变化。
*/
foreach (gen_reference() as &$number) {
echo (--$number).'... ';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
2... 1... 0...
]]>
</screen>
</example>
</sect3>
<sect3 xml:id="control-structures.yield.from">
<title>可用的 <command>yield from</command> 生成器委托</title>
<para>
生成器委托允许使用 <command>yield from</command> 关键字从另外一个生成器、
<classname>Traversable</classname> 对象、<type>array</type> 通过生成值。
外部生成器将从内部生成器、object、array 中生成所有的值，直到它们不再有效，
之后将在外部生成器中继续执行。
</para>
<para>
如果生成器与 <command>yield from</command> 一起使用，那么
<command>yield from</command> 表达式将返回内部生成器返回的任何值。
</para>
<caution>
<title>存储到 array （例如使用 <function>iterator_to_array</function>）</title>
<para>
<command>yield from</command> 不能重置 key。它保留 <classname>Traversable</classname>
对象或者 <type>array</type> 返回的 key。因此，某些值可能会与其他的 <command>yield</command> 或者
<command>yield from</command> 共享公共的 key，因此，在插入数组时将会用这个 key 覆盖以前的值。
</para>
<para>
一个非常重要的常见情况是 <function>iterator_to_array</function> 默认返回带 key 的 array ，
这可能会造成无法预料的结果。 <function>iterator_to_array</function> 还有第二个参数
<parameter>preserve_keys</parameter> ，可以设置为 &false; 来收集 <classname>Generator</classname>
返回的不带 key 的所有值。
</para>
<example>
<title>使用 <function>iterator_to_array</function> 的 <command>yield from</command> </title>
<programlisting role="php">
<![CDATA[
<?php
function inner() {
yield 1; // key 0
yield 2; // key 1
yield 3; // key 2
}
function gen() {
yield 0; // key 0
yield from inner(); // keys 0-2
yield 4; // key 1
}
// 传递 false 作为第二个参数获得数组 [0, 1, 2, 3, 4]
var_dump(iterator_to_array(gen()));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(3) {
[0]=>
int(1)
[1]=>
int(4)
[2]=>
int(3)
}
]]>
</screen>
</example>
</caution>
<example>
<title><command>yield from</command> 的基本用法</title>
<programlisting role="php">
<![CDATA[
<?php
function count_to_ten() {
yield 1;
yield 2;
yield from [3, 4];
yield from new ArrayIterator([5, 6]);
yield from seven_eight();
yield 9;
yield 10;
}
function seven_eight() {
yield 7;
yield from eight();
}
function eight() {
yield 8;
}
foreach (count_to_ten() as $num) {
echo "$num ";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
1 2 3 4 5 6 7 8 9 10
]]>
</screen>
</example>
<example>
<title><command>yield from</command> 并返回多个值</title>
<programlisting role="php">
<![CDATA[
<?php
function count_to_ten() {
yield 1;
yield 2;
yield from [3, 4];
yield from new ArrayIterator([5, 6]);
yield from seven_eight();
return yield from nine_ten();
}
function seven_eight() {
yield 7;
yield from eight();
}
function eight() {
yield 8;
}
function nine_ten() {
yield 9;
return 10;
}
$gen = count_to_ten();
foreach ($gen as $num) {
echo "$num ";
}
echo $gen->getReturn();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
1 2 3 4 5 6 7 8 9 10
]]>
</screen>
</example>
</sect3>
</sect2>
</sect1>
<sect1 xml:id="language.generators.comparison">
<title>生成器与 <classname>Iterator</classname> 对象的比较</title>
<para>
生成器最主要的优点是简洁。和实现一个 <classname>Iterator</classname> 类相较而言，
同样的功能，用生成器可以编写更少的代码，可读性也更强。
举例，下面的类和函数是相等的：
</para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
function getLinesFromFile($fileName) {
if (!$fileHandle = fopen($fileName, 'r')) {
return;
}
while (false !== $line = fgets($fileHandle)) {
yield $line;
}
fclose($fileHandle);
}
// 比较下...
class LineIterator implements Iterator {
protected $fileHandle;
protected $line;
protected $i;
public function __construct($fileName) {
if (!$this->fileHandle = fopen($fileName, 'r')) {
throw new RuntimeException('Couldn\'t open file "' . $fileName . '"');
}
}
public function rewind() {
fseek($this->fileHandle, 0);
$this->line = fgets($this->fileHandle);
$this->i = 0;
}
public function valid() {
return false !== $this->line;
}
public function current() {
return $this->line;
}
public function key() {
return $this->i;
}
public function next() {
if (false !== $this->line) {
$this->line = fgets($this->fileHandle);
$this->i++;
}
}
public function __destruct() {
fclose($this->fileHandle);
}
}
?>
]]>
</programlisting>
</informalexample>
<para>
不过，这也付出了灵活性的代价：
生成器是一个只能向前的迭代器，一旦开始遍历就无法后退。
意思也就是说，同样的生成器无法遍历多次：要么再次调用生成器函数，重新生成后再遍历。
</para>
<simplesect role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="language.oop5.iterations">遍历对象</link></member>
</simplelist>
</para>
</simplesect>
</sect1>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->