Redis
webman/redis добавляет функциональность пула соединений на основе illuminate/redis, поддерживает как корутину, так и некорутинную среду, используется так же, как и в laravel.
Перед использованием illuminate/redis
необходимо установить расширение redis для php-cli
.
Внимание
Настоящая инструкция предназначена для версии webman v2. Если вы используете версию webman v1, пожалуйста, посмотрите руководство для версии v1
Этот компонент требует установки расширения redis. Используйте командуphp -m | grep redis
, чтобы проверить, установлено ли расширение redis дляphp-cli
.
Установка
composer require -W webman/redis illuminate/events
После установки необходимо перезапустить (reload неэффективен)
Настройка
Конфигурационный файл redis находится в config/redis.php
return [
'default' => [
'host' => '127.0.0.1',
'password' => null,
'port' => 6379,
'database' => 0,
'pool' => [ // Конфигурация пула соединений
'max_connections' => 10, // Максимальное количество соединений в пуле
'min_connections' => 1, // Минимальное количество соединений в пуле
'wait_timeout' => 3, // Максимальное время ожидания получения соединения из пула
'idle_timeout' => 50, // Время простоя соединения в пуле, после которого оно будет закрыто, до тех пор, пока количество соединений не станет равным min_connections
'heartbeat_interval' => 50, // Интервал проверки соединений (heartbeat), не должен превышать 60 секунд
],
]
];
О пуле соединений
- У каждого процесса есть свой пул соединений, пулы между процессами не совместно используются.
- При отсутствии корутин, задачи выполняются в порядке очереди внутри процесса, поэтому в пуле будет не более 1 соединения.
- При включенных корутинах задачи выполняются параллельно внутри процесса, пул соединений будет динамически регулировать количество соединений, не превышая
max_connections
и не опускаясь нижеmin_connections
. - Поскольку максимальное количество соединений пула составляет
max_connections
, когда количество корутин, работающих с Redis, превышаетmax_connections
, некоторые корутины будут ожидать в очереди, максимумwait_timeout
секунд. Если превышено, будет вызвано исключение. - В случае простоя (включая корутинные и некорутинные среды), соединения будут возвращены обратно в пул по истечении времени
idle_timeout
, пока количество соединений не станет равнымmin_connections
(min_connections
может быть равен 0).
Пример
<?php
namespace app\controller;
use support\Request;
use support\Redis;
class UserController
{
public function db(Request $request)
{
$key = 'test_key';
Redis::set($key, rand());
return response(Redis::get($key));
}
}
Интерфейсы Redis
Redis::append($key, $value)
Redis::bitCount($key)
Redis::decr($key, $value)
Redis::decrBy($key, $value)
Redis::get($key)
Redis::getBit($key, $offset)
Redis::getRange($key, $start, $end)
Redis::getSet($key, $value)
Redis::incr($key, $value)
Redis::incrBy($key, $value)
Redis::incrByFloat($key, $value)
Redis::mGet(array $keys)
Redis::getMultiple(array $keys)
Redis::mSet($pairs)
Redis::mSetNx($pairs)
Redis::set($key, $value, $expireResolution = null, $expireTTL = null, $flag = null)
Redis::setBit($key, $offset, $value)
Redis::setEx($key, $ttl, $value)
Redis::pSetEx($key, $ttl, $value)
Redis::setNx($key, $value)
Redis::setRange($key, $offset, $value)
Redis::strLen($key)
Redis::del(...$keys)
Redis::exists(...$keys)
Redis::expire($key, $ttl)
Redis::expireAt($key, $timestamp)
Redis::select($dbIndex)
Эквивалентно
$redis = Redis::connection('default');
$redis->append($key, $value)
$redis->bitCount($key)
$redis->decr($key, $value)
$redis->decrBy($key, $value)
$redis->get($key)
$redis->getBit($key, $offset)
...
Внимание
Будьте осторожны с использованием интерфейсаRedis::select($db)
, так как webman является фреймворком с постоянным пребыванием в памяти; если один запрос используетRedis::select($db)
для переключения базы данных, это повлияет на последующие запросы. Для работы с несколькими базами данных рекомендуется настраивать различные$db
в отдельных конфигурациях подключения Redis.
Использование нескольких соединений Redis
Например, файл конфигурации config/redis.php
return [
'default' => [
'host' => '127.0.0.1',
'password' => null,
'port' => 6379,
'database' => 0,
],
'cache' => [
'host' => '127.0.0.1',
'password' => null,
'port' => 6379,
'database' => 1,
],
]
По умолчанию используется подключение, конфигурируемое в default
, вы можете использовать метод Redis::connection()
, чтобы выбрать, какое соединение redis использовать.
$redis = Redis::connection('cache');
$redis->get('test_key');
Конфигурация кластера
Если ваше приложение использует кластер серверов Redis, вы должны использовать ключ clusters в файле конфигурации Redis для определения этих кластеров:
return [
'clusters' => [
'default' => [
[
'host' => 'localhost',
'password' => null,
'port' => 6379,
'database' => 0,
],
],
],
];
По умолчанию, кластер может реализовать клиентское шардирование на узлах, позволяя вам создавать пула узлов и создавать большое количество доступной памяти. Обратите внимание, что клиентское разделение не обрабатывает ситуации сбоя; следовательно, эта функция предназначена в основном для кеширования данных, полученных от другой главной базы данных. Если вы хотите использовать нативный кластер Redis, необходимо ввести следующее указание в разделе options конфигурационного файла:
return[
'options' => [
'cluster' => 'redis',
],
'clusters' => [
// ...
],
];
Команды конвейера
Когда вам нужно отправить серверу множество команд одним действием, рекомендуется использовать команды конвейера. Метод pipeline принимает замыкание с экземпляром Redis. Вы можете отправить все команды на экземпляр Redis, и они будут выполнены в одном действии:
Redis::pipeline(function ($pipe) {
for ($i = 0; $i < 1000; $i++) {
$pipe->set("key:$i", $i);
}
});