├── .gitignore ├── LICENSE ├── README.md ├── composer.json ├── src ├── Client.php └── Message.php └── tests ├── client_bpop_test.php ├── client_pop_test.php ├── client_push_test.php └── client_remove_test.php /.gitignore: -------------------------------------------------------------------------------- 1 | # phpstorm project files 2 | .idea 3 | 4 | # netbeans project files 5 | nbproject 6 | 7 | # zend studio for eclipse project files 8 | .buildpath 9 | .project 10 | .settings 11 | 12 | # windows thumbnail cache 13 | Thumbs.db 14 | 15 | # composer itself is not needed 16 | composer.phar 17 | /vendor 18 | composer.lock 19 | 20 | # Mac DS_Store Files 21 | .DS_Store 22 | 23 | # phpunit itself is not needed 24 | phpunit.phar 25 | # local phpunit config 26 | /phpunit.xml 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Delayer PHP 客户端 2 | 3 | 客户端使用非常简单，提供了 `push`、`pop`、`bPop`、`remove` 四个方法操作任务。 4 | 5 | ## 安装 6 | 7 | 通过 Composer 安装使用： 8 | 9 | ```shell 10 | composer require mix/delayer-client 11 | ``` 12 | 13 | ## Example 14 | 15 | ### `push` 方法 16 | 17 | 放入一个任务。 18 | 19 | ```php 20 | '127.0.0.1', 25 | 'port' => 6379, 26 | 'database' => 0, 27 | 'password' => '', 28 | ]; 29 | $client = new \Delayer\Client($config); 30 | // 任务数据，用户自己定义 31 | $data = [ 32 | 'orderID' => '2018101712578956648885474', 33 | 'action' => 'close', 34 | ]; 35 | $message = new \Delayer\Message([ 36 | // 任务ID，必须全局唯一 37 | 'id' => md5(uniqid(mt_rand(), true)), 38 | // 主题，取出任务时需使用 39 | 'topic' => 'close_order', 40 | // 必须转换为string类型 41 | 'body' => json_encode($data), 42 | ]); 43 | // 第2个参数为延迟时间，第3个参数为延迟到期后如果任务没有被消费的最大生存时间 44 | $ret = $client->push($message, 20, 604800); 45 | var_dump($ret); 46 | ``` 47 | 48 | ### `pop` 方法 49 | 50 | 取出一个到期的任务。 51 | 52 | ```php 53 | '127.0.0.1', 58 | 'port' => 6379, 59 | 'database' => 0, 60 | 'password' => '', 61 | ]; 62 | $client = new \Delayer\Client($config); 63 | $message = $client->pop('close_order'); 64 | // 没有任务时，返回false 65 | var_dump($message); 66 | var_dump($message->body); 67 | ``` 68 | 69 | ### `bPop` 方法 70 | 71 | 阻塞取出一个到期的任务。 72 | 73 | ```php 74 | '127.0.0.1', 79 | 'port' => 6379, 80 | 'database' => 0, 81 | 'password' => '', 82 | ]; 83 | $client = new \Delayer\Client($config); 84 | $message = $client->bPop('close_order', 10); 85 | // 没有任务时，返回false 86 | var_dump($message); 87 | var_dump($message->body); 88 | ``` 89 | 90 | ### `remove` 方法 91 | 92 | 移除一个未到期的任务。 93 | 94 | ```php 95 | '127.0.0.1', 100 | 'port' => 6379, 101 | 'database' => 0, 102 | 'password' => '', 103 | ]; 104 | $client = new \Delayer\Client($config); 105 | // push时定义的任务ID 106 | $id = '***'; 107 | $ret = $client->remove($id); 108 | var_dump($ret); 109 | ``` 110 | 111 | ## License 112 | 113 | Apache License Version 2.0, http://www.apache.org/licenses/ 114 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "mix/delayer-client", 3 | "description": "延迟队列中间件 Delayer 的 PHP 客户端", 4 | "type": "library", 5 | "keywords": [ 6 | "mix", 7 | "delayer", 8 | "client" 9 | ], 10 | "homepage": "https://github.com/mix-basic/delayer-client-php", 11 | "license": "Apache-2.0", 12 | "authors": [ 13 | { 14 | "name": "liu,jian", 15 | "email": "coder.keda@gmail.com" 16 | } 17 | ], 18 | "require": { 19 | "php": ">=5.4.0" 20 | }, 21 | "autoload": { 22 | "psr-4": { 23 | "Delayer\\": "src/" 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/Client.php: -------------------------------------------------------------------------------- 1 | $value) { 39 | $this->$name = $value; 40 | } 41 | // 实例化驱动 42 | $this->_driver = new \Redis(); 43 | // 连接 44 | $this->connect(); 45 | } 46 | 47 | /** 48 | * 连接 49 | * @throws \RedisException 50 | */ 51 | protected function connect() 52 | { 53 | if (!$this->_driver->connect($this->host, $this->port)) { 54 | throw new \RedisException("Redis connection failed, {$this->host}:{$this->port}."); 55 | } 56 | $this->_driver->auth($this->password); 57 | $this->_driver->select($this->database); 58 | } 59 | 60 | /** 61 | * 增加任务 62 | * @param Message $message 63 | * @param int $delayTime 64 | * @param int $maxLifetime 65 | */ 66 | public function push(Message $message, $delayTime, $readyMaxLifetime = 604800) 67 | { 68 | // 参数验证 69 | if (!$message->validate()) { 70 | throw new \InvalidArgumentException('Invalid message.'); 71 | } 72 | // 增加 73 | $this->_driver->multi(); 74 | $this->_driver->hMset(self::PREFIX_JOB_BUCKET . $message->id, ['topic' => $message->topic, 'body' => $message->body]); 75 | $this->_driver->expire(self::PREFIX_JOB_BUCKET . $message->id, $delayTime + $readyMaxLifetime); 76 | $this->_driver->zAdd(self::KEY_JOB_POOL, time() + $delayTime, $message->id); 77 | $ret = $this->_driver->exec(); 78 | foreach ($ret as $status) { 79 | if (!$status) { 80 | return false; 81 | } 82 | } 83 | return true; 84 | } 85 | 86 | /** 87 | * 取出任务 88 | * @param $topic 89 | * @return bool|Message 90 | */ 91 | public function pop($topic) 92 | { 93 | $id = $this->_driver->rPop(self::PREFIX_READY_QUEUE . $topic); 94 | if (empty($id)) { 95 | return false; 96 | } 97 | $data = $this->_driver->hGetAll(self::PREFIX_JOB_BUCKET . $id); 98 | if (!isset($data['topic']) || !isset($data['body'])) { 99 | return false; 100 | } 101 | $this->_driver->del(self::PREFIX_JOB_BUCKET . $id); 102 | return new Message([ 103 | 'id' => $id, 104 | 'topic' => $data['topic'], 105 | 'body' => $data['body'], 106 | ]); 107 | } 108 | 109 | /** 110 | * 阻塞取出任务 111 | * @param $topic 112 | * @param $timeout 113 | * @return bool|Message 114 | */ 115 | public function bPop($topic, $timeout) 116 | { 117 | $ret = $this->_driver->brPop([self::PREFIX_READY_QUEUE . $topic], $timeout); 118 | if (empty($ret)) { 119 | return false; 120 | } 121 | $id = array_pop($ret); 122 | $data = $this->_driver->hGetAll(self::PREFIX_JOB_BUCKET . $id); 123 | if (!isset($data['topic']) || !isset($data['body'])) { 124 | return false; 125 | } 126 | $this->_driver->del(self::PREFIX_JOB_BUCKET . $id); 127 | return new Message([ 128 | 'id' => $id, 129 | 'topic' => $data['topic'], 130 | 'body' => $data['body'], 131 | ]); 132 | } 133 | 134 | /** 135 | * 移除任务 136 | * @param $id 137 | * @return bool 138 | */ 139 | public function remove($id) 140 | { 141 | $this->_driver->multi(); 142 | $this->_driver->zRem(self::KEY_JOB_POOL, $id); 143 | $this->_driver->del(self::PREFIX_JOB_BUCKET . $id); 144 | $ret = $this->_driver->exec(); 145 | foreach ($ret as $status) { 146 | if (!$status) { 147 | return false; 148 | } 149 | } 150 | return true; 151 | } 152 | 153 | } 154 | -------------------------------------------------------------------------------- /src/Message.php: -------------------------------------------------------------------------------- 1 | $value) { 29 | $this->$name = $value; 30 | } 31 | } 32 | 33 | /** 34 | * 验证 35 | * @return bool 36 | */ 37 | public function validate() 38 | { 39 | foreach ($this as $attribute) { 40 | if (is_null($attribute) || $attribute === '') { 41 | return false; 42 | } 43 | } 44 | return true; 45 | } 46 | 47 | } 48 | -------------------------------------------------------------------------------- /tests/client_bpop_test.php: -------------------------------------------------------------------------------- 1 | '127.0.0.1', 7 | 'port' => 6379, 8 | 'database' => 0, 9 | 'password' => '', 10 | ]; 11 | $client = new \Delayer\Client($config); 12 | $message = $client->bPop('close_order', 10); 13 | var_dump($message); 14 | -------------------------------------------------------------------------------- /tests/client_pop_test.php: -------------------------------------------------------------------------------- 1 | '127.0.0.1', 7 | 'port' => 6379, 8 | 'database' => 0, 9 | 'password' => '', 10 | ]; 11 | $client = new \Delayer\Client($config); 12 | $message = $client->pop('close_order'); 13 | var_dump($message); 14 | -------------------------------------------------------------------------------- /tests/client_push_test.php: -------------------------------------------------------------------------------- 1 | '127.0.0.1', 7 | 'port' => 6379, 8 | 'database' => 0, 9 | 'password' => '', 10 | ]; 11 | $client = new \Delayer\Client($config); 12 | $data = [ 13 | 'orderID' => '2018101712578956648885474', 14 | 'action' => 'close', 15 | ]; 16 | $message = new \Delayer\Message([ 17 | 'id' => md5(uniqid(mt_rand(), true)), 18 | 'topic' => 'close_order', 19 | 'body' => json_encode($data), 20 | ]); 21 | $ret = $client->push($message, 20, 604800); 22 | var_dump($ret); 23 | -------------------------------------------------------------------------------- /tests/client_remove_test.php: -------------------------------------------------------------------------------- 1 | '127.0.0.1', 7 | 'port' => 6379, 8 | 'database' => 0, 9 | 'password' => '', 10 | ]; 11 | $client = new \Delayer\Client($config); 12 | $ret = $client->remove($argv[1]); 13 | var_dump($ret); 14 | --------------------------------------------------------------------------------