kiri-core/kiri-engine/NoSql/Redis.php

<?php
/**
 * Created by PhpStorm.
 * User: whwyy
 * Date: 2018/4/27 0027
 * Time: 11:00
 */
declare(strict_types=1);

namespace Kiri\NoSql;

use Kiri;
use Kiri\Exception\RedisConnectException;
use Kiri\Pool\Pool;
use function config;

/**
 * Class NoSql
 * @package Kiri\Cache
 * @mixin \Redis
 */
class Redis
{

    public string $host      = '';
    public int    $port      = 6379;
    public string $prefix    = '';
    public string $auth      = '';
    public int    $databases = 0;
    public int    $timeout   = 30;


    /**
     * @var int
     */
    public int $read_timeout = -1;

    /**
     * @var array|int[]
     */
    public array $pool = ['min' => 1, 'max' => 100];


    /**
     * 初始化
     */
    public function __construct()
    {
        Kiri::configure($this, config('redis', []));
    }

    /**
     * @return void
     * @throws
     */
    public function init(): void
    {
    }


    /**
     * @param $name
     * @param $arguments
     * @return mixed
     * @throws
     */
    public function __call($name, $arguments): mixed
    {
        if (method_exists($this, $name)) {
            return $this->{$name}(...$arguments);
        } else {
            return $this->proxy($name, $arguments);
        }
    }


    /**
     * @param $key
     * @param int $timeout
     * @return bool
     * @throws
     */
    public function waite($key, int $timeout = 5): bool
    {
        $time = time();
        while (!$this->setNx($key, '1')) {
            if (time() - $time >= $timeout) {
                return FALSE;
            }
            usleep(1000);
        }
        $this->expire($key, $timeout);
        return TRUE;
    }


    /**
     * @param $key
     * @param int $timeout
     * @return bool|int
     * @throws
     */
    public function lock($key, int $timeout = 5): bool|int
    {
        $script = <<<SCRIPT
            local _nx = redis.call('setnx',KEYS[1], ARGV[1])
            if (_nx ~= 0) then
            	redis.call('expire',KEYS[1], ARGV[1])
            	return 1
            end
            return 0
            SCRIPT;
        return $this->eval($script, ['{lock}:' . $key, $timeout], 1);
    }


    /**
     * @param $key
     * @return int
     * @throws
     */
    public function unlock($key): int
    {
        return $this->del('{lock}:' . $key);
    }


    /**
     * @return void
     * @throws
     */
    public function destroy(): void
    {
        $this->pool()->close($this->getName());
    }


    /**
     * 代理 Redis 方法调用，内置健康检查和连接回收
     * 如果连接 ping 失败则关闭连接并移除，不归还池中防止污染
     * @param $name
     * @param $arguments
     * @return mixed
     * @throws
     */
    public function proxy($name, $arguments): mixed
    {
        $client = $this->getClient();
        try {
            return $client->{$name}(...$arguments);
        } catch (\Throwable $throwable) {
			return $this->getLogger()->json_log($throwable, [], false);
        } finally {
            if ($client->ping('h') == 'h') {
                $this->pool()->push($this->getName(), $client);
            } else {
				$client->close();
				$this->pool()->abandon($this->getName());
            }
        }
    }


	/**
	 * @return Kiri\Error\StdoutLogger
	 */
	protected function getLogger(): Kiri\Error\StdoutLogger
	{
		return Kiri::getLogger();
	}


    /**
     * @return \Redis
     * @throws
     */
    private function getClient(): \Redis
    {
        return $this->pool()->get($this->getName());
    }


    /**
     * @return Pool
     * @throws
     */
    protected function pool(): Pool
    {
        $pool = Kiri::getPool();
        if (!$pool->hasChannel($this->getName())) {
            $pool->created($this->getName(), $this->pool['max'], [$this, 'connect']);
        }
        return $pool;
    }


    /**
     * @return string
     */
    private function getName(): string
    {
        return 'redis.' . $this->host;
    }


    /**
     * @return \Redis
     * @throws
     */
    protected function connect(): \Redis
    {
        $redis = new \Redis();
        if (!$redis->connect($this->host, $this->port, $this->timeout)) {
            throw new RedisConnectException(sprintf('The NoSql Connect %s::%d Fail.', $this->host, $this->port));
        }
        if (!empty($this->auth) && !$redis->auth($this->auth)) {
            throw new RedisConnectException(sprintf('NoSql Error: %s, Host %s, Auth %s', $redis->getLastError(), $this->host, $this->auth));
        }
        $redis->select($this->databases);
        if ($this->read_timeout > 0) {
            $redis->setOption(\Redis::OPT_READ_TIMEOUT, $this->read_timeout);
        }
        if (!empty($this->prefix)) {
            $redis->setOption(\Redis::OPT_PREFIX, $this->prefix);
        }
        return $redis;
    }
}