PhpRedisConnector.php 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. <?php
  2. namespace Illuminate\Redis\Connectors;
  3. use Illuminate\Contracts\Redis\Connector;
  4. use Illuminate\Redis\Connections\PhpRedisClusterConnection;
  5. use Illuminate\Redis\Connections\PhpRedisConnection;
  6. use Illuminate\Support\Arr;
  7. use Illuminate\Support\Facades\Redis as RedisFacade;
  8. use Illuminate\Support\Str;
  9. use LogicException;
  10. use Redis;
  11. use RedisCluster;
  12. class PhpRedisConnector implements Connector
  13. {
  14. /**
  15. * Create a new connection.
  16. *
  17. * @param array $config
  18. * @param array $options
  19. * @return \Illuminate\Redis\Connections\PhpRedisConnection
  20. */
  21. public function connect(array $config, array $options)
  22. {
  23. $formattedOptions = Arr::pull($config, 'options', []);
  24. if (isset($config['prefix'])) {
  25. $formattedOptions['prefix'] = $config['prefix'];
  26. }
  27. $connector = function () use ($config, $options, $formattedOptions) {
  28. return $this->createClient(array_merge(
  29. $config, $options, $formattedOptions
  30. ));
  31. };
  32. return new PhpRedisConnection($connector(), $connector, $config);
  33. }
  34. /**
  35. * Create a new clustered PhpRedis connection.
  36. *
  37. * @param array $config
  38. * @param array $clusterOptions
  39. * @param array $options
  40. * @return \Illuminate\Redis\Connections\PhpRedisClusterConnection
  41. */
  42. public function connectToCluster(array $config, array $clusterOptions, array $options)
  43. {
  44. $options = array_merge($options, $clusterOptions, Arr::pull($config, 'options', []));
  45. return new PhpRedisClusterConnection($this->createRedisClusterInstance(
  46. array_map([$this, 'buildClusterConnectionString'], $config), $options
  47. ));
  48. }
  49. /**
  50. * Build a single cluster seed string from an array.
  51. *
  52. * @param array $server
  53. * @return string
  54. */
  55. protected function buildClusterConnectionString(array $server)
  56. {
  57. return $this->formatHost($server).':'.$server['port'];
  58. }
  59. /**
  60. * Create the Redis client instance.
  61. *
  62. * @param array $config
  63. * @return \Redis
  64. *
  65. * @throws \LogicException
  66. */
  67. protected function createClient(array $config)
  68. {
  69. return tap(new Redis, function ($client) use ($config) {
  70. if ($client instanceof RedisFacade) {
  71. throw new LogicException(
  72. extension_loaded('redis')
  73. ? 'Please remove or rename the Redis facade alias in your "app" configuration file in order to avoid collision with the PHP Redis extension.'
  74. : 'Please make sure the PHP Redis extension is installed and enabled.'
  75. );
  76. }
  77. $this->establishConnection($client, $config);
  78. if (! empty($config['password'])) {
  79. if (isset($config['username']) && $config['username'] !== '' && is_string($config['password'])) {
  80. $client->auth([$config['username'], $config['password']]);
  81. } else {
  82. $client->auth($config['password']);
  83. }
  84. }
  85. if (isset($config['database'])) {
  86. $client->select((int) $config['database']);
  87. }
  88. if (! empty($config['prefix'])) {
  89. $client->setOption(Redis::OPT_PREFIX, $config['prefix']);
  90. }
  91. if (! empty($config['read_timeout'])) {
  92. $client->setOption(Redis::OPT_READ_TIMEOUT, $config['read_timeout']);
  93. }
  94. if (! empty($config['scan'])) {
  95. $client->setOption(Redis::OPT_SCAN, $config['scan']);
  96. }
  97. if (! empty($config['name'])) {
  98. $client->client('SETNAME', $config['name']);
  99. }
  100. if (array_key_exists('serializer', $config)) {
  101. $client->setOption(Redis::OPT_SERIALIZER, $config['serializer']);
  102. }
  103. if (array_key_exists('compression', $config)) {
  104. $client->setOption(Redis::OPT_COMPRESSION, $config['compression']);
  105. }
  106. if (array_key_exists('compression_level', $config)) {
  107. $client->setOption(Redis::OPT_COMPRESSION_LEVEL, $config['compression_level']);
  108. }
  109. });
  110. }
  111. /**
  112. * Establish a connection with the Redis host.
  113. *
  114. * @param \Redis $client
  115. * @param array $config
  116. * @return void
  117. */
  118. protected function establishConnection($client, array $config)
  119. {
  120. $persistent = $config['persistent'] ?? false;
  121. $parameters = [
  122. $this->formatHost($config),
  123. $config['port'],
  124. Arr::get($config, 'timeout', 0.0),
  125. $persistent ? Arr::get($config, 'persistent_id', null) : null,
  126. Arr::get($config, 'retry_interval', 0),
  127. ];
  128. if (version_compare(phpversion('redis'), '3.1.3', '>=')) {
  129. $parameters[] = Arr::get($config, 'read_timeout', 0.0);
  130. }
  131. if (version_compare(phpversion('redis'), '5.3.0', '>=') && ! is_null($context = Arr::get($config, 'context'))) {
  132. $parameters[] = $context;
  133. }
  134. $client->{$persistent ? 'pconnect' : 'connect'}(...$parameters);
  135. }
  136. /**
  137. * Create a new redis cluster instance.
  138. *
  139. * @param array $servers
  140. * @param array $options
  141. * @return \RedisCluster
  142. */
  143. protected function createRedisClusterInstance(array $servers, array $options)
  144. {
  145. $parameters = [
  146. null,
  147. array_values($servers),
  148. $options['timeout'] ?? 0,
  149. $options['read_timeout'] ?? 0,
  150. isset($options['persistent']) && $options['persistent'],
  151. ];
  152. if (version_compare(phpversion('redis'), '4.3.0', '>=')) {
  153. $parameters[] = $options['password'] ?? null;
  154. }
  155. if (version_compare(phpversion('redis'), '5.3.2', '>=') && ! is_null($context = Arr::get($options, 'context'))) {
  156. $parameters[] = $context;
  157. }
  158. return tap(new RedisCluster(...$parameters), function ($client) use ($options) {
  159. if (! empty($options['prefix'])) {
  160. $client->setOption(Redis::OPT_PREFIX, $options['prefix']);
  161. }
  162. if (! empty($options['scan'])) {
  163. $client->setOption(Redis::OPT_SCAN, $options['scan']);
  164. }
  165. if (! empty($options['failover'])) {
  166. $client->setOption(RedisCluster::OPT_SLAVE_FAILOVER, $options['failover']);
  167. }
  168. if (array_key_exists('serializer', $options)) {
  169. $client->setOption(Redis::OPT_SERIALIZER, $options['serializer']);
  170. }
  171. if (array_key_exists('compression', $options)) {
  172. $client->setOption(Redis::OPT_COMPRESSION, $options['compression']);
  173. }
  174. if (array_key_exists('compression_level', $options)) {
  175. $client->setOption(Redis::OPT_COMPRESSION_LEVEL, $options['compression_level']);
  176. }
  177. });
  178. }
  179. /**
  180. * Format the host using the scheme if available.
  181. *
  182. * @param array $options
  183. * @return string
  184. */
  185. protected function formatHost(array $options)
  186. {
  187. if (isset($options['scheme'])) {
  188. return Str::start($options['host'], "{$options['scheme']}://");
  189. }
  190. return $options['host'];
  191. }
  192. }