Multi-instance Reactive Chat App using Spring Boot WebFlux and Redis Pub/Sub
Scalable Java 11 Spring Boot WebFlux Chat Application to demonstrate use of Reactive Redis Pub/Sub using Reactive WebSocket Handler, without using any external Message Broker like RabbitMQ to sync messages between different instances.
Both JVM based application and Graal Native Image is supported.
The older non-reactive servlet based spring-redis-websocket application can be found in below links:
The reactive spring-boot 2.4.6 based spring-redis-websocket application can be found in below:
Deploy to Play-with-Docker
Ctrl + Click this button to deploy multiple instances of the spring-redis-websocket load balanced by NGINX:
Installation and Configuration
Pre-requisite for Java Image:
Install and run Redis locally or on Docker.
To run Redis in Docker:
$ docker run -d -p 6379:6379 -e REDIS_PASSWORD=SuperSecretRedisPassword bitnami/redis:6.0.9
Pre-requisite for Graal Native Image:
This application uses Spring Data Redis APIs which doesn’t have default Graal hints/config and graal-native image fails to run with errors.
Hence, this application is configured to use GraalVM native image tracing agent allows intercepting reflection, resources or proxy usage on the JVM by running simple Integration Tests which requires Redis.
- To run integration test which uses Redis TestContainers so Docker should be configured properly to run Testcontainers
- You also need to install GraalVM JDK and native-image component:
$ sdk install java 21.1.0.r11-grl # Using [SDKMAN](https://sdkman.io/jdks) install GraalVM distribution of JDK $ gu install native-image # Then install [native-image](https://www.graalvm.org/reference-manual/native-image) component
Clone repo:
$ git clone https://github.com/RawSanj/spring-redis-websocket.git
Build and Run the application:
Build and run the spring-redis-websocket application:
$ cd spring-redis-websocket
$ mvn clean package
$ mvn spring-boot:run
Build Graal Native Image of the application:
Build and run the spring-redis-websocket native image:
$ cd spring-redis-websocket
$ mvn -Pnative clean package -DskipNativeImage=false
$ target/spring-redis-websocket # run the executable binary
Note: Above steps are applicable for Linux only and creates linux executable binary. To create Windows executable there are few additional set-ups required, follow this Steps.
Run in Docker
Build and run the spring-redis-websocket locally in Docker:
Build the JAR file:
$ mvn clean package
Build Docker image:
$ mvn clean spring-boot:build-image
Build Graal Native Docker image:
$ mvn -Pnative clean spring-boot:build-image
Run docker image:
$ docker run -d -p 8080:8080 rawsanj/spring-redis-websocket:2.5.2-webflux # JVM based Docker Image
$ docker run -d -p 8080:8080 rawsanj/spring-redis-websocket:2.5.2-native # Graal Native Image based Docker Image
Run multiple instances using docker-compose locally
Run multiple instances of spring-redis-websocket locally load balanced via Ngnix connected to redis container in Docker:
$ cd src/main/docker
$ docker-compose up
Or try Play with Docker to quickly setup Docker and run in browser:
- Click Create Instance to quickly setup Docker host.
- Install git by running:
$ apk add git --no-cache - Clone the repository:
$ git clone https://github.com/RawSanj/spring-redis-websocket.git - Run multiple instances of spring-redis-websocket:
$ cd spring-redis-websocket/src/main/docker $ docker-compose up
Run in Kubernetes
Assuming you have a Kubernetes Cluster up and running locally:
$ kubectl apply -f src/main/k8s
Or try Play with Kubernetes to quickly setup a K8S cluster:
- Follow the instructions to create Kuberenetes cluster.
- Install git by running:
$ yum install git -y - Clone the repository:
$ git clone https://github.com/RawSanj/spring-redis-websocket.git - Run multiple instances of spring-redis-websocket load balanced by native Kubernetes Service. All instances
connected to a single Redis pod.
$ cd spring-redis-websocket $ kubectl apply -f src/main/k8s
Tech
spring-redis-websocket uses a number of open source projects:
- Spring Boot - An opinionated framework for building production-ready Spring applications. It favors convention over configuration and is designed to get you up and running as quickly as possible.
- Spring Data Redis - Spring Data Redis provides easy configuration and access to Redis from Spring applications.
- Graal Native Image - Native Image is a technology to ahead-of-time compile Java code to a standalone executable, called a native image.
- Redis - Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.
- Testcontainers - Testcontainers is a Java library that supports JUnit tests, providing lightweight, throwaway instances of common databases or anything else that can run in a Docker container.
- Bootstrap - Bootstrap is an open source toolkit for developing with HTML, CSS, and JS. Custom Bootstrap theme
- Docker - Docker is an open platform for developers and sysadmins to build, ship, and run distributed applications.
- NGINX - NGINX is High Performance Load Balancer, Web Server, & Reverse Proxy.
- Kubernetes - Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications.
License
Apache License 2.0
Copyright (c) 2022 Sanjay Rawat
