Redis

webman/redis ได้เพิ่มฟังก์ชันการเชื่อมต่อในรูปแบบของ Pool บนพื้นฐานของ illuminate/redis รองรับทั้งสภาพแวดล้อม Coroutines และ Non-coroutine โดยมีวิธีการใช้งานที่เหมือนกับ laravel

ก่อนที่จะใช้ illuminate/redis จะต้องติดตั้ง Redis extension สำหรับ php-cli ก่อน

注意
คู่มือนี้เป็นเวอร์ชัน webman v2 ถ้าคุณใช้งานเวอร์ชัน webman v1 กรุณาดู คู่มือเวอร์ชัน v1
คอมโพเนนต์นี้ต้องติดตั้ง Redis extension โดยใช้คำสั่ง php -m | grep redis เพื่อตรวจสอบว่า php-cli ติดตั้ง Redis extension แล้วหรือไม่

การติดตั้ง

composer require -W webman/redis illuminate/events

หลังจากติดตั้งแล้วจำเป็นต้อง restart (reload ไม่มีผล)

การตั้งค่า

ไฟล์การตั้งค่า Redis อยู่ที่ config/redis.php

return [
    'default' => [
        'host'     => '127.0.0.1',
        'password' => null,
        'port'     => 6379,
        'database' => 0,
        'pool' => [ // การตั้งค่าทางเชื่อมต่อ Pool
            'max_connections' => 10,     // จำนวนการเชื่อมต่อสูงสุดใน Pool
            'min_connections' => 1,      // จำนวนการเชื่อมต่อขั้นต่ำใน Pool
            'wait_timeout' => 3,         // เวลารอสูงสุดในการรับการเชื่อมต่อจาก Pool
            'idle_timeout' => 50,        // เวลาหยุดทำงานที่เชื่อมต่อใน Pool จะถูกคืนค่าหลังจากนั้น เมื่อจำนวนการเชื่อมต่อถึง `min_connections`
            'heartbeat_interval' => 50,  // ช่วงเวลาการตรวจสอบสุขภาพ ไม่ควรเกิน 60 วินาที
        ],
    ]
];

เกี่ยวกับการเชื่อมต่อ Pool

• แต่ละกระบวนการมี Pool การเชื่อมต่อของตนเอง โดยไม่แชร์ Pool การเชื่อมต่อกันระหว่างกระบวนการ
• เมื่อไม่เปิดใช้ Coroutines ธุรกิจจะถูกดำเนินการตามลำดับในกระบวนการเดียว จะไม่มีการเกิด Concurrent ดังนั้น Pool การเชื่อมต่อจะมีเพียง 1 การเชื่อมต่อเท่านั้น
• เมื่อเปิดใช้ Coroutines ธุรกิจจะดำเนินการได้พร้อมกันในกระบวนการเดียว และ Pool การเชื่อมต่อจะปรับจำนวนการเชื่อมต่อแบบไดนามิกตามความต้องการ โดยไม่เกิน max_connections และไม่ต่ำกว่า min_connections
• เนื่องจากจำนวนการเชื่อมต่อใน Pool สูงสุดเป็น max_connections หากจำนวน Coroutines ที่ทำงานกับ Redis มากกว่า max_connections จะมี Coroutines ที่ต้องรอ โดยจะรอสูงสุด wait_timeout วินาที หากรอนานกว่านั้นจะเกิดข้อผิดพลาด
• ในกรณีที่ไม่มีการใช้งาน (ทั้งในสภาพแวดล้อม Coroutine และ Non-coroutine) การเชื่อมต่อจะถูกคืนค่าหลังจาก 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 API

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) API อย่างระมัดระวัง เนื่องจาก webman เป็น Framework ที่อยู่ในหน่วยความจำ หากคำขอใดคำขอหนึ่งใช้ 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');

การตั้งค่า Cluster

ถ้าแอปพลิเคชันของคุณใช้ Redis Cluster คุณควรใช้คีย์ clusters ในไฟล์การตั้งค่า Redis เพื่อตั้งค่าคลัสเตอร์เหล่านี้:

return [
    'clusters' => [
        'default' => [
            [
                'host'     => 'localhost',
                'password' => null,
                'port'     => 6379,
                'database' => 0,
            ],
        ],
    ],

];

โดยค่าเริ่มต้น คลัสเตอร์สามารถแบ่งพาร์ติชันของลูกค้าได้บนโหนด ทำให้คุณสามารถสร้างพูลโหนดและสร้างหน่วยความจำที่ใช้ได้จำนวนมาก ต้องระวังว่า การแชร์ของลูกค้าไม่จัดการสถานการณ์ที่ล้มเหลว ดังนั้น ฟังก์ชันนี้เหมาะสำหรับการจัดการข้อมูลแคชที่ได้รับจากฐานข้อมูลหลัก หากต้องการใช้ Redis Cluster ดั้งเดิม คุณต้องระบุในคีย์ options ดังนี้:

return[
    'options' => [
        'cluster' => 'redis',
    ],

    'clusters' => [
        // ...
    ],
];

คำสั่ง Pipeline

เมื่อคุณต้องการส่งคำสั่งหลายคำสั่งไปยังเซิร์ฟเวอร์ในหนึ่งการดำเนินการ ขอแนะนำให้ใช้คำสั่ง Pipeline วิธี pipeline จะรับ Closure ของ Redis instance คุณสามารถส่งคำสั่งทั้งหมดไปยัง Redis instance ซึ่งจะถูกดำเนินการในหนึ่งการดำเนินการ:

Redis::pipeline(function ($pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", $i);
    }
});