# swoole-redis

**Repository Path**: pipixia-pi/swoole-redis

## Basic Information

- **Project Name**: swoole-redis
- **Description**: 基于swoole redis协程连接池
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 44
- **Forks**: 14
- **Created**: 2019-01-07
- **Last Updated**: 2024-06-26

## Categories & Tags

**Categories**: cache-modules

**Tags**: None

## README

# swoole-redis
```
基于swoole的redis协程连接池，简单封装。  
实现多个协程间共用同一个协程客户端。

tip：
实现redis函数的基本提示（部分函数未实现）
```

# 版本
## v0.0.1
```
1、初完成

```
## v0.0.2
```
1、添加setDefer -> 设置是否返回结果(默认为true。部分操作，如果不需要返回返回结果，则可以设置为false)
2、使用go处理协程

```

## v0.0.3
```
1、添加setOptions配置（swoole官方timeout设置"超时时间, 默认为全局的协程socket_timeout(-1, 永不超时)"。在使用brPop函数时，发现好似并未生效，timeout的设置必须大于brPop超时，否则会出现"Resource temporarily unavailable"）
2、添加断线重连功能
3、添加instance()函数，如果有特殊需求扩展无法实现，又想共用连接池时，譬如事务处理，此时可以通过instance获取一个连接
4、添加put()函数，配合instance使用，使用完连接后，将连接put回连接池里
5、添加异常处理
```

# 引入
```
>composer require sethink/swoole-redis
```



# 入门例子
```php
<?php
namespace Demo;

include_once "./vendor/autoload.php";

use swoole;
use sethink\swooleRedis\CoRedis;
use sethink\swooleRedis\RedisPool;

class Demo
{
    protected $server;
    protected $RedisPool;

    public function __construct()
    {

        $this->server = new Swoole\Http\Server("0.0.0.0", 9501);
        $this->server->set(array(
            'worker_num'      => 4,
            'max_request'     => 50000,
            'reload_async'    => true,
            'max_wait_time'   => 30
        ));
        $this->server->on('Start', function ($server) {});
        $this->server->on('ManagerStart', function ($server) {});
        $this->server->on('WorkerStart', array($this, 'onWorkerStart'));
        $this->server->on('WorkerStop', function ($server, $worker_id) {});
        $this->server->on('open', function ($server, $request) {});
        $this->server->on('Request', array($this, 'onRequest'));
        $this->server->start();
    }

    public function onWorkerStart($server, $worker_id)
    {
        $config          = [
            'host'            => '127.0.0.1',
            'port'            => 6379,
            'auth'            => 'sethink',
            'poolMin'         => 5,   //空闲时，保存的最大链接，默认为5
            'poolMax'         => 1000,    //地址池最大连接数，默认1000
            'clearTime'       => 60000,   //清除空闲链接的定时器，默认60s
            'clearAll'        => 300000,  //空闲多久清空所有连接,默认300s
            'setDefer'        => true, //设置是否返回结果
            //options设置
            'connect_timeout' => 1, //连接超时时间，默认为1s
            'timeout'         => 1, //超时时间，默认为1s
            'serialize'       => false, //自动序列化，默认false
            'reconnect'       => 1  //自动连接尝试次数，默认为1次
        ];
        $this->RedisPool = new RedisPool($config);
        unset($config);
        
        //定时器，清除空闲连接
        $this->RedisPool->clearTimer($this->server);
    }

    public function onRequest($request, $response)
    {
        $rs1 = CoRedis::init($this->RedisPool)->set('sethink', 'sethink');
        var_dump($rs1);
        $rs2 = CoRedis::init($this->RedisPool)->get('sethink');
        var_dump($rs2);
    }
}

new Demo();

```

# 详解
## instance()
```
如果有特殊需求扩展无法实现，又想共用连接池时，譬如事务处理，此时可以通过instance获取一个连接
```

```php
<?php
go(function (){
    $redis = CoRedis::init($this->RedisPool)->instance();
    $rs = $redis->get('sethink');
    var_dump($rs);
});
```

## put($redis)
```
配合instance使用，使用完连接后，将连接put回连接池里。
$redis是连接池的连接
```

```php
<?php
go(function (){
    $redis = CoRedis::init($this->RedisPool)->instance();
    $rs = $redis->get('sethink');
    var_dump($rs);
    CoRedis::init($redis);
});
```


## setDefer($bool)
```
部分操作，如果不需要返回结果，则可以设置为false。

相对于$bool为true，执行后，由于主进程和协程间不需要再通信，可以立即往下执行程序
```

```php
<?php
//此操作不会返回结果
CoRedis::init($this->RedisPool)
    ->setDefer(false)
    ->set('sethink', 'sethink');
```