├── .gitignore ├── go.mod ├── delayer ├── message.go ├── example_client_test.go └── client.go ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/mix-basic/delayer-client-golang 2 | 3 | go 1.16 4 | 5 | require github.com/gomodule/redigo v2.0.0+incompatible 6 | -------------------------------------------------------------------------------- /delayer/message.go: -------------------------------------------------------------------------------- 1 | package delayer 2 | 3 | // 消息结构 4 | type Message struct { 5 | ID string 6 | Topic string 7 | Body string 8 | } 9 | 10 | // 效验 11 | func (p *Message) Valid() bool { 12 | if p.ID == "" || p.Topic == "" || p.Body == "" { 13 | return false 14 | } 15 | return true 16 | } 17 | -------------------------------------------------------------------------------- /delayer/example_client_test.go: -------------------------------------------------------------------------------- 1 | package delayer_test 2 | 3 | import ( 4 | "fmt" 5 | "delayer-client-golang/delayer" 6 | "crypto/md5" 7 | "time" 8 | "github.com/gomodule/redigo/redis" 9 | ) 10 | 11 | // 例子 12 | func Example() { 13 | // 通过连接信息创建客户端 14 | cli := delayer.Client{ 15 | Host: "127.0.0.1", 16 | Port: "6379", 17 | Database: 0, 18 | Password: "", 19 | } 20 | cli.Init() 21 | 22 | // 通过已有连接创建客户端 23 | pool := redis.Pool{} 24 | conn := pool.Get(); 25 | cli1 := delayer.Client{ 26 | Conn:conn, 27 | } 28 | cli1.Init() 29 | } 30 | 31 | // Push 例子 32 | func ExampleClient_Push() { 33 | cli := delayer.Client{ 34 | Host: "127.0.0.1", 35 | Port: "6379", 36 | Database: 0, 37 | Password: "", 38 | } 39 | cli.Init() 40 | msg := delayer.Message{ 41 | ID: fmt.Sprintf("%x", md5.Sum([]byte(time.Now().String()))), 42 | Topic: "test", 43 | Body: "test body", 44 | } 45 | reply, err := cli.Push(msg, 10, 600) 46 | fmt.Println(msg) 47 | fmt.Println(reply) 48 | fmt.Println(err) 49 | } 50 | 51 | // Pop 例子 52 | func ExampleClient_Pop() { 53 | cli := delayer.Client{ 54 | Host: "127.0.0.1", 55 | Port: "6379", 56 | Database: 0, 57 | Password: "", 58 | } 59 | cli.Init() 60 | msg, err := cli.Pop("test"); 61 | fmt.Println(msg) 62 | fmt.Println(err) 63 | } 64 | 65 | // BPop 例子 66 | func ExampleClient_BPop() { 67 | cli := delayer.Client{ 68 | Host: "127.0.0.1", 69 | Port: "6379", 70 | Database: 0, 71 | Password: "", 72 | } 73 | cli.Init() 74 | msg, err := cli.BPop("test", 10); 75 | fmt.Println(msg) 76 | fmt.Println(err) 77 | } 78 | 79 | // Remove 例子 80 | func ExampleClient_Remove() { 81 | cli := delayer.Client{ 82 | Host: "127.0.0.1", 83 | Port: "6379", 84 | Database: 0, 85 | Password: "", 86 | } 87 | cli.Init() 88 | ok, err := cli.Remove("9a8482a06630840ce7da9da62d748b8a") 89 | fmt.Println(ok) 90 | fmt.Println(err) 91 | } 92 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Delayer Golang 客户端 2 | 3 | 客户端使用非常简单，提供了 `push`、`pop`、`bPop`、`remove` 四个方法操作任务。 4 | 5 | ## 安装 6 | 7 | 8 | ``` 9 | go get github.com/mix-basic/delayer-client-golang/delayer 10 | ``` 11 | 12 | ## Documentation 13 | 14 | - [API Reference](https://godoc.org/github.com/mix-basic/delayer-client-golang/delayer) 15 | - [Examples](https://godoc.org/github.com/mix-basic/delayer-client-golang/delayer#pkg-examples) 16 | 17 | ## Example 18 | 19 | ### 创建客户端 20 | 21 | 通过连接信息创建客户端 22 | 23 | ```go 24 | cli := delayer.Client{ 25 | Host: "127.0.0.1", 26 | Port: "6379", 27 | Database: 0, 28 | Password: "", 29 | } 30 | cli.Init() 31 | ``` 32 | 33 | 通过已有连接创建客户端 34 | 35 | ```go 36 | pool := redis.Pool{} 37 | conn := pool.Get(); 38 | cli := delayer.Client{ 39 | Conn:conn, 40 | } 41 | cli.Init() 42 | ``` 43 | 44 | ### `push` 方法 45 | 46 | 放入一个任务。 47 | 48 | ```go 49 | cli := delayer.Client{ 50 | Host: "127.0.0.1", 51 | Port: "6379", 52 | Database: 0, 53 | Password: "", 54 | } 55 | cli.Init() 56 | msg := delayer.Message{ 57 | ID: fmt.Sprintf("%x", md5.Sum([]byte(time.Now().String()))), 58 | Topic: "test", 59 | Body: "test body", 60 | } 61 | reply, err := cli.Push(msg, 10, 600) 62 | fmt.Println(msg) 63 | fmt.Println(reply) 64 | fmt.Println(err) 65 | ``` 66 | 67 | ### `pop` 方法 68 | 69 | 取出一个到期的任务。 70 | 71 | ```go 72 | cli := delayer.Client{ 73 | Host: "127.0.0.1", 74 | Port: "6379", 75 | Database: 0, 76 | Password: "", 77 | } 78 | cli.Init() 79 | msg, err := cli.Pop("test"); 80 | fmt.Println(msg) 81 | fmt.Println(err) 82 | ``` 83 | 84 | ### `bPop` 方法 85 | 86 | 阻塞取出一个到期的任务。 87 | 88 | ```go 89 | cli := delayer.Client{ 90 | Host: "127.0.0.1", 91 | Port: "6379", 92 | Database: 0, 93 | Password: "", 94 | } 95 | cli.Init() 96 | msg, err := cli.BPop("test", 10); 97 | fmt.Println(msg) 98 | fmt.Println(err) 99 | ``` 100 | 101 | ### `remove` 方法 102 | 103 | 移除一个未到期的任务。 104 | 105 | ```go 106 | cli := delayer.Client{ 107 | Host: "127.0.0.1", 108 | Port: "6379", 109 | Database: 0, 110 | Password: "", 111 | } 112 | cli.Init() 113 | ok, err := cli.Remove("9a8482a06630840ce7da9da62d748b8a") 114 | fmt.Println(ok) 115 | fmt.Println(err) 116 | ``` 117 | 118 | ## License 119 | 120 | Apache License Version 2.0, http://www.apache.org/licenses/ 121 | -------------------------------------------------------------------------------- /delayer/client.go: -------------------------------------------------------------------------------- 1 | package delayer 2 | 3 | import ( 4 | "github.com/gomodule/redigo/redis" 5 | "errors" 6 | "time" 7 | ) 8 | 9 | // 键名 10 | const ( 11 | KEY_JOB_POOL = "delayer:job_pool" 12 | PREFIX_JOB_BUCKET = "delayer:job_bucket:" 13 | PREFIX_READY_QUEUE = "delayer:ready_queue:" 14 | ) 15 | 16 | // 客户端结构 17 | type Client struct { 18 | Conn redis.Conn 19 | Host string 20 | Port string 21 | Database int 22 | Password string 23 | } 24 | 25 | // 初始化 26 | func (p *Client) Init() error { 27 | // 创建连接 28 | if p.Conn == nil { 29 | conn, err := redis.Dial("tcp", p.Host+":"+p.Port) 30 | if err != nil { 31 | return err 32 | } 33 | p.Conn = conn 34 | // 验证密码 35 | if (p.Password != "") { 36 | if _, err := p.Conn.Do("AUTH", p.Password); err != nil { 37 | p.Conn.Close() 38 | return err 39 | } 40 | } 41 | // 选库 42 | if _, err := p.Conn.Do("SELECT", p.Database); err != nil { 43 | p.Conn.Close() 44 | return err 45 | } 46 | } 47 | return nil 48 | } 49 | 50 | // 增加任务 51 | func (p *Client) Push(message Message, delayTime int, readyMaxLifetime int) (bool, error) { 52 | // 参数验证 53 | if !message.Valid() { 54 | return false, errors.New("Invalid message."); 55 | } 56 | // 执行事务 57 | p.Conn.Send("MULTI") 58 | p.Conn.Send("HMSET", PREFIX_JOB_BUCKET+message.ID, "topic", message.Topic, "body", message.Body) 59 | p.Conn.Send("EXPIRE", PREFIX_JOB_BUCKET+message.ID, delayTime+readyMaxLifetime) 60 | p.Conn.Send("ZADD", KEY_JOB_POOL, time.Now().Unix()+int64(delayTime), message.ID) 61 | values, err := redis.Values(p.Conn.Do("EXEC")) 62 | if err != nil { 63 | return false, err 64 | } 65 | // 事务结果处理 66 | v := values[0].(string) 67 | v1 := values[1].(int64) 68 | v2 := values[2].(int64) 69 | if v != "OK" || v1 == 0 || v2 == 0 { 70 | return false, nil 71 | } 72 | // 返回 73 | return true, nil 74 | } 75 | 76 | // 取出任务 77 | func (p *Client) Pop(topic string) (*Message, error) { 78 | id, err := redis.String(p.Conn.Do("RPOP", PREFIX_READY_QUEUE+topic)) 79 | if err != nil { 80 | return nil, err 81 | } 82 | result, err := redis.StringMap(p.Conn.Do("HGETALL", PREFIX_JOB_BUCKET+id)) 83 | if err != nil { 84 | return nil, err 85 | } 86 | if result["topic"] == "" || result["body"] == "" { 87 | return nil, errors.New("Job bucket has expired or is incomplete") 88 | } 89 | p.Conn.Do("DEL", PREFIX_JOB_BUCKET+id) 90 | msg := &Message{ 91 | ID: id, 92 | Topic: result["topic"], 93 | Body: result["body"], 94 | } 95 | return msg, nil 96 | } 97 | 98 | // 阻塞取出任务 99 | func (p *Client) BPop(topic string, timeout int) (*Message, error) { 100 | values, err := redis.Strings(p.Conn.Do("BRPOP", PREFIX_READY_QUEUE+topic, timeout)) 101 | if err != nil { 102 | return nil, err 103 | } 104 | id := values[1] 105 | result, err := redis.StringMap(p.Conn.Do("HGETALL", PREFIX_JOB_BUCKET+id)) 106 | if err != nil { 107 | return nil, err 108 | } 109 | if result["topic"] == "" || result["body"] == "" { 110 | return nil, errors.New("Job bucket has expired or is incomplete") 111 | } 112 | p.Conn.Do("DEL", PREFIX_JOB_BUCKET+id) 113 | msg := &Message{ 114 | ID: id, 115 | Topic: result["topic"], 116 | Body: result["body"], 117 | } 118 | return msg, nil 119 | } 120 | 121 | // 移除任务 122 | func (p *Client) Remove(id string) (bool, error) { 123 | // 执行事务 124 | p.Conn.Send("MULTI") 125 | p.Conn.Send("ZREM", KEY_JOB_POOL, id) 126 | p.Conn.Send("DEL", PREFIX_JOB_BUCKET+id) 127 | values, err := redis.Values(p.Conn.Do("EXEC")) 128 | if err != nil { 129 | return false, err 130 | } 131 | // 事务结果处理 132 | v := values[0].(int64) 133 | v1 := values[1].(int64) 134 | if v == 0 || v1 == 0 { 135 | return false, nil 136 | } 137 | // 返回 138 | return true, nil 139 | } 140 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------