Connector.php 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | ThinkPHP [ WE CAN DO IT JUST THINK IT ]
  4. // +----------------------------------------------------------------------
  5. // | Copyright (c) 2006-2016 http://thinkphp.cn All rights reserved.
  6. // +----------------------------------------------------------------------
  7. // | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
  8. // +----------------------------------------------------------------------
  9. // | Author: yunwuxin <448901948@qq.com>
  10. // +----------------------------------------------------------------------
  11. namespace think\queue;
  12. use DateTimeInterface;
  13. use InvalidArgumentException;
  14. use think\App;
  15. abstract class Connector
  16. {
  17. /** @var App */
  18. protected $app;
  19. /**
  20. * The connector name for the queue.
  21. *
  22. * @var string
  23. */
  24. protected $connection;
  25. protected $options = [];
  26. abstract public function size($queue = null);
  27. abstract public function push($job, $data = '', $queue = null);
  28. public function pushOn($queue, $job, $data = '')
  29. {
  30. return $this->push($job, $data, $queue);
  31. }
  32. abstract public function pushRaw($payload, $queue = null, array $options = []);
  33. abstract public function later($delay, $job, $data = '', $queue = null);
  34. public function laterOn($queue, $delay, $job, $data = '')
  35. {
  36. return $this->later($delay, $job, $data, $queue);
  37. }
  38. public function bulk($jobs, $data = '', $queue = null)
  39. {
  40. foreach ((array) $jobs as $job) {
  41. $this->push($job, $data, $queue);
  42. }
  43. }
  44. abstract public function pop($queue = null);
  45. protected function createPayload($job, $data = '')
  46. {
  47. $payload = $this->createPayloadArray($job, $data);
  48. $payload = json_encode($payload);
  49. if (JSON_ERROR_NONE !== json_last_error()) {
  50. throw new InvalidArgumentException('Unable to create payload: ' . json_last_error_msg());
  51. }
  52. return $payload;
  53. }
  54. protected function createPayloadArray($job, $data = '')
  55. {
  56. return is_object($job)
  57. ? $this->createObjectPayload($job)
  58. : $this->createPlainPayload($job, $data);
  59. }
  60. protected function createPlainPayload($job, $data)
  61. {
  62. return [
  63. 'job' => $job,
  64. 'maxTries' => null,
  65. 'timeout' => null,
  66. 'data' => $data,
  67. ];
  68. }
  69. protected function createObjectPayload($job)
  70. {
  71. return [
  72. 'job' => 'think\queue\CallQueuedHandler@call',
  73. 'maxTries' => $job->tries ?? null,
  74. 'timeout' => $job->timeout ?? null,
  75. 'timeoutAt' => $this->getJobExpiration($job),
  76. 'data' => [
  77. 'commandName' => get_class($job),
  78. 'command' => serialize(clone $job),
  79. ],
  80. ];
  81. }
  82. public function getJobExpiration($job)
  83. {
  84. if (!method_exists($job, 'retryUntil') && !isset($job->timeoutAt)) {
  85. return;
  86. }
  87. $expiration = $job->timeoutAt ?? $job->retryUntil();
  88. return $expiration instanceof DateTimeInterface
  89. ? $expiration->getTimestamp() : $expiration;
  90. }
  91. protected function setMeta($payload, $key, $value)
  92. {
  93. $payload = json_decode($payload, true);
  94. $payload[$key] = $value;
  95. $payload = json_encode($payload);
  96. if (JSON_ERROR_NONE !== json_last_error()) {
  97. throw new InvalidArgumentException('Unable to create payload: ' . json_last_error_msg());
  98. }
  99. return $payload;
  100. }
  101. public function setApp(App $app)
  102. {
  103. $this->app = $app;
  104. return $this;
  105. }
  106. /**
  107. * Get the connector name for the queue.
  108. *
  109. * @return string
  110. */
  111. public function getConnection()
  112. {
  113. return $this->connection;
  114. }
  115. /**
  116. * Set the connector name for the queue.
  117. *
  118. * @param string $name
  119. * @return $this
  120. */
  121. public function setConnection($name)
  122. {
  123. $this->connection = $name;
  124. return $this;
  125. }
  126. }