delayqueue

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 3, 2020 License: MIT Imports: 3 Imported by: 1

README

延时队列

Build Status

基于Golang实现的延时队列

功能

延时队列是指在指定的时间点进行消息消费,具体消费逻辑由用户自己来实现。

传统解决方法一般采用cron来实现,但有以下缺点:

  • 轮训效率太低,每次都需要扫库。
  • 如果扫库频率太高,则后端数据库压力过大,如果频率太低,则存在有效性时间差较大的问题

使用场景

  • 用户网上购买时后,如果收货后,15天内未对交易进行评论,则系统进行默认5星评论。
  • 订单超过30分钟未支付,则系统进行自动取消

实现原理

主要使用到的两个数据结构是 环形队列 和 集合。其中环形队列是由数组来实现。

基本概念

currentSlot 表示当前操作的环位置,这里是数组的索引值
timer 定时器,每1秒执行一次

系统主要由三部分组成,分别为slot、Elements和Element。

Slots 代表一个环, 由多个slot组成,每个slot对应一个Elements
Elements slot对应的值
Element 组成Elements集合的元素

每个环节点slot就是一个数据集合 Elements,这个集合内的数据则表示当前时间点需要进行消费的信息集合,有可能是下次循环到这个节点的时间进行消费。

环与集合的关系
slots[0] = Elements
slots[1] = Elements
slots[...] = ...

一个Elements是由一个或多个 Element 元素组成,每个 Element 元素都有一个 cycleNum 字段,用来表示此元素是当前消费还是以后消费,其值代表着环的循环周期。 如果当前Element的cycleNum字段值为0,则表示立即消费,如果cycleNum=2则表示还需要两个周期才能消费,本次循环需要将此 Element 元素周期数减少1,直到为0时结束。

集合与元素的关系
Elements = {Element、Element、Element}

运行原理

系统会有一个定时器timer,每1秒会移动一个slot, 此时currentSlot的值加1,表示下一个节点位置。
然后遍历当前环点中的所有元素,如果当前元素生命周期cycleNum=0,则立即消费,否则将cycleNum--, 直到循环完集合中的所有元素

演示代码

package main

import (
    "fmt"
    "github.com/cfanbo/delayqueue/queue"
    "time"
)

func consume(entry queue.Entry) {
    fmt.Println("当前:", time.Now().Format("2006-01-02 15:04:05"))
    fmt.Println("消费:", entry.ConsumeTime().Format("2006-01-02 15:04:05"))
    fmt.Println(entry.Body())
    fmt.Println("=======================")
}

func main() {
    q := queue.NewQueue()
    q.Put(time.Now().Add(time.Second * 2), "2秒后")
    q.Put(time.Now().Add(time.Second * 15), "15秒后")
    q.Put(time.Now().Add(time.Second * 8), "8秒后")
    q.Put(time.Now().Add(time.Second * 43), "43秒后")
    q.Put(time.Now().Add(time.Second * 50), "50秒后")
    q.Put(time.Now().Add(time.Second * 28), "28秒后")
    q.Run(consume)
}

存在问题

  1. 目前只支持秒级的事件触发
  2. 暂不支持数据持久化,所以若停止服务或者退出重启,则队列数据将全部丢失。
  3. 环的节点数量由 SlotsCount 定义,移动slot的频率是由 Frequency 定义,暂不支持定义

Documentation

Overview

delayqueue 是一款基于Golang开发的高性能延时队列

使用示例:

package main

import (
	"fmt"
	"github.com/cfanbo/delayqueue"
	"time"
)

func consume(entry queue.Entry) {
	fmt.Println("当前:", time.Now().Format("2006-01-02 15:04:05"))
	fmt.Println("消费:", entry.ConsumeTime().Format("2006-01-02 15:04:05"))
	fmt.Println(entry.Body())
	fmt.Println("=======================")
}

func main() {
	q := New()

	q.Put(time.Now().Add(time.Second * 2), "2秒后")
	q.Put(time.Now().Add(time.Second * 15), "15秒后")
	q.Put(time.Now().Add(time.Second * 8), "8秒后")
	q.Put(time.Now().Add(time.Second * 43), "43秒后")

	q.Put(time.Now().Add(time.Second * 50), "50秒后")
	q.Put(time.Now().Add(time.Second * 28), "28秒后")
	//q.Debug(true)

	q.Run(consume)
}

Index

Constants

View Source
const (
	// 队列总的slot数,每1秒移动一个slot
	SlotsCount = 3600
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Element

type Element struct {
	// contains filtered or unexported fields
}

func NewElement

func NewElement(t time.Time, cycleNum int, data interface{}) *Element

创建新的元素

type Elements

type Elements struct {
	// contains filtered or unexported fields
}

func NewElements

func NewElements() *Elements

初始化slot,初始化以前slot的值为nil

func (*Elements) Append

func (e *Elements) Append(ele *Element)

Append 添加新元素到slot

func (*Elements) Detection

func (e *Elements) Detection(ch chan<- Entry)

Detection 遍历检测每个solt中的元素 如果元素的当前生命周期为0,则表示立即执行,返回将生命周期进行 cycleNum--

func (*Elements) Empty

func (e *Elements) Empty() bool

Empty 判断slot是否空slot

func (*Elements) Len

func (e *Elements) Len() int

Len 返回slot里面元素的个数

type Entry

type Entry struct {
	// contains filtered or unexported fields
}

func NewEntry

func NewEntry(bt time.Time, body interface{}) Entry

func (Entry) Body

func (e Entry) Body() interface{}

Body 消息内容

func (Entry) BornTime

func (e Entry) BornTime() time.Time

BornTime 消息创建时间

func (Entry) ConsumeTime

func (e Entry) ConsumeTime() time.Time

ConsumeTime 消费时间

type Option

type Option func(*Options)

func WithFrequency

func WithFrequency(frequency time.Duration) Option

WithFrequency 移动slot的频率,这里批一秒移动一个slot

type Options

type Options struct {
	// contains filtered or unexported fields
}

func NewQueueOptions

func NewQueueOptions(opts ...Option) *Options

type Queue

type Queue struct {
	// contains filtered or unexported fields
}

func New

func New() *Queue

NewQueue 创建一个队列

func (*Queue) Debug

func (q *Queue) Debug(b bool)

Debug 调度模式

func (*Queue) Put

func (q *Queue) Put(t time.Time, data interface{})

Put 写入元素

func (*Queue) Run

func (q *Queue) Run(f func(entry Entry))

Run 启动服务

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL