diff --git a/library/think/cache/driver/Redisd.php b/library/think/cache/driver/Redisd.php new file mode 100644 index 00000000..4512187d --- /dev/null +++ b/library/think/cache/driver/Redisd.php @@ -0,0 +1,329 @@ + +// +---------------------------------------------------------------------- + +namespace think\cache\driver; + +use think\Cache; +use think\Exception; +use think\Log; + +/** + 配置参数: + 'cache' => [ + 'type' => 'Redisd' + 'host' => 'A:6379,B:6379', //redis服务器ip，多台用逗号隔开；读写分离开启时，默认写A，当A主挂时，再尝试写B + 'slave' => 'B:6379,C:6379', //redis服务器ip，多台用逗号隔开；读写分离开启时，所有IP随机读，其中一台挂时，尝试读其它节点，可以配置权重 + 'port' => 6379, //默认的端口号 + 'password' => '', //AUTH认证密码，当redis服务直接暴露在外网时推荐 + 'timeout' => 10, //连接超时时间 + 'expire' => false, //默认过期时间，默认0为永不过期 + 'prefix' => '', //缓存前缀，不宜过长 + 'persistent' => false, //是否长连接 false=短连接，推荐长连接 + ], + + 单例获取: + $redis = \think\Cache::connect(Config::get('cache')); + $redis->master(true); + $redis->get('key'); + */ + +/** + * ThinkPHP Redis简单主从实现的高可用方案 + * + * 扩展依赖：https://github.com/phpredis/phpredis + * + * 一主一从的实践经验 + * 1, A、B为主从，正常情况下，A写，B读，通过异步同步到B（或者双写，性能有损失） + * 2, B挂，则读写均落到A + * 3, A挂，则尝试升级B为主，并断开主从尝试写入(要求开启slave-read-only no) + * 4, 手工恢复A，并加入B的从 + * + * 优化建议 + * 1，key不宜过长，value过大时请自行压缩 + * 2，gzcompress在php7下有兼容问题 + * + * @todo + * 1, 增加对redisCluster的兼容 + * 2, 增加tp5下的单元测试 + * + * @author 尘缘 <130775@qq.com> + */ +class Redisd +{ + protected static $redis_rw_handler; + protected static $redis_err_pool; + + protected $options = [ + 'host' => '127.0.0.1', + 'slave' => '', + 'port' => 6379, + 'password' => '', + 'timeout' => 10, + 'expire' => false, + 'persistent' => false, + 'length' => 0, + 'prefix' => '', + ]; + + /** + * 为了在单次php请求中复用redis连接，第一次获取的options会被缓存，第二次使用不同的$options，将会无效 + * + * @param array $options 缓存参数 + * @access public + */ + public function __construct($options = []) + { + if (!extension_loaded('redis')) { + throw new Exception('_NOT_SUPPERT_:redis'); + } + + $this->options = $options = array_merge($this->options, $options); + $this->options ['func'] = $options ['persistent'] ? 'pconnect' : 'connect'; + + $host = explode(",", trim($this->options ['host'], ",")); + $host = array_map("trim", $host); + $slave = explode(",", trim($this->options ['slave'], ",")); + $slave = array_map("trim", $slave); + + $this->options ["server_slave"] = empty($slave) ? $host : $slave; + $this->options ["servers"] = count($slave); + $this->options ["server_master"] = array_shift($host); + $this->options ["server_master_failover"] = $host; + } + + /** + * 主从选择器，配置多个Host则自动启用读写分离，默认主写，随机从读 + * 随机从读的场景适合读频繁，且php与redis从位于单机的架构，这样可以减少网络IO + * 一致Hash适合超高可用，跨网络读取，且从节点较多的情况，本业务不考虑该需求 + * + * @access public + * @param bool $master true 默认主写 + */ + public function master($master = false) + { + if (isset(self::$redis_rw_handler[$master])) { + return $this->handler = self::$redis_rw_handler[$master]; + } + + //如果不为主，则从配置的host剔除主，并随机读从，失败以后再随机选择从 + //另外一种方案是根据key的一致性hash选择不同的node，但读写频繁的业务中可能打开大量的文件句柄 + if(!$master && $this->options["servers"] > 1) { + shuffle($this->options["server_slave"]); + $host = array_shift($this->options["server_slave"]); + }else{ + $host = $this->options["server_master"]; + } + + $this->handler = new \Redis(); + $func = $this->options ['func']; + + $parse = parse_url($host); + $host = isset($parse['host']) ? $parse['host'] : $host; + $port = isset($parse['host']) ? $parse['port'] : $this->options ['port']; + + $this->handler->$func($host, $port, $this->options ['timeout']); + + if ($this->options ['password'] != null) { + $this->handler->auth($this->options ['password']); + } + + APP_DEBUG && Log::record("[ CACHE ] INIT Redisd : {$host}:{$port} master->" . var_export($master, true), 'info'); + + //发生错误则摘掉当前节点 + try { + $error = $this->handler->getLastError(); + } catch (\RedisException $e) { + //phpredis throws a RedisException object if it can't reach the Redis server. + //That can happen in case of connectivity issues, if the Redis service is down, or if the redis host is overloaded. + //In any other problematic case that does not involve an unreachable server + //(such as a key not existing, an invalid command, etc), phpredis will return FALSE. + + Log::record(sprintf("redisd->%s:%s:%s", $master ? "master" : "salve", $host, $e->getMessage()), Log::ALERT); + + //主节点挂了以后，尝试连接主备，断开主备的主从连接进行升主 + if($master) { + if(! count($this->options["server_master_failover"])) { + throw new Exception("redisd master: no more server_master_failover. {$host} : ".$e->getMessage()); + return false; + } + + $this->options["server_master"] = array_shift($this->options["server_master_failover"]); + $this->master(); + + Log::record(sprintf("master is down, try server_master_failover : %s", $this->options["server_master"]), Log::ERROR); + + //如果是slave，断开主从升主，需要手工同步新主的数据到旧主上 + //目前这块的逻辑未经过严格测试 + //$this->handler->slaveof(); + } else { + //尝试failover，如果有其它节点则进行其它节点的尝试 + foreach ($this->options["server_slave"] as $k=>$v) + { + if (trim($v) == trim($host)) + unset($this->options["server_slave"][$k]); + } + + //如果无可用节点，则抛出异常 + if(! count($this->options["server_slave"])) { + Log::record("已无可用Redis读节点", Log::ERROR); + throw new Exception("redisd slave: no more server_slave. {$host} : ".$e->getMessage()); + return false; + } else { + Log::record("salve {$host} is down, try another one.", Log::ALERT); + return $this->master(false); + } + } + } catch(\Exception $e) { + throw new Exception($e->getMessage(), $e->getCode()); + } + + self::$redis_rw_handler[$master] = $this->handler; + } + + /** + * 读取缓存 + * + * @access public + * @param string $name 缓存key + * @return mixed + */ + public function get($name) + { + Cache::$readTimes++; + + $this->master(false); + + try { + $value = $this->handler->get($this->options ['prefix'] . $name); + } catch (\RedisException $e) { + unset(self::$redis_rw_handler[0]); + $this->master(); + $this->get($name); + } catch (\Exception $e) { + Log::record($e->getMessage(), Log::ERROR); + } + + $jsonData = null; + //如果是对象则进行反转 + if (!empty($value) && false !== strpos("[{", $value[0])) { + $jsonData = $value ? json_decode($value, true) : $value; + } + + return ($jsonData === NULL) ? $value : $jsonData; + } + + /** + * 写入缓存 + * + * @access public + * @param string $name 缓存key + * @param mixed $value 缓存value + * @param integer $expire 过期时间，单位秒 + * @return boolen + */ + public function set($name, $value, $expire = null) + { + Cache::$writeTimes++; + + $this->master(true); + + if (is_null($expire )) { + $expire = $this->options ['expire']; + } + $name = $this->options ['prefix'] . $name; + + /** + * 兼容历史版本 + * Redis不支持存储对象，存入对象会转换成字符串 + * 但在这里，对所有数据做json_decode会有性能开销 + */ + $value = (is_object($value) || is_array($value )) ? json_encode($value) : $value; + + if ($value === null) { + return $this->handler->delete($this->options ['prefix'] . $name); + } + + // $expire < 0 则等于ttl操作，列为todo吧 + try { + if (is_int($expire) && $expire) { + $result = $this->handler->setex($name, $expire, $value); + } else { + $result = $this->handler->set($name, $value); + } + } catch (\RedisException $e) { + unset(self::$redis_rw_handler[1]); + $this->master(true); + $this->set($name, $value, $expire); + } catch (\Exception $e) { + Log::record($e->getMessage()); + } + + return $result; + } + + /** + * 返回句柄对象 + * 需要先执行 $redis->master() 连接到 DB + * + * @access public + * @return object + */ + function handler() + { + return $this->handler; + } + + /** + * 删除缓存 + * + * @access public + * @param string $name 缓存变量名 + * @return boolen + */ + public function rm($name) + { + Cache::$writeTimes++; + $this->master(true); + return $this->handler->delete($this->options ['prefix'] . $name); + } + + /** + * 清除缓存 + * + * @access public + * @return boolen + */ + public function clear() + { + Cache::$writeTimes++; + + $this->master(true); + return $this->handler->flushDB (); + } + + /** + * 析构释放连接 + * + * @access public + */ + public function __destruct() + { + //该方法仅在connect连接时有效 + //当使用pconnect时，连接会被重用，连接的生命周期是fpm进程的生命周期，而非一次php的执行。 + //如果代码中使用pconnect， close的作用仅是使当前php不能再进行redis请求，但无法真正关闭redis长连接，连接在后续请求中仍然会被重用，直至fpm进程生命周期结束。 + + try { + if(method_exists($this->handler, "close")) + $this->handler->close (); + } catch (\Exception $e) { + } + } +} \ No newline at end of file diff --git a/tests/thinkphp/library/think/cache/driver/redisdTest.php b/tests/thinkphp/library/think/cache/driver/redisdTest.php new file mode 100644 index 00000000..51692065 --- /dev/null +++ b/tests/thinkphp/library/think/cache/driver/redisdTest.php @@ -0,0 +1,59 @@ + +// +---------------------------------------------------------------------- + +/** + * Redisd缓存驱动测试 + * @author 尘缘 <130775@qq.com> + */ + +namespace tests\thinkphp\library\think\cache\driver; + +class redisdTest extends cacheTestCase +{ + private $_cacheInstance = null; + + protected function setUp() + { + if (!extension_loaded("redis")) { + $this->markTestSkipped("Redis没有安装，已跳过测试！"); + } + \think\Cache::connect(array('type' => 'redis', 'expire' => 2)); + } + + protected function getCacheInstance() + { + if (null === $this->_cacheInstance) { + $this->_cacheInstance = new \think\cache\driver\Redisd(['length' => 3]); + } + return $this->_cacheInstance; + } + + public function testGet() + { + $cache = $this->prepare(); + $this->assertEquals('string_test', $cache->get('string_test')); + $this->assertEquals(11, $cache->get('number_test')); + $result = $cache->get('array_test'); + $this->assertEquals('array_test', $result['array_test']); + } + + public function testStoreSpecialValues() + { + } + + public function testExpire() + { + } + + public function testQueue() + { + } +}