Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sivaosorg/rmq4j

rmq4j: a robust library designed to streamline RabbitMQ integration with Spring Boot applications. It handles RabbitMQ connections, manages event production and consumption, supports automatic reconnection, and listens for disconnection events. Aims to simplify RabbitMQ setup and ensure reliable messaging within your Spring Boot projects.
https://github.com/sivaosorg/rmq4j

java rabbitmq rabbitmq-client rabbitmq-cluster rabbitmq-consumer rabbitmq-producer rabbitmq-server spring spring-application spring-boot spring-rabbitmq

Last synced: 4 days ago
JSON representation

rmq4j: a robust library designed to streamline RabbitMQ integration with Spring Boot applications. It handles RabbitMQ connections, manages event production and consumption, supports automatic reconnection, and listens for disconnection events. Aims to simplify RabbitMQ setup and ensure reliable messaging within your Spring Boot projects.

Awesome Lists containing this project

README 

        
# rmq4j



## Introduction



**rmq4j**: a robust library designed to streamline RabbitMQ integration with Spring Boot applications. It handles

RabbitMQ connections, manages event production and consumption, supports automatic reconnection, and listens for

disconnection events. This repository aims to simplify RabbitMQ setup and ensure reliable messaging within your Spring

Boot projects.



## Features



- Comprehensive set of utility functions.

- Written in Java 1.8.

- Well-documented code for easy understanding.

- Regular updates and maintenance.



## Installation



```bash

git clone --depth 1 https://github.com/sivaosorg/rmq4j.git

```



## Generation Plugin Java



```bash

curl https://gradle-initializr.cleverapps.io/starter.zip -d type=groovy-gradle-plugin  -d testFramework=testng -d projectName=rmq4j -o rmq4j.zip

```



## Modules



Explain how users can interact with the various modules.



### Tidying up



To tidy up the project's Java modules, use the following command:



```bash

./gradlew clean

```



or



```bash

make clean

```



### Building SDK



```bash

./gradlew jar

```



or



```bash

make jar

```



### Upgrading version



- file `gradle.yml`



```yaml

ng:

  name: rmq4j

  version: v1.0.0

  enabled_link: false # enable compression and attachment of the external libraries

  jars:

    # unify4J: Java 1.8 skeleton library offering a rich toolkit of utility functions

    # for collections, strings, date/time, JSON, maps, and more.

    - enabled: false # enable compression and attachment of the external libraries

      source: "./../libs/unify4j-v1.0.0.jar"

    # alpha4J: is a Java 8 library featuring common data structures and algorithms.

    # Enhance your projects with efficient and easy-to-use implementations designed for performance and clarity.

    - enabled: true

      source: "./../libs/alpha4j-v1.0.0.jar"

```



## Add dependencies



```groovy

// The "spring-core" library, version 5.3.31, is a fundamental component of the Spring Framework,

// offering essential functionality for dependency injection, bean management, and core utilities to facilitate robust Java application development within the Spring ecosystem.

implementation group: 'org.springframework', name: 'spring-core', version: '5.3.31'

// The "spring-boot-starter-web" library, version 2.7.18, is a Spring Boot starter module that facilitates the setup of web applications,

// providing essential dependencies and configurations for building web-based projects.

implementation group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '2.7.18'

// The "spring-boot-configuration-processor" library, version 2.7.18,

// is a Spring Boot module that processes configuration metadata annotations to generate metadata files and aid in auto-configuration of Spring applications.

implementation group: 'org.springframework.boot', name: 'spring-boot-configuration-processor', version: '2.7.18'

// The "spring-boot-starter-test" module version 2.7.18 provides a comprehensive test framework for Spring Boot applications.

// It includes JUnit, Mockito, Spring TestContext Framework, and other useful tools for testing Spring applications.

// The starter integrates these components seamlessly, making it easier to write and execute tests in a Spring Boot environment.

testImplementation group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: '2.7.18'

// Mockito JUnit Jupiter version 3.12.4: This library integrates Mockito with JUnit 5,

// enabling developers to write unit tests using Mockito's powerful mocking features.

// It's designed to work specifically with the JUnit 5 platform, allowing for advanced testing capabilities.

testImplementation group: 'org.mockito', name: 'mockito-junit-jupiter', version: '3.12.4'

// The "spring-boot-starter-amqp" library, version 2.7.18, is a Spring Boot starter module that simplifies the integration of AMQP (Advanced Message Queuing Protocol) messaging with Spring applications.

// It provides essential dependencies and configurations for working with messaging systems like RabbitMQ, enabling developers to build robust and scalable message-driven applications with minimal setup.

implementation group: 'org.springframework.boot', name: 'spring-boot-starter-amqp', version: '2.7.18'

```



## Integration



1. Add dependency into file `build.gradle`



```gradle

implementation files('libs/rmq4j-v1.0.0.jar') // filename based on ng.name and ng.version

```



2. Edit file `main Spring Boot application` (optional)



```java



@SpringBootApplication

@ComponentScan(basePackages = {"your_package", "org.rmq4j"}) // root name of package wizard4j

public class ApiApplication {

    public static void main(String[] args) {

        SpringApplication.run(ApiApplication.class, args);

    }

}

```