Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cheshir/go-mq
Declare AMQP entities like queues, producers, and consumers in a declarative way. Can be used to work with RabbitMQ.
https://github.com/cheshir/go-mq
amqp go golang hacktoberfest rabbit rabbitmq
Last synced: 14 days ago
JSON representation
Declare AMQP entities like queues, producers, and consumers in a declarative way. Can be used to work with RabbitMQ.
- Host: GitHub
- URL: https://github.com/cheshir/go-mq
- Owner: cheshir
- License: apache-2.0
- Created: 2017-06-19T16:16:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-09T18:33:44.000Z (about 1 year ago)
- Last Synced: 2024-07-31T20:52:19.078Z (3 months ago)
- Topics: amqp, go, golang, hacktoberfest, rabbit, rabbitmq
- Language: Go
- Homepage:
- Size: 109 KB
- Stars: 91
- Watchers: 8
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - go-mq - RabbitMQ client with declarative configuration. (Messaging / Search and Analytic Databases)
- zero-alloc-awesome-go - go-mq - RabbitMQ client with declarative configuration. (Messaging / Search and Analytic Databases)
- awesome-go-extra - go-mq - 06-19T16:16:30Z|2021-11-30T12:40:58Z| (Messaging / Advanced Console UIs)
README
[](https://github.com/cheshir/go-mq/actions/workflows/go.yml)
[](https://codecov.io/gh/cheshir/go-mq)
[](https://goreportcard.com/report/github.com/cheshir/go-mq)
[](https://sonarcloud.io/summary/new_code?id=cheshir_go-mq)
[](https://godoc.org/github.com/cheshir/go-mq)
[](https://github.com/avelino/awesome-go)
[](https://github.com/cheshir/go-mq/blob/master/LICENSE)
# About
This package provides an ability to encapsulate creation and configuration of RabbitMQ([AMQP])(https://www.amqp.org) entities
like queues, exchanges, producers and consumers in a declarative way with a single config.
Exchanges, queues and producers are going to be initialized in the background.
go-mq supports both sync and async producers.
go-mq has auto reconnects on closed connection or network error.
You can configure delay between each connect try using `reconnect_delay` option.
### Minimal go version
1.16
## Install
`go get -u github.com/cheshir/go-mq/v2`
## API
Visit [godoc](https://godoc.org/github.com/cheshir/go-mq) to get information about library API.
For those of us who preferred learn something new on practice there is working examples in `example` directory.
## Configuration
You can configure mq using mq.Config struct directly or by filling it from config file.
Supported configuration tags:
* yaml
* json
* mapstructure
Available options:
```yaml
dsn: "amqp://login:password@host:port/virtual_host" # Use comma separated list for cluster connection
reconnect_delay: 5s # Interval between connection tries. Check https://golang.org/pkg/time/#ParseDuration for details.
test_mode: false # Switches library to use mocked broker. Defaults to false.
exchanges:
- name: "exchange_name"
type: "direct"
options:
# Available options with default values:
auto_delete: false
durable: false
internal: false
no_wait: false
queues:
- name: "queue_name"
exchange: "exchange_name"
routing_key: "route"
# A set of arguments for the binding.
# The syntax and semantics of these arguments depend on the exchange class.
binding_options:
no_wait: false
# Available options with default values:
options:
auto_delete: false
durable: false
exclusive: false
no_wait: false
producers:
- name: "producer_name"
buffer_size: 10 # Declare how many messages we can buffer during fat messages publishing.
exchange: "exchange_name"
routing_key: "route"
sync: false # Specify whether producer will worked in sync or async mode.
# Available options with default values:
options:
content_type: "application/json"
delivery_mode: 2 # 1 - non persistent, 2 - persistent.
consumers:
- name: "consumer_name"
queue: "queue_name"
workers: 1 # Workers count. Defaults to 1.
prefetch_count: 0 # Prefetch message count per worker.
prefetch_size: 0 # Prefetch message size per worker.
# Available options with default values:
options:
no_ack: false
no_local: false
no_wait: false
exclusive: false
```
## Error handling
All errors are accessible via exported channel:
```go
package main
import (
"log"
"github.com/cheshir/go-mq"
)
func main() {
config := mq.Config{} // Set your configuration.
queue, _ := mq.New(config)
// ...
go handleMQErrors(queue.Error())
// Other logic.
}
func handleMQErrors(errors <-chan error) {
for err := range errors {
log.Println(err)
}
}
```
If channel is full – new errors will be dropped.
Errors from sync producer won't be accessible from error channel because they returned directly.
## Tests
There are some cases that can only be tested with real broker
and some cases that can only be tested with mocked broker.
If you are able to run tests with a real broker run them with:
`go test -mock-broker=0`
Otherwise mock will be used.
## Changelog
Check [releases page](https://github.com/cheshir/go-mq/releases).
## How to upgrade
### From v1 to v2
* `New()` returns `*MessageQueue` not the interface.
* Minimal go version updated to the 1.16.
### From version 0.x to 1.x
* `GetConsumer()` method was renamed to `Consumer()`. This is done to follow go guideline.
* `GetProducer()` method was removed. Use instead `AsyncProducer()` or `SyncProducer()` if you want to catch net error by yourself.
## Epilogue
Feel free to create issues with bug reports or your wishes.