README.md

go-rabbitmq

Wrapper of rabbitmq/amqp091-go that provides reconnection logic and sane defaults. Hit the project with a star if you find it useful ⭐

Motivation

Streadway's AMQP library is currently the most robust and well-supported Go client I'm aware of. It's a fantastic option and I recommend starting there and seeing if it fulfills your needs. Their project has made an effort to stay within the scope of the AMQP protocol, as such, no reconnection logic and few ease-of-use abstractions are provided.

Goal

The goal with go-rabbitmq is to still provide most all of the nitty-gritty functionality of AMQP, but to make it easier to work with via a higher-level API. Particularly:

• Automatic reconnection
• Multithreaded consumers via a handler function
• Reasonable defaults
• Flow control handling

⚙️ Installation

1. Create rabbitmq docker container by using:

$ docker run --name rabbitmq --hostname rabbitmq-test-node-1 -p 15672:15672 -p 5672:5672 -e RABBITMQ_DEFAULT_USER=root -e RABBITMQ_DEFAULT_PASS=123123 -d rabbitmq:3.8.5-management

2. Download rabbitmq package by using:

go get github.com/ysk229/go-rabbitmq/v2

🚀 Quick Start Consumer

Default options

mq := NewClient("amqp://user:pass@localhost") 
exchangeName := "go-test"
routeKey := "go-test"
q := "go-test"
mq.GetConsumer().Consumer(
    mq.GetChan(),
    consumers.WithOptionsConsumer(
        &consumers.ConsumerOpt{
			QueueName: q,
			RoutingKey: routeKey,
			Exchange: exchangeName,
			ExchangeType: lib.Topic},
    ),
    consumers.WithOptionsConsumerCallBack(
        &consumers.CallBack{
			Fnc: func(delivery consumers.Delivery) error {
				 log.Printf("%+v", delivery)
				 return nil
            },
        },
    ),
)
select {}

🚀 Quick Start Publisher

Default options

NewClient("amqp://user:pass@localhost").GetProducer().Producer(
    msg.NewMessage(
        msg.WithOptionsChannel(channels.NewChannel(mq.Connection)),
        msg.WithOptionsBody("sdfdsfd"+c), 
	),
    producers.WithOptionsProducer(&producers.ProducerOpt{
    Exchange:     "exchangeName",
    ExchangeType: lib.Topic,
    RouteKey:     "routeKey",
    Mandatory:    true,
    ResendNum:    2}),
    producers.WithOptionsProducerCallBack(&producers.CallBack{
		Fnc: func(ret msg.Ret)  error {
            log.Printf("call back %+v", ret)
			return nil
        }
	}),
)

}

🚀🚀 Concurrent Consumer

one connect more channel Consumer,Increase throughput in Consumer

    url := fmt.Sprintf("amqp://%s:%s@%s:%d/%s", "admin", "123456", "127.0.0.1", 5672, "")
    conn := connections.NewConnect().Open(url)
    exchangeName := "go-test"
    routeKey := "go-test"
    q := "go-test"
    job := make(chan string, 15)
    //10 worker
    for i := 0; i < 10; i++ {
        go func(job <-chan string) {
        //new mq channel
        channelClient := channels.NewChannel(conn.Connection)
        NewConsumer(channelClient).Consumer(
            channelClient,
            WithOptionsConsumer(
              &ConsumerOpt{QueueName: q, RoutingKey: routeKey, Exchange: exchangeName, ExchangeType: lib.Topic},
            ),
            WithOptionsConsumerCallBack(
                &CallBack{Fnc: func(delivery Delivery) error{                
                    time.Sleep(3 * time.Second)
                    if delivery.DeliveryTag == 1 {
                         _ = delivery.Ack(false)
                    } else {
                        _ = delivery.Nack(false, false)
                    }
                    log.Printf("%+v", delivery)
					return nil
                },
            },
            ),
        )
        }(job)
    }
    
    for i := 0; i < 15; i++ {
        job <- fmt.Sprintf("this is chan %d", i)
    }
    close(job)
    <-time.After(30 * time.Second)

🚀🚀 Concurrent Publisher

one connect more channel publisher,Increase throughput in production

    url := fmt.Sprintf("amqp://%s:%s@%s:%d/%s", "admin", "123456", "127.0.0.1", 5672, "")
    conn := connections.NewConnect().Open(url)
    p := NewProducer(channels.NewChannel(conn.Connection))
    job := make(chan string, 15)
    //10 worker
    for i := 0; i < 10; i++ {
        go func(job <-chan string) {
            exchangeName := "go-test"
            routeKey := "go-test"
            // new 10 mq channel
            c := channels.NewChannel(conn.Connection)
            for body := range job {
                p.Producer(
                msg.NewMessage(
                    msg.WithOptionsChannel(c),
                    msg.WithOptionsBody(body),
                ),
                WithOptionsProducer(&ProducerOpt{
                    Exchange:     exchangeName,
                    ExchangeType: lib.Topic,
                    RouteKey:     routeKey,
                    Mandatory:    true,
                    ResendNum:    2,
                }),
                WithOptionsProducerCallBack(&CallBack{Fnc: func(ret msg.Ret) error{
                    log.Printf("call back %+v", ret)                
					return nil
                }}),
                )
            }
        
        }(job)
    }
    
    for i := 0; i < 15; i++ {
        job <- fmt.Sprintf("this is chan %d", i)
    }
    close(job)
    <-time.After(30 * time.Second)

Other usage examples

See the examples directory for more ideas.

Transient Dependencies

My goal is to keep dependencies limited to 1, github.com/rabbitmq/amqp091-go.

👏 Contributing

I love help! Contribute by forking the repo and opening pull requests. Please ensure that your code passes the existing tests and linting, and write tests to test your changes if applicable.

All pull requests should be submitted to the main branch.