Генераторы в PHP. Зачем нужны генераторы? Экономим память с помощью генераторов

При вождении автомобиля – скорость это далеко не все. Но в WEB все решает скорость. Чем быстрее ваше приложение, тем лучше пользовательский опыт. Хорошо, эта статья о генераторах в PHP, так почему же мы говорим о скорости? Как вы увидите вскоре, генераторы привносят большие изменения по части скорости и потреблении памяти приложением.

Что такое PHP генераторы?

Добавленные в PHP в версии 5.5 , генераторы представляют собой функции, обеспечивающие простой механизм для циклической обработки данных, без необходимости создавать массив данных в памяти. Все еще не понимаете о чем речь? Тогда давайте посмотрим на PHP генераторы в действии.

Создаем файл generator_test.php со следующим содержанием:

$array = ;
for($i = 0; $i < $max; $i++) {
$array = $i;
}
return $array;
}

Foreach (getRange(15) as $range) {
echo "Данные {$range}
";
}

Затем в папке где у нас лежит этот файл открываем консоль и пишем следующее

Http://localhost:8000/generator_test.php

Результат будет такой:

Данные 1
Данные 2
….
Данные 15

Код выше достаточно прост. Однако, давайте сделаем небольшое изменение в нем:

echo "Данные {$range}
";
}

Теперь диапазон генерируемых чисел находится в пределах от 0 до константы PHP_INT_MAX, которая представляет собой наибольшее целое число, которое способен представить интерпретатор PHP . После этого опять идем в браузер и обновляем страницу. Однако на этот раз, вместо обычного текста получаем сообщение о том, что превышен объем доступной памяти, вследствие чего работа скрипта была аварийно завершена.

Что за досада – у PHP закончилась память! Первое что приходит на ум – это редактировать настройку memory_limit в php.ini . Но давайте спросим себя – действительно ли это так эффективно? Неужели мы хотим, чтобы какой-то единственный скрипт занимал всю доступную память?

Используем генераторы

Давайте напишем ту же самую функцию, что и выше, вызовем ее с тем же значением PHP_INT_MAX и запустим снова. Но в этот раз мы создадим функцию-генератор .

Function getRange($max = 10) {
for($i = 1; $i < $max; $i++) {
yield $i;
}
}

Foreach (getRange(PHP_INT_MAX) as $range) {
echo "Данные {$range}
";
}

Определяя функцию getRange на этот раз, мы всего лишь проходим по значениям и генерируем вывод. Ключевое слово yield похоже на инструкцию return тем, что возвращает значение из функции, но единственное отличие заключается в том, что yield возвращает значение только тогда, когда это необходимо и не пытается вместить весь массив данных в память за один раз. Перейдя к браузеру, вы должны увидеть данные, отображаемые на странице. Обратите внимание на тот факт, что генераторы в PHP могут быть использованы только лишь из функции .

Зачем нужны генераторы?

Время от времени возникают такие задачи, когда нам необходимо обработать большие объемы данных (например, файлы логов), выполнить вычисления на больших выборках из базы и т.д. И мы отнюдь не хотим, чтобы эти операции занимали всю доступную память, так мы должны стараться сохранять память насколько это возможно. Данные не обязательно должны быть большими – PHP генераторы эффективны вне зависимости от размера данных. И не забывайте, что наша цель – сделать приложение быстрым и при этом таким, чтобы оно потребляло как можно меньше памяти.

Возврат ключей

Бывают случаи, когда нам необходимо возвращать не просто значение, а пару ключ-значение. При использовании генераторов, мы можем генерировать пары ключ-значение следующим образом.

Function getRange($max = 10) {
for($i = 0; $i < $max; $i++) {
$value = $i * mt_rand();
yield $i => $value;
}
}
?>

Использовать данную функцию мы можем также как и простой массив:

Foreach (getRange(PHP_INT_MAX) as $key => $value) {
echo "Ключ {$key} имеет значение {$value}";
}

Отсылка значений генераторам

Генераторы также могут принимать значения. Под этим подразумевается, что генераторы позволяют нам вставлять значения, которое может представлять собой подобие команды или еще что-то. Например, мы можем отправить значение в наш генератор, которое сигнализирует о необходимости остановки исполнения или изменения выходных данных. Далее пример кода:

Function getRange($max = 10) {
for($i = 1; $i < $max; $i++) {
$inject = yield $i;
if($inject === "stop") return;
}
}

$generator = getRange(PHP_INT_MAX);

Foreach($generator as $range) {
if($range === 10000) {
// посылаем сообщение генератору
$generator -> send("stop");
}
print "Значение {$range}
";
}

Отмечу, что использование инструкции return в функции-генераторе приведет к немедленному выходу из этой функции.

В заключении отмечу, что генераторы предлагают значительное улучшение производительности, которое мы не можем игнорировать. Большую часть времени нам не нужно иметь мощные сервера для выполнения нашего кода - нам просто необходимо сделать небольшой рефакторинг. И генераторы очень полезный инструмент, который мы должны использовать более часто, при этом, не злоупотребляя им.

Кстати, о генераторах я подробно рассказываю в моем курсе . Там есть и примеры и задания, которые помогут лучше усвоить материал.

В этой статье мы будем изучать генераторы, которые обеспечивают простой способ реализовать простые итераторы без накладных расходов и сложности интерфейса Итератора.

Как работают генераторы?

Согласно Википедии, генератор "очень похожа на функцию, которая возвращает массив, в котором генератор имеет параметры, можно назвать и генерировать последовательность значений" . Генератор в основном похож на функцию, но вместо возвращения значения она дает столько значений, сколько это необходимо. Это подобно функции, но он действует как итератор.

Генераторы используют ключевое слово yield вместо return . Он действует аналогично для возврата, она возвращает значение вызвавшей функции, но вместо того, чтобы удалить функцию из стека, yield сохраняет его состояние. Эта функция позволяет продолжить с места, где она была, когда его вызывают снова. Фактически, нельзя возвращать значение генератора хотя вы можете использовать без возврата значения, чтобы прекратить его выполнение.

Руководство по PHP гласит: "Когда функция генератора вызывается, она возвращает объект, который может перемещаться." Это объект внутреннего класса генератора и реализует интерфейс итератора таким же образом. Перебирая этого объекта, PHP называет генератор каждый раз, когда ему требуется значение. Это состояние сохраняется только тогда, когда требуется следующее значение.

Вывод вышеуказонного кода будет:

Генератор начался

Приводится 0

Приводится 1

Приводится 2

Приводится 3

Приводится 4

Генератор закончился

Наш первый генератор

Генераторы не новая концепция, и уже существуют в таких языках, как 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"): .............

Давайте перезапишем генератор Python -а в PHP . (Отметим, что оба фрагмента не выполняют никакого вида ошибочной проверки.)

Функция генератора открывает файл а затем считает каждую строку файла, когда это требуется. Каждый раз, когда генератор вызывается, она продолжает от того места, откуда она была прервана. Она не начинается с самого начала, так как его состояние было сохранено, когда подтверждение действия выполнилось. После того как все линии были прочитаны, генератор просто отключается, и цикл заканчивается.

Возвращение ключей

PHP iterators состоят из пар ключевого/значения. В нашем примере, только значение было возвращаемым и поэтому ключи были числовыми (числовые ключи бывают по умолчанию). Если вы желаете вернуть ассоциативную пару, просто измените yield для включения ключа, используя синтаксис массива.

$line; ... } foreach (file_lines("somefile") as $key => $line) { ............. } ?>

Введение значения

yield не только возвращать значения, он также может получать значения из вне. Это делается путем вызова метода send() генератора объект со значением, если вы хотите передать и значение. Затем это значение может использоваться в вычислениях или делать другие вещи.

send("stop"); } echo "{$v}n"; } ?>

Вывод будет следующим:

Сохранение памяти с помощью генераторов

Генераторы удобны, расчета больших наборов, и если вы в то же время не хотите выделить память для всех результатов, или когда вы не знаете, вам нужны будут все результаты. Из-за способа обработки результатов, объем памяти может быть сведена к минимуму путем выделения памяти только для текущего результата.

Представьте себе функцию file() , которая возвращает все строки файла в виде массива. Управляя простой точкой отсчета(масштабом) для file() и наш демонстрационный пример функции file_lines() , каждый использующий те же самые случайные 100 текстовых файлов параграфа, используя Lipsum , показали, что функция file() использовала до 110 раз больше памяти, чем генератор.

С внедрением Генераторов, PHP поставил мощный инструмент в руках разработчиков. Теперь мы можем написать итераторы быстро, в процессе экономя много памяти. С помощью этого урока, я надеюсь, что вы получили достаточно, чтобы начать использовать их самостоятельно в ваших проектах.

А теперь берем уже готовую функцию генерации пароля и пишем скрипт для восстановления или создания нового пароля для пользователей вашего сайта.

Скрипт восстановления пароля

Как обычно пишется скрипт?

Как всегда составляется поэтапная схема, что мы должны сделать по шагам. Все происходит в одном файле, reminder.php

1. Запускаем скрипт, только при наличии определенной переменной, например $action;

2. Для запуска процесса генерации пароля, пользователь указывает email адрес $_POST[`ema‘l`]; Для упрощения кода присвоим данное значение переменной $email.

3. Проверяем при помощи регулярных выражений все символы на то, чтобы пользователь правильно указал адрес емайл. Если нет, выводим ошибку, прекращаем работу скрипта. Если все правильно, идем дальше.

4. Ищем в базе данных, в нашем случае в таблице users пользователя с таким почтовым адресом. Если нет, выдаем ошибку, что такого адреса в базе нет, и прекращаем работу скрипта.

5. Пользователь с таким адресом в базе есть, идем дальше и запускаем функцию генерации нового пароля. Также по адресу емайл получаем из базы уникальный id пользователя и пишем в переменную $id;

Если вы что-нибудь слышали об итераторах, тогда вы, скорее всего, знаете, что итерация - очень важная концепция для мира программирования, но имплементация необходимых интерфейсов для создания объектов-итераторов может быть весьма хлопотным занятием из-за большого количества шаблонного кода, который необходимо написать для работы итератора. Но с релизом PHP 5.5 к нам наконец-то пришли генераторы!

В этой статье я рассмотрю генераторы, которые позволяют без больших усилий имплементировать функциональность простых итераторов без необходимости тянуть за собой всю сложность интерфейса Iterator .

Как работают генераторы?

Согласно Википедии генератор “очень похож на функцию, которая возвращает массив, так как генератор имеет входные параметры, его можно вызвать и он генерирует последовательность значений”. В общих чертах генератор - это обычная функция, но вместо возврата одного значения она выдает столько значений, сколько от нее может потребоваться. Генератор выглядит как функция, но ведет себя как итератор.

В генераторах используется ключевое слово yield вместо слова return . Оно ведет себя похожим образом, и возвращает значение в точку вызова, с тем отличием, что функция не удаляется из стека, а ее состояние сохраняется в памяти. Это позволяет функции продолжить работу с предыдущего состояния при следующем ее вызове. На самом деле, вы не можете использовать ключевое слово return для возврата значения из генератора, а для того, чтобы прекратить выполнение генератора.

Руководство PHP гласит: “Когда вызывается генератор, он возвращает объект, который может быть проитерирован”. Он является объектом внутреннего класса Generator , который имплементирует интерфейс Iterator , и ведет себя, как однонаправленный итератор. Пока вы проводите итерацию над объектом, PHP вызывает генератор каждый раз, когда ему нужно получить значение. Состояние сохраняется каждый раз, как генератор выдает значение, так что в следующий раз, когда PHP затребует значение, генератор восстановит свое предыдущее состояние.

Данный код выведет следующее:

The generator has started Yielded 0 Yielded 1 Yielded 2 Yielded 3 Yielded 4 The generator has ended

Наш первый генератор

Генераторы - не новый концепт, они уже есть в таких языках, как C#, Python, JavaScript и Ruby (счетчики), их обычно можно определить по использованию ключевого слова yield . Данный код - пример на языке Python:

Давайте перепишем образец генератора Python на языке PHP. (заметьте, что оба куска кода не заботятся о проверках ошибок).

Функция-генератор открывает файл и выдает каждую линию файла, если ее затребовали. Каждый раз при вызове генератора он продолжает работу с предыдущего состояния. Работа функции не начинается сначала, так как его состояние было сохранено перед выполнением оператора yield. Как только все строки были перебраны - генератор завершает свою работу, завершается и цикл.

Возврат ключей

Итераторы в PHP состоят из пар “ключ/значение”. В нашем примере мы возвращаем только значение, а ключи в этом случае будут числовыми (ключи по-умолчанию числовые). Если вам необходимо вернуть ассоциативные пары - просто измените формат оператора yield так, чтобы он включал и ключ, используя синтаксис массивов.

Внедрение значений

Оператор yield не только возвращает значения - он может также принимать значения извне. Это делается путем вызова метода send() у объекта генератора с передачей необходимого значения в виде параметра. Это значение может быть использовано в вычислениях или других операциях. Метод передает значение в генератор как результат выполнения yield, и возобновляет выполнение.

send("stop"); } echo "{$v}n"; }

Вывод будет следующим:

Экономим память с помощью генераторов

Генераторы хороши тогда, когда вы обрабатываете большие наборы данных, и вы не хотите выделять память под все промежуточные результаты, или если вы не знаете, понадобятся вам все эти результаты вообще. Из-за способа обработки результатов использование памяти можно уменьшить до необходимого минимума для хранения только текущего результата работы.

Представьте результат работы функции file() , которая возвращает все строки читаемого файла в виде массива. Если сравнить результаты работы функции file() и нашей функции file_lines() над одним и тем же файлом со 100 случайными параграфами текста, то функция file() будет использовать примерно в 110 раз больше памяти, чем генератор.

Заключение

С введением генераторов PHP дает мощный инструмент в руки разработчикам. Теперь мы можем быстро писать итераторы, при этом сохраняя значительные объемы памяти во время работы приложения. Надеюсь, в этом руководстве я смог дать вам достаточно информации для того, чтобы вы могли начать использовать генераторы в ваших проектах.