The goal of this project is to play with RSocket protocol. To do this, we will implement three Spring Boot Java applications: movie-server, movie-client-shell and movie-client-ui. For storage, the reactive NoSQL database MongoDB is used. All streaming of movie events and logging is handled by AOP (Aspect Oriented Programming).

On ivangfr.github.io, I have compiled my Proof-of-Concepts (PoCs) and articles. You can easily search for the technology you are interested in by using the filter. Who knows, perhaps I have already implemented a PoC or written an article about what you are looking for.

• [Medium] RSocket Crypto Server Tutorial
• [Medium] Implementing and Securing a Spring Boot RSocket App using Keycloak for IAM

• movie-server

  Spring Boot Java Web application that exposes REST API endpoints or RSocket routes to manage movies. Movies data are stored in reactive MongoDB.

  movie-server has the following profiles:

  • default

    • starts REST API on port 8080 and uses HTTP.

  • rsocket-tcp

    • starts REST API on port 8080 and uses HTTP.
    • start RSocket on port 7000 and uses TCP.

  • rsocket-websocket

    • starts REST API on port 8080 and uses HTTP.
    • starts RSocket with mapping-path /rsocket and uses WebSocket.

• movie-client-shell

  Spring Boot Shell Java application that has a couple of commands to interact with movie-server.

  The picture below shows those commands:

  

  It has the following profiles:

  • default

    • starts shell with enabled commands to call movie-server REST API endpoints using HTTP.

  • rsocket-tcp

    • starts shell with enabled commands to call movie-server REST API endpoints using HTTP.
    • starts shell with enabled commands to call movie-server RSocket routes using TCP.

  • rsocket-websocket

    • starts shell with enabled commands to call movie-server REST API endpoints using HTTP.
    • starts shell with enabled commands to call movie-server RSocket routes using WebSocket.

• movie-client-ui

  Spring Boot Java Web application that uses Thymeleaf and WebSocket to show at real-time all the events generated when movies are added, deleted, liked and disliked.

  

  movie-client-ui has the following profiles:

  • default

    • starts REST API on port 8081 and uses HTTP.
    • does not connect to movie-server through RSocket; does not receive movie events.

  • rsocket-tcp

    • starts REST API on port 8080 and uses HTTP.
    • connects to movie-server through RSocket using TCP; receives movie events.

  • rsocket-websocket

    • starts REST API on port 8080 and uses HTTP.
    • connects to movie-server through RSocket using WebSocket; receives movie events.

The GIF below shows a user running some commands in movie-client-shell (terminal on the right). The top-right terminal is running movie-server, and the bottom-right terminal runs movie-client-ui. In the background, a browser displays the movie events.

• Java 21 or higher.
• A containerization tool (e.g., Docker, Podman, etc.)

Open a terminal and inside the springboot-rsocket-webflux-aop root folder run:

docker compose up -d

• movie-server

  Open a new terminal and, inside the springboot-rsocket-webflux-aop root folder, run one of the following profile's command:

  Profile	Command
  rsocket-tcp	./mvnw clean spring-boot:run --projects movie-server -Dspring-boot.run.profiles=rsocket-tcp
  rsocket-websocket	./mvnw clean spring-boot:run --projects movie-server -Dspring-boot.run.profiles=rsocket-websocket
  default	./mvnw clean spring-boot:run --projects movie-server

• movie-client-shell

  Open a new terminal and, inside the springboot-rsocket-webflux-aop root folder, run the following command to build the executable jar file:

  ./mvnw clean package --projects movie-client-shell -DskipTests

  To start movie-client-shell, run the profile's command you picked to run movie-server

  Profile	Commands
  rsocket-tcp	export SPRING_PROFILES_ACTIVE=rsocket-tcp && ./movie-client-shell/target/movie-client-shell-1.0.0.jar
  rsocket-websocket	export SPRING_PROFILES_ACTIVE=rsocket-websocket && ./movie-client-shell/target/movie-client-shell-1.0.0.jar
  default	export SPRING_PROFILES_ACTIVE=default && ./movie-client-shell/target/movie-client-shell-1.0.0.jar

• movie-client-ui

  Open a new terminal and, inside the springboot-rsocket-webflux-aop root folder, run the profile's command you picked to run movie-server:

  Profile	Command
  rsocket-tcp	./mvnw clean spring-boot:run --projects movie-client-ui -Dspring-boot.run.profiles=rsocket-tcp
  rsocket-websocket	./mvnw clean spring-boot:run --projects movie-client-ui -Dspring-boot.run.profiles=rsocket-websocket
  default	./mvnw clean spring-boot:run --projects movie-client-ui

• Build Docker images

  • In a terminal, make sure you are in the springboot-rsocket-webflux-aop root folder.
  • Run the following script to build the Docker images:

    ./build-docker-image.sh

• Environment variables

  • movie-server

    Environment Variable	Description
    MONGODB_HOST	Specify host of the Mongo database to use (default localhost)
    MONGODB_PORT	Specify port of the Mongo database to use (default 27017)

  • movie-client-shell

    Environment Variable	Description
    MOVIE_SERVER_HOST	Specify host of the movie-server to use (default localhost)

  • movie-client-ui

    Environment Variable	Description
    MOVIE_SERVER_HOST	Specify host of the movie-server to use (default localhost)

• Start Docker containers

  • In a terminal, make sure you are inside the springboot-rsocket-webflux-aop root folder.
  • Run following command:
    • rsocket-tcp

      ./start-server-and-ui.sh rsocket-tcp && ./start-shell.sh rsocket-tcp

    • rsocket-websocket

      ./start-server-and-ui.sh rsocket-websocket && ./start-shell.sh rsocket-websocket

    • default

      ./start-server-and-ui.sh && ./start-shell.sh

Note: you can see the clients connected to movie-server by calling the info actuator endpoint.

curl -i localhost:8080/actuator/info

Note: to run the commands below, you must start movie-server and movie-client-shell with rsocket-tcp or rsocket-websocket profiles.

• Open a browser and access movie-client-ui at http://localhost:8081

• Go to movie-client-shell terminal.

• Add a movie using RSocket (Request-Response):

  add-movie-rsocket --imdb aaa --title "RSocketland"

  It should return:

  {"imdb":"aaa","title":"RSocketland","lastModifiedDate":"2020-07-20T12:43:39.857248","likes":0,"dislikes":0}

  A + action should be displayed in movie-client-ui.

• Add a movie using REST:

  add-movie-rest --imdb bbb --title "I, REST"

  It should return:

  {"imdb":"bbb","title":"I, REST","lastModifiedDate":"2020-07-20T12:44:13.266657","likes":0,"dislikes":0}

  A + action should be displayed in movie-client-ui.

• Send a like to RSocketland movie using RSocket (Fire-And-Forget):

  like-movie-rsocket --imdb aaa

  It should return:

  Like submitted 

  A thumbs-up action should be displayed in movie-client-ui.

• Get all movies using RSocket (Request-Stream):

  get-movies-rsocket

  It should return:

  {"imdb":"aaa","title":"RSocketland","lastModifiedDate":"2020-07-20T12:56:34.565","likes":1,"dislikes":0} {"imdb":"bbb","title":"I, REST","lastModifiedDate":"2020-07-20T12:56:26.846","likes":0,"dislikes":0} 

• Select movies using RSocket (Channel).

  select-movies-rsocket --imdbs aaa,bbb

  It should return:

  | IMDB: aaa | TITLE: RSocketland | LIKES: 1 | DISLIKES: 0 | | IMDB: bbb | TITLE: I, REST | LIKES: 0 | DISLIKES: 0 | 

• Delete movie RSocketland using RSocket (Request-Response) and movie I, REST using REST.

  delete-movie-rsocket --imdb aaa delete-movie-rest --imdb bbb

  It should return, as response, the IMDB of the movies.

  A - actions should be displayed in movie-client-ui.

• Simulation

  There are two scripts that contain some commands to add, retrieve, like, dislikes and delete movies. One uses REST, and the other uses RSocket to communicate with movie-server. At the end of the script execution, it's shown the Execution Time in milliseconds.

  • If you are running the applications with Maven:

    • REST

      script ../src/main/resources/simulation-rest.txt

    • RSocket

      script ../src/main/resources/simulation-rsocket.txt

  • If you are running the applications as Docker containers:

    • REST

      script /workspace/BOOT-INF/classes/simulation-rest.txt

    • RSocket

      script /workspace/BOOT-INF/classes/simulation-rsocket.txt

• MongoDB

  Find all movies:

  docker exec -it mongodb mongosh moviedb db.movies.find()

  Type exit to get out of MongoDB shell.

• To stop movie-client-shell, go to the terminal where it is running and type exit.
• To stop movie-server and movie-client-ui:
  • If you start them with Maven, go to the terminals where they are running and press Ctrl+C.
  • If you start them as Docker containers, go to a terminal and, inside the springboot-rsocket-webflux-aop root folder, run the following command:

    ./stop-server-and-ui.sh

• To stop and remove docker compose mongodb container, network and volumes, go to a terminal and, inside the springboot-rsocket-webflux-aop root folder, run the command below:

  docker compose down -v

To remove the Docker images created by this project, go to a terminal and, inside the springboot-rsocket-webflux-aop root folder, run the script below:

./remove-docker-images.sh

• https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#rsocket
• https://spring.io/blog/2020/05/12/getting-started-with-rsocket-servers-calling-clients
• https://grapeup.com/blog/reactive-service-to-service-communication-with-rsocket-introduction/

The autocomplete is not working when we run movie-client-shell as Docker container.