Генераторы в PHP
Если вы что-нибудь слышали об итераторах, тогда вы, скорее всего, знаете, что итерация - очень важная концепция для мира программирования, но имплементация необходимых интерфейсов для создания объектов-итераторов может быть весьма хлопотным занятием из-за большого количества шаблонного кода, который необходимо написать для работы итератора. Но с релизом PHP 5.5 к нам наконец-то пришли генераторы!
В этой статье я рассмотрю генераторы, которые позволяют без больших усилий имплементировать функциональность простых итераторов без необходимости тянуть за собой всю сложность интерфейса Iterator.
Как работают генераторы?
Согласно Википедии генератор “очень похож на функцию, которая возвращает массив, так как генератор имеет входные параметры, его можно вызвать и он генерирует последовательность значений”. В общих чертах генератор - это обычная функция, но вместо возврата одного значения она выдает столько значений, сколько от нее может потребоваться. Генератор выглядит как функция, но ведет себя как итератор.
В генераторах используется ключевое слово yield вместо слова return. Оно ведет себя похожим образом, и возвращает значение в точку вызова, с тем отличием, что функция не удаляется из стека, а ее состояние сохраняется в памяти. Это позволяет функции продолжить работу с предыдущего состояния при следующем ее вызове. На самом деле, вы не можете использовать ключевое слово return для возврата значения из генератора, а для того, чтобы прекратить выполнение генератора.
Руководство PHP гласит: “Когда вызывается генератор, он возвращает объект, который может быть проитерирован”. Он является объектом внутреннего класса Generator, который имплементирует интерфейс Iterator, и ведет себя, как однонаправленный итератор. Пока вы проводите итерацию над объектом, PHP вызывает генератор каждый раз, когда ему нужно получить значение. Состояние сохраняется каждый раз, как генератор выдает значение, так что в следующий раз, когда PHP затребует значение, генератор восстановит свое предыдущее состояние.
<?php
function nums() {
echo "The generator has startedn";
for ($i = 0; $i < 5; ++$i) {
yield $i;
echo "Yielded $i";
}
echo "The generator has endedn";
}
foreach (nums() as $v);
Данный код выведет следующее:
The generator has started Yielded 0 Yielded 1 Yielded 2 Yielded 3 Yielded 4 The generator has ended
Наш первый генератор
Генераторы - не новый концепт, они уже есть в таких языках, как C#, Python, JavaScript и Ruby (счетчики), их обычно можно определить по использованию ключевого слова yield. Данный код - пример на языке Python:
def file_lines(filename):
file = open(filename)
for line in file:
yield line
file.close()
for line in file_lines('somefile'):
#do some work here
Давайте перепишем образец генератора Python на языке PHP. (заметьте, что оба куска кода не заботятся о проверках ошибок).
<?php
function file_lines($filename) {
$file = fopen($filename, 'r');
while (($line = fgets($file)) !== false) {
yield $line;
}
fclose($file);
}
foreach (file_lines('somefile') as $line) {
// do some work here
}
Функция-генератор открывает файл и выдает каждую линию файла, если ее затребовали. Каждый раз при вызове генератора он продолжает работу с предыдущего состояния. Работа функции не начинается сначала, так как его состояние было сохранено перед выполнением оператора yield. Как только все строки были перебраны - генератор завершает свою работу, завершается и цикл.
Возврат ключей
Итераторы в PHP состоят из пар “ключ/значение”. В нашем примере мы возвращаем только значение, а ключи в этом случае будут числовыми (ключи по-умолчанию числовые). Если вам необходимо вернуть ассоциативные пары - просто измените формат оператора yield так, чтобы он включал и ключ, используя синтаксис массивов.
<?php
function file_lines($filename) {
...
yield $key => $line;
...
}
foreach (file_lines('somefile') as $key => $line) {
// do some work here
}
Внедрение значений
Оператор yield не только возвращает значения - он может также принимать значения извне. Это делается путем вызова метода send() у объекта генератора с передачей необходимого значения в виде параметра. Это значение может быть использовано в вычислениях или других операциях. Метод передает значение в генератор как результат выполнения yield, и возобновляет выполнение.
<?php
function nums() {
for ($i = 0; $i < 5; ++$i) {
// get a value from the caller
$cmd = (yield $i);
if ($cmd == 'stop') {
return; // exit the generator
}
}
}
$gen = nums();
foreach ($gen as $v) {
// we are satisfied
if ($v == 3) {
$gen->send('stop');
}
echo "{$v}n";
}
Вывод будет следующим:
0 1 2 3
Экономим память с помощью генераторов
Генераторы хороши тогда, когда вы обрабатываете большие наборы данных, и вы не хотите выделять память под все промежуточные результаты, или если вы не знаете, понадобятся вам все эти результаты вообще. Из-за способа обработки результатов использование памяти можно уменьшить до необходимого минимума для хранения только текущего результата работы.
Представьте результат работы функции file(), которая возвращает все строки читаемого файла в виде массива. Если сравнить результаты работы функции file() и нашей функции file_lines() над одним и тем же файлом со 100 случайными параграфами текста, то функция file() будет использовать примерно в 110 раз больше памяти, чем генератор.
<?php
// Test 1
$m = memory_get_peak_usage();
foreach (file_lines('lipsum.txt') as $l);
echo memory_get_peak_usage() - $m, "n"; //Выдает 7336
// Test 2
$m = memory_get_peak_usage();
foreach (file('lipsum.txt') as $l);
echo memory_get_peak_usage() - $m, "n"; // Выдает 148112
Заключение
С введением генераторов PHP дает мощный инструмент в руки разработчикам. Теперь мы можем быстро писать итераторы, при этом сохраняя значительные объемы памяти во время работы приложения. Надеюсь, в этом руководстве я смог дать вам достаточно информации для того, чтобы вы могли начать использовать генераторы в ваших проектах.