如何让rabbitmq消费者优雅的关闭(golang版本)

阅读本文需要掌握的知识:
1、rabbit mq
2、golang

如果项目使用消息队列进行异步处理,大家应该都会碰上一个问题:如果某个消息正在处理中,这时候中断程序(或者更新),那么将会出现数据异常。这种情况可以通过两种方式解决该问题:

1、使用自带的ack机制,将在消息处理完之后,发送ack消息给mq,这样如果处理到一半,程序中断,mq会将该消息发送给其他消费者进行处理。但是该解决方案会产生另一个问题,假如消息处理到一半,一部分数据已经保存到数据库了,那么重新处理可能导致数据异常。这时候需要配合第二种方式进行处理。
2、让程序优雅的中断,也就是graceful shutdown。在接收到中断信号(类似control + c)的时候,不直接退出,而是等所有的子进程处理完闭后再退出。

下面用golang和rabbitmq实现了一个demo,具体代码查看https://github.com/bin-x/rabbitmq-graceful-demo

/lib

该目录放了rabbit mq和server的封装,其中rabbit mq很重要的一点是在消费者代码中将auto-ack设为false,这样就可以在我们处理完消息后手动发送ack消息给rabbitmq的服务器,lib/rabbit.go

    consume, err := ch.Consume(
        queueName,    // queue
        consumerName, // consumer
        false,        // auto-ack, 这里必须设为false
        false,        // exclusive
        false,        // no-local
        true,         // no-wait
        nil,          // args
    )

其他关于rabbitmq需要的配置不在本文讨论范围。这里不展开介绍了。

lib/server.go 中相对重要的方法介绍:

// 开启graceful shutdown。默认不开启
func (srv *server) SetGraceful(duration time.Duration) {
    srv.graceful = true
    srv.gracefulTimeout = duration
}

// server的启动方法,Delivery chan作为参数,可以通过channel不断获取新消息。
func (srv *server) Run(deliveries <-chan amqp.Delivery) {
    go func() {
        // 处理消息
        for d := range deliveries {
            // 开启一个独立协程处理消息,如果不想并行处理多条消息,可以将go关键字去掉
            go srv.startHandler(d)
            // 关闭后不再处理新消息
            if srv.close {
                break
            }
        }
    }()
    // graceful shutdown需要手动开启,否则只是简单的阻塞。
    if srv.graceful {
        srv.gracefulShutdown()
    } else {
        forever := make(chan bool)
        <-forever
    }
}

// 使用*sync.WaitGroup 对handler进行计数,保证所有handler都done之后关闭。
func (srv *server) startHandler(delivery amqp.Delivery) {
    srv.wg.Add(1)
    defer srv.wg.Done()
    srv.handler(delivery)
}

// 核心逻辑
func (srv *server) gracefulShutdown() {
    // 阻塞,直到接收到shutdown的信号
    ch := make(chan os.Signal)
    signal.Notify(ch, syscall.SIGTERM, syscall.SIGQUIT, syscall.SIGINT, syscall.SIGKILL)
    _ = <-ch
    log.Println("receive a shutdown signal")
    //关闭后,Run方法中处理消息的协程将会关闭,不再处理新消息。
    srv.close = true
    
    //最大关闭时间,超过设定时间后,将会强制关闭。
    cxt, cancel := context.WithTimeout(context.Background(), srv.gracefulTimeout)
    defer cancel()

    // graceful关闭
    if err := srv.shutdown(cxt); err != nil {
        log.Fatalln(err)
    }
    log.Println("close the consumer.")
}
// 阻塞,直到触发以下两种情况中的一种:
// 1、所有handler执行完毕,
// 2、到达设置的最大关闭时间,然后抛出一个错误。
func (srv *server) shutdown(ctx context.Context) error {
    go srv.waitGroup()
    select {
    case <-srv.wait:
        return nil
    case <-ctx.Done():
        return ctx.Err()
    }
}
// 监听handler是否完成,如果完成,通知系统可以关闭。
func (srv *server) waitGroup() {
    srv.wg.Wait()
    srv.wait <- true
}

接着我们来看看最重要的consumer.go:

// 创建一个新的server
server := lib.NewServer(work)
// 启用graceful,并设置最大20秒的超时时间,超过该时间强制关闭,防止代码死循环。
server.SetGraceful(time.Second * 20)
// 启动服务
server.Run(consume)
// 消息处理方法
func work(delivery amqp.Delivery) {
    // 模拟长时间执行的任务
    for i := 0; i < 10; i++ {
        log.Println("i:", i)
        time.Sleep(time.Second)
    }
    log.Println("mq's data:", string(delivery.Body[:]))

    // 执行完毕后,需要通知mq。如果没有这条,那这条消息永远不会被确认,在中断rabbtmq的channel或者connection的时候,这条消息将会被重新投递。
    delivery.Ack(false)
}

测试:

consumer.goproducer.go中的rabbitmq信息改为你自己的:
err := mq.Connect("amqp://user:password@ip:port/yourhost")
go get 获取对应的包。
首先启动消费者:

$ go run consumer.go
2020/09/26 22:04:02 start consumer...

接着在一个新的终端页面,通过生产者发送条消息到队列中:

$ go run producer.go
2020/09/26 22:22:54 send message: this is message

这时候赶紧切回消费者的终端,按control+c,输出如下:

2020/09/26 22:04:02 start consumer...
2020/09/26 22:22:54 i: 0
2020/09/26 22:22:55 i: 1
2020/09/26 22:22:56 i: 2
2020/09/26 22:22:57 i: 3
^C2020/09/26 22:22:57 receive a shutdown signal
2020/09/26 22:22:58 i: 4
2020/09/26 22:22:59 i: 5
2020/09/26 22:23:00 i: 6
2020/09/26 22:23:01 i: 7
2020/09/26 22:23:02 i: 8
2020/09/26 22:23:03 i: 9
2020/09/26 22:23:04 mq's data: this is message
2020/09/26 22:23:04 close the consumer.

上面的演示中,我在第三秒的时候,按下了control + c, 然后程序接着执行,到整个任务执行完毕后,整个程序才真正关闭。

注意点:在control + c到真正关闭这段时间,你也可以通过生产者程序再发一条消息到队列中,看看新的消息是否会被处理(如果会被处理,在消息量大的情况下可能会触发强制关闭,导致最后几条消息执行异常。),这里不做演示了,读者可自行测试。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,591评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,448评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,823评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,204评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,228评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,190评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,078评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,923评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,334评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,550评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,727评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,428评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,022评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,672评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,826评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,734评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,619评论 2 354