Chapter 2. Developing reactive applications using Spring Boot with Eclipse Vert.x

Procedure

1. Add vertx-spring-boot-starter-http as a dependency in the pom.xml file of your project.

   pom.xml

   <project>
   ...
     <dependencies>
     ...
       <dependency>
         <groupId>dev.snowdrop</groupId>
         <artifactId>vertx-spring-boot-starter-http</artifactId>
       </dependency>
     ...
     <dependencies>
   ...
   </project>

   Copy to Clipboard Toggle word wrap

2. Create a main class for your application and define the router and handler methods.

   HttpSampleApplication.java

   package dev.snowdrop.vertx.sample.http;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import org.springframework.context.annotation.Bean;
   import org.springframework.web.reactive.function.server.RouterFunction;
   import org.springframework.web.reactive.function.server.ServerRequest;
   import org.springframework.web.reactive.function.server.ServerResponse;
   import reactor.core.publisher.Mono;
   
   import static org.springframework.web.reactive.function.BodyInserters.fromObject;
   import static org.springframework.web.reactive.function.server.RouterFunctions.route;
   import static org.springframework.web.reactive.function.server.ServerResponse.ok;
   
   @SpringBootApplication
   public class HttpSampleApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(HttpSampleApplication.class, args);
       }
   
       @Bean
       public RouterFunction<ServerResponse> helloRouter() {
           return route()
               .GET("/hello", this::helloHandler)
               .build();
       }
   
       private Mono<ServerResponse> helloHandler(ServerRequest request) {
           String name = request
               .queryParam("name")
               .orElse("World");
           String message = String.format("Hello, %s!", name);
   
           return ok()
               .body(fromObject(message));
       }
   }

   Copy to Clipboard Toggle word wrap

3. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd myApp

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line:

      $ java -jar target/vertx-spring-boot-sample-http.jar

      Copy to Clipboard Toggle word wrap

   4. In a new terminal window, issue an HTTP request on the /hello endpoint:

      $ curl localhost:8080/hello
      Hello, World!

      Copy to Clipboard Toggle word wrap

   5. Provide a custom name with your request to get a personalized response:

      $ curl http://localhost:8080/hello?name=John
      Hello, John!

      Copy to Clipboard Toggle word wrap

Procedure

1. Add vertx-spring-boot-starter-http and spring-boot-starter-security as dependencies in the pom.xml file of your project.

   pom.xml

   <project>
   ...
     <dependencies>
     ...
       <dependency>
         <groupId>dev.snowdrop</groupId>
         <artifactId>vertx-spring-boot-starter-http</artifactId>
       </dependency>
       <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-security</artifactId>
       </dependency>
     ...
     <dependencies>
   ...
   </project>

   Copy to Clipboard Toggle word wrap

2. Create an endpoint controller class for your application:

   HelloController.java

   package dev.snowdrop.vertx.sample.http.security;
   
   import java.security.Principal;
   
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RestController;
   import reactor.core.publisher.Mono;
   
   @RestController
   public class HelloController {
   
       @GetMapping("/")
       public Mono<String> hello(Mono<Principal> principal) {
           return principal
               .map(Principal::getName)
               .map(this::helloMessage);
       }
   
       private String helloMessage(String username) {
           return "Hello, " + username + "!";
       }
   }

   Copy to Clipboard Toggle word wrap

3. Create the main class of your application:

   HttpSecuritySampleApplication.java

   package dev.snowdrop.vertx.sample.http.security;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   public class HttpSecuritySampleApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(HttpSecuritySampleApplication.class, args);
       }
   }

   Copy to Clipboard Toggle word wrap

4. Create a SecurityConfiguration class that stores the user credentials for accessing the /hello endpoint.

   SecurityConfiguration.java

   package dev.snowdrop.vertx.sample.http.security;
   
   import org.springframework.context.annotation.Bean;
   import org.springframework.security.config.annotation.web.reactive.EnableWebFluxSecurity;
   import org.springframework.security.core.userdetails.MapReactiveUserDetailsService;
   import org.springframework.security.core.userdetails.User;
   import org.springframework.security.core.userdetails.UserDetails;
   
   @EnableWebFluxSecurity
   public class SecurityConfiguration {
   
       @Bean
       public MapReactiveUserDetailsService userDetailsService() {
           UserDetails user = User.withDefaultPasswordEncoder()
               .username("user")
               .password("user")
               .roles("USER")
               .build();
   
           return new MapReactiveUserDetailsService(user);
       }
   }

   Copy to Clipboard Toggle word wrap

5. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd myApp

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line:

      $ java -jar target/vertx-spring-boot-sample-http-security.jar

      Copy to Clipboard Toggle word wrap
   4. Navigate to http://localhost:8080 using a browser to access the login screen.

   5. Log in using the credentials below:

      • username: user
      • password: user

      You receive a customized greeting when you are logged in:

      Hello, user!

      Copy to Clipboard Toggle word wrap
   6. Navigate to http://localhost:8080/logout using a web browser and use the Log out button to log out of your application.

   7. Alternatively, use a terminal to make an unauthenticated HTTP request on localhost:8080. You receive HTTP 401 Unauthorized response from your application.

      $ curl -I http://localhost:8080
      HTTP/1.1 401 Unauthorized
      WWW-Authenticate: Basic realm="Realm"
      Cache-Control: no-cache, no-store, max-age=0, must-revalidate
      Pragma: no-cache
      Expires: 0
      X-Content-Type-Options: nosniff
      X-Frame-Options: DENY
      X-XSS-Protection: 1 ; mode=block
      Referrer-Policy: no-referrer

      Copy to Clipboard Toggle word wrap

   8. Issue an authenticated request using the example user credentials. You receive a personalized response.

      $ curl -u user:user http://localhost:8080
      Hello, user!

      Copy to Clipboard Toggle word wrap

Procedure

1. Register a new OAuth 2 application on your Github account. Ensure that you provide the following values in the registration form:

   • Homepage URL: http://localhost:8080

   • Authorization callback URL: http://localhost:8080/login/oauth2/code/github

     Ensure that you save the client ID and a client secret that you receive upon completing the registration.

2. Add the following dependencies in the pom.xml file of your project:

   • vertx-spring-boot-starter-http
   • spring-boot-starter-security
   • spring-boot-starter-oauth2-client

   • reactor-netty

     Note that the reactor-netty client is required to ensure that spring-boot-starter-oauth2-client works properly.

     pom.xml

     <project>
     ...
       <dependencies>
       ...
         <dependency>
           <groupId>dev.snowdrop</groupId>
           <artifactId>vertx-spring-boot-starter-http</artifactId>
         </dependency>
         <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-security</artifactId>
         </dependency>
         <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-oauth2-client</artifactId>
         </dependency>
         <!-- Spring OAuth2 client only works with Reactor Netty client -->
         <dependency>
           <groupId>io.projectreactor.netty</groupId>
           <artifactId>reactor-netty</artifactId>
         </dependency>
       ...
       <dependencies>
     ...
     </project>

     Copy to Clipboard Toggle word wrap

3. Create an endpoint controller class for your application:

   HelloController.java

   package dev.snowdrop.vertx.sample.http.oauth;
   
   import org.springframework.security.core.annotation.AuthenticationPrincipal;
   import org.springframework.security.oauth2.core.user.OAuth2User;
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RestController;
   import reactor.core.publisher.Mono;
   
   @RestController
   public class HelloController {
   
       @GetMapping
       public Mono<String> hello(@AuthenticationPrincipal OAuth2User oauth2User) {
           return Mono.just("Hello, " + oauth2User.getAttributes().get("name") + "!");
       }
   }

   Copy to Clipboard Toggle word wrap

4. Create the main class of your application:

   OAuthSampleApplication.java

   package dev.snowdrop.vertx.sample.http.oauth;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   public class OAuthSampleApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(OAuthSampleApplication.class, args);
       }
   }

   Copy to Clipboard Toggle word wrap

5. Create a YAML configuration file to store the OAuth2 client ID and client secret you received from GitHub upon registering your application.

   src/main/resources/application.yml

   spring:
     security:
       oauth2:
         client:
           registration:
             github:
               client-id: YOUR_GITHUB_CLIENT_ID
               client-secret: YOUR_GITHUB_CLIENT_SECRET

   Copy to Clipboard Toggle word wrap

6. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd myApp

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line:

      $ java -jar target/vertx-spring-boot-sample-http-oauth.jar

      Copy to Clipboard Toggle word wrap
   4. Navigate to http://localhost:8080 using a web browser. You are redirected to an OAuth2 application authorization screen on GitHub. If prompted, log in using your GitHub account credentials.
   5. Click Authorize to confirm. You are redirected to a screen showing a personalized greeting message.

Procedure

1. Add vertx-spring-boot-starter-http and vertx-spring-boot-starter-mail as dependencies in the pom.xml file of your project.

   pom.xml

   <project>
   ...
     <dependencies>
     ...
       <dependency>
         <groupId>dev.snowdrop</groupId>
         <artifactId>vertx-spring-boot-starter-http</artifactId>
       </dependency>
       <dependency>
         <groupId>dev.snowdrop</groupId>
         <artifactId>vertx-spring-boot-starter-mail</artifactId>
       </dependency>
     ...
     <dependencies>
   ...
   </project>

   Copy to Clipboard Toggle word wrap

2. Create a mail handler class for your application:

   MailHandler.java

   package dev.snowdrop.vertx.sample.mail;
   
   import dev.snowdrop.vertx.mail.MailClient;
   import dev.snowdrop.vertx.mail.MailMessage;
   import dev.snowdrop.vertx.mail.SimpleMailMessage;
   import org.springframework.stereotype.Component;
   import org.springframework.util.MultiValueMap;
   import org.springframework.web.reactive.function.server.ServerRequest;
   import org.springframework.web.reactive.function.server.ServerResponse;
   import reactor.core.publisher.Mono;
   
   import static org.springframework.web.reactive.function.server.ServerResponse.noContent;
   
   @Component
   public class MailHandler {
   
       private final MailClient mailClient;
   
       public MailHandler(MailClient mailClient) {
           this.mailClient = mailClient;
       }
   
       public Mono<ServerResponse> send(ServerRequest request) {
           return request.formData()
               .log()
               .map(this::formToMessage)
               .flatMap(mailClient::send)
               .flatMap(result -> noContent().build());
       }
   
       private MailMessage formToMessage(MultiValueMap<String, String> form) {
           return new SimpleMailMessage()
               .setFrom(form.getFirst("from"))
               .setTo(form.get("to"))
               .setSubject(form.getFirst("subject"))
               .setText(form.getFirst("text"));
       }
   
   }

   Copy to Clipboard Toggle word wrap

3. Create the main class of your application:

   MailSampleApplication.java

   package dev.snowdrop.vertx.sample.mail;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import org.springframework.context.annotation.Bean;
   import org.springframework.core.io.ClassPathResource;
   import org.springframework.web.reactive.function.server.RouterFunction;
   import org.springframework.web.reactive.function.server.ServerResponse;
   
   import static org.springframework.http.MediaType.APPLICATION_FORM_URLENCODED;
   import static org.springframework.web.reactive.function.server.RequestPredicates.accept;
   import static org.springframework.web.reactive.function.server.RouterFunctions.resources;
   import static org.springframework.web.reactive.function.server.RouterFunctions.route;
   
   @SpringBootApplication
   public class MailSampleApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(MailSampleApplication.class, args);
       }
   
       @Bean
       public RouterFunction<ServerResponse> mailRouter(MailHandler mailHandler) {
           return route()
                   .POST("/mail", accept(APPLICATION_FORM_URLENCODED), mailHandler::send)
                   .build();
       }
   
       @Bean
       public RouterFunction<ServerResponse> staticResourceRouter() {
           return resources("/**", new ClassPathResource("static/"));
       }
   
   }

   Copy to Clipboard Toggle word wrap

4. Create an application.properties file to store your SMTP server credentials:

   application.properties

   vertx.mail.host=YOUR_SMTP_SERVER_HOSTNAME
   vertx.mail.username=YOUR_SMTP_SERVER_USERNAME
   vertx.mail.password=YOUR_SMTP_SERVER_PASSWORD

   Copy to Clipboard Toggle word wrap

5. Create a src/main/resources/static/index.html file that serves as the frontend of your application. Alternatively, use the example HTML email form available for this procedure.

6. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd myApp

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line.

      $ java -jar target/vertx-spring-boot-sample-mail.jar

      Copy to Clipboard Toggle word wrap
   4. Navigate to http://localhost:8080/index.html using a web browser to access the email form.

Procedure

1. Add vertx-spring-boot-starter-http as a dependency in the pom.xml file of your project.

   pom.xml

   <project>
   ...
     <dependencies>
     ...
       <dependency>
         <groupId>dev.snowdrop</groupId>
         <artifactId>vertx-spring-boot-starter-http</artifactId>
       </dependency>
     ...
     <dependencies>
   ...
   </project>

   Copy to Clipboard Toggle word wrap

2. Create the main class of your application:

   SseExampleApplication.java

   package dev.snowdrop.vertx.sample.sse;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   public class SseSampleApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(SseSampleApplication.class, args);
       }
   }

   Copy to Clipboard Toggle word wrap

3. Create a Server-sent Event controller class for your application. In this example, the class generates a stream of random integers and prints them to a terminal application.

   SseController.java

   package dev.snowdrop.vertx.sample.sse;
   
   import java.time.Duration;
   import java.util.Random;
   
   import org.springframework.http.MediaType;
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RestController;
   import reactor.core.publisher.Flux;
   
   @RestController
   public class SseController {
   
       @GetMapping(produces = MediaType.TEXT_EVENT_STREAM_VALUE)
       public Flux<Integer> getRandomNumberStream() {
           Random random = new Random();
   
           return Flux.interval(Duration.ofSeconds(1))
               .map(i -> random.nextInt())
               .log();
       }
   }

   Copy to Clipboard Toggle word wrap

4. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd myApp

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line:

      $ java -jar target/vertx-spring-boot-sample-sse.jar

      Copy to Clipboard Toggle word wrap

   4. In a new terminal window, issue a HTTP request to localhost. You start receiving a continuous stream of random integers from the server-sent event controller:

      $ curl localhost:8080
      data:-2126721954
      
      data:-573499422
      
      data:1404187823
      
      data:1338766210
      
      data:-666543077
      ...

      Copy to Clipboard Toggle word wrap

      Press Ctrl+C to cancel your HTTP request and terminate the stream of responses.

Procedure:

1. Add the vertx-spring-boot-starter-http as a dependency in the pom.xml file of your application project:

   pom.xml

   ...
   <dependencies>
     ...
      <dependency>
         <groupId>dev.snowdrop</groupId>
         <artifactId>vertx-spring-boot-starter-http</artifactId>
      </dependency>
     ...
   </dependencies>
   ...

   Copy to Clipboard Toggle word wrap

2. Create the class file containing the back-end application code:

   /src/main/java/webSocketSampleApplication.java

   package dev.snowdrop.WebSocketSampleApplication;
   
   import java.util.Collections;
   import java.util.Map;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import org.springframework.context.annotation.Bean;
   import org.springframework.web.reactive.HandlerMapping;
   import org.springframework.web.reactive.handler.SimpleUrlHandlerMapping;
   import org.springframework.web.reactive.socket.WebSocketHandler;
   import org.springframework.web.reactive.socket.WebSocketMessage;
   import org.springframework.web.reactive.socket.WebSocketSession;
   
   import reactor.core.publisher.Flux;
   import reactor.core.publisher.Mono;
   
   @SpringBootApplication
   public class WebSocketSampleApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(WebSocketSampleApplication.class, args);
       }
   
       @Bean
       public HandlerMapping handlerMapping() {
           // Define URL mapping for the socket handlers
           Map<String, WebSocketHandler> handlers = Collections.singletonMap("/echo-upper", this::toUppercaseHandler);
   
           SimpleUrlHandlerMapping handlerMapping = new SimpleUrlHandlerMapping();
           handlerMapping.setUrlMap(handlers);
           // Set a higher precedence than annotated controllers (smaller value means higher precedence)
           handlerMapping.setOrder(-1);
   
           return handlerMapping;
       }
   
       private Mono<Void> toUppercaseHandler(WebSocketSession session) {
           Flux<WebSocketMessage> messages = session.receive() // Get incoming messages stream
               .filter(message -> message.getType() == WebSocketMessage.Type.TEXT) // Filter out non-text messages
               .map(message -> message.getPayloadAsText().toUpperCase()) // Execute service logic
               .map(session::textMessage); // Create a response message
   
           return session.send(messages); // Send response messages
       }
   }

   Copy to Clipboard Toggle word wrap

3. Create the HTML document that serves as a front end for the application. Note, that in the following example, the <script> element contains the JavaScript code that handles the communication with the back end of your application:

   /src/main/resources/static/index.html

   <!doctype html>
   <html>
   <head>
     <meta charset="utf-8"/>
     <title>WebSocket Example</title>
     <script>
     const socket = new WebSocket("ws://localhost:8080/echo-upper");
   
     socket.onmessage = function(e) {
       console.log("Received a value: " + e.data);
       const messages = document.getElementById("messages");
       const message = document.createElement("li");
       message.innerHTML = e.data;
       messages.append(message);
     }
   
     window.onbeforeunload = function(e) {
       console.log("Closing socket");
       socket.close();
     }
   
     function send(event) {
       event.preventDefault();
   
       const value = document.getElementById("value-to-send").value.trim();
       if (value.length > 0) {
         console.log("Sending value to socket: " + value);
         socket.send(value);
       }
     }
     </script>
   </head>
   <body>
   <div>
     <h1>Vert.x Spring Boot WebSocket example</h1>
     <p>
       Enter a value to the form below and click submit. The value will be sent via socket to a backend service.
       The service will then uppercase the value and send it back via the same socket.
     </p>
   </div>
   <div>
     <form onsubmit="send(event)">
       <input type="text" id="value-to-send" placeholder="A value to be sent"/>
       <input type="submit"/>
     </form>
   </div>
   <div>
     <ol id="messages"></ol>
   </div>
   </body>
   </html>

   Copy to Clipboard Toggle word wrap

4. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd myApp

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line:

      $ java -jar target/vertx-spring-boot-sample-websocket.jar

      Copy to Clipboard Toggle word wrap

   4. Navigate to http://localhost:8080/index.html using a web browser. The website shows a web interface that contains

      • an input text box,
      • a list of processed results,
      • a Submit button.
5. Enter a string value into the text box and select Submit.
6. View the resulting value rendered in uppercase in the list below the input text box.

1. The front end service sends a HTTP POST request containing your string as the payload of the request to the HTTP controller.
2. The request is picked up by the messaging manager that routes the message to the AMQP Broker.
3. The broker routes the message to the text string processor service. If the text processor service is unavailable to pick up the request, the broker routes the message to the next available processor instance, if such instance is available. Alternatively, the broker waits before resending the request to the same instance when it becomes available again.
4. The text string processor service picks up the message and converts the characters in the string to uppercase. The processor service sends a request with the processed result in uppercase to the AMQP Broker.
5. The AMQP broker routes the request with the processed results to the messaging manager.
6. The messaging manager stores the request with the processed results in the outgoing queue where it can be accessed by the front end service.

1. The front end service sends a HTTP GET request to the HTTP controller provided by the Spring Boot HTTP Starter.
2. The HTTP controller routes the request to the messaging manager.
3. When a request previously submitted by the front end for processing is ready and available in the outgoing queue, the messaging manager sends the result as a response to the HTTP GET request back to the HTTP controller
4. The HTTP controller routes the response back to the front end service that displays the result.

Procedure

1. Add the following dependencies to the pom.xml file of your application project:

   pom.xml

   ...
   <dependencies>
     ...
      <dependency>
         <groupId>dev.snowdrop</groupId>
         <artifactId>vertx-spring-boot-starter-http</artifactId>
      </dependency>
      <dependency>
          <groupId>dev.snowdrop</groupId>
          <artifactId>vertx-spring-boot-starter-amqp</artifactId>
      </dependency>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-artemis</artifactId>
      </dependency>
      <dependency>
          <groupId>org.apache.activemq</groupId>
          <artifactId>artemis-jms-server</artifactId>
      </dependency>
      <dependency>
          <groupId>org.apache.activemq</groupId>
          <artifactId>artemis-amqp-protocol</artifactId>
        <exclusions>
          <exclusion>
            <groupId>org.apache.qpid</groupId>
            <artifactId>proton-j</artifactId>
          </exclusion>
        </exclusions>
      </dependency>
     ...
   </dependencies>
   ...

   Copy to Clipboard Toggle word wrap

2. Create the main class file of the example application. This class contains methods that define the respective processing queues for requests and results:

   /src/main/java/AmqpExampleApplication.java

   package dev.snowdrop.AmqpExampleApplication.java;
   
   import java.util.HashMap;
   import java.util.Map;
   
   import dev.snowdrop.vertx.amqp.AmqpProperties;
   import org.apache.activemq.artemis.api.core.TransportConfiguration;
   import org.apache.activemq.artemis.core.remoting.impl.netty.NettyAcceptorFactory;
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import org.springframework.boot.autoconfigure.jms.artemis.ArtemisConfigurationCustomizer;
   import org.springframework.context.annotation.Bean;
   
   @SpringBootApplication
   public class AmqpExampleApplication {
   
       final static String PROCESSING_REQUESTS_QUEUE = "processing-requests";
   
       final static String PROCESSING_RESULTS_QUEUE = "processing-results";
   
       public static void main(String[] args) {
           SpringApplication.run(AmqpExampleApplication.class, args);
       }
   
       /**
        * Add Netty acceptor to the embedded Artemis server.
        */
       @Bean
       public ArtemisConfigurationCustomizer artemisConfigurationCustomizer(AmqpProperties properties) {
           Map<String, Object> params = new HashMap<>();
           params.put("host", properties.getHost());
           params.put("port", properties.getPort());
   
           return configuration -> configuration
               .addAcceptorConfiguration(new TransportConfiguration(NettyAcceptorFactory.class.getName(), params));
       }
   }

   Copy to Clipboard Toggle word wrap

3. Create the class file containing the code for the HTTP REST controller that manages the request queue and the response queue by exposing REST endpoints that handle your GET and POST requests:

   /src/main/java/Controller.java

   package dev.snowdrop.vertx.sample.amqp;
   
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.PostMapping;
   import org.springframework.web.bind.annotation.RequestBody;
   import org.springframework.web.bind.annotation.RestController;
   import reactor.core.publisher.Flux;
   import reactor.core.publisher.Mono;
   
   import static org.springframework.http.MediaType.TEXT_EVENT_STREAM_VALUE;
   
   /**
    * Rest controller exposing GET and POST resources to receive processed messages and submit messages for processing.
    */
   @RestController
   public class Controller {
   
       private final MessagesManager messagesManager;
   
       public Controller(MessagesManager messagesManager) {
           this.messagesManager = messagesManager;
       }
   
       /**
        * Get a flux of messages processed up to this point.
        */
       @GetMapping(produces = TEXT_EVENT_STREAM_VALUE)
       public Flux<String> getProcessedMessages() {
           return Flux.fromIterable(messagesManager.getProcessedMessages());
       }
   
       /**
        * Submit a message for processing by publishing it to a processing requests queue.
        */
       @PostMapping
       public Mono<Void> submitMessageForProcessing(@RequestBody String body) {
           return messagesManager.processMessage(body.trim());
       }
   }

   Copy to Clipboard Toggle word wrap

4. Create the class file containing the messaging manager. The manager controls how applications components publish requests to the request queue and subsequently subscribe to the response queue to obtain processed results:

   /src/main/java/MessagesManager.java:

   package dev.snowdrop.vertx.sample.amqp;
   
   import java.util.List;
   import java.util.concurrent.CopyOnWriteArrayList;
   
   import dev.snowdrop.vertx.amqp.AmqpClient;
   import dev.snowdrop.vertx.amqp.AmqpMessage;
   import dev.snowdrop.vertx.amqp.AmqpSender;
   import org.apache.activemq.artemis.core.server.embedded.EmbeddedActiveMQ;
   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   import org.springframework.beans.factory.DisposableBean;
   import org.springframework.beans.factory.InitializingBean;
   import org.springframework.stereotype.Component;
   import reactor.core.Disposable;
   import reactor.core.publisher.Mono;
   
   import static dev.snowdrop.vertx.sample.amqp.AmqpSampleApplication.PROCESSING_REQUESTS_QUEUE;
   import static dev.snowdrop.vertx.sample.amqp.AmqpSampleApplication.PROCESSING_RESULTS_QUEUE;
   
   /**
    * Processor client submits messages to the requests queue and subscribes to the results queue for processed messages.
    */
   @Component
   public class MessagesManager implements InitializingBean, DisposableBean {
   
       private final Logger logger = LoggerFactory.getLogger(MessagesManager.class);
   
       private final List<String> processedMessages = new CopyOnWriteArrayList<>();
   
       private final AmqpClient client;
   
       private Disposable receiverDisposer;
   
       // Injecting EmbeddedActiveMQ to make sure it has started before creating this component.
       public MessagesManager(AmqpClient client, EmbeddedActiveMQ server) {
           this.client = client;
       }
   
       /**
        * Create a processed messages receiver and subscribe to its messages publisher.
        */
       @Override
       public void afterPropertiesSet() {
           receiverDisposer = client.createReceiver(PROCESSING_RESULTS_QUEUE)
               .flatMapMany(receiver -> receiver.flux()
                   .doOnCancel(() -> receiver.close().block())) // Close the receiver once subscription is disposed
               .subscribe(this::handleMessage);
       }
   
       /**
        * Cancel processed messages publisher subscription.
        */
       @Override
       public void destroy() {
           if (receiverDisposer != null) {
               receiverDisposer.dispose();
           }
       }
   
       /**
        * Get messages which were processed up to this moment.
        *
        * @return List of processed messages.
        */
       public List<String> getProcessedMessages() {
           return processedMessages;
       }
   
       /**
        * Submit a message for processing by publishing it to a processing requests queue.
        *
        * @param body Message body to be processed.
        * @return Mono which is completed once the message is sent.
        */
       public Mono<Void> processMessage(String body) {
           logger.info("Sending message '{}' for processing", body);
   
           AmqpMessage message = AmqpMessage.create()
               .withBody(body)
               .build();
   
           return client.createSender(PROCESSING_REQUESTS_QUEUE)
               .map(sender -> sender.send(message))
               .flatMap(AmqpSender::close);
       }
   
       private void handleMessage(AmqpMessage message) {
           String body = message.bodyAsString();
   
           logger.info("Received processed message '{}'", body);
           processedMessages.add(body);
       }
   }

   Copy to Clipboard Toggle word wrap

5. Create the class file containing the uppercase processor that receives text strings from the request queue and converts them to uppercase characters. The processor subsequently publishes the results to the response queue:

   /src/main/java/UppercaseProcessor.java

   package dev.snowdrop.vertx.sample.amqp;
   
   import dev.snowdrop.vertx.amqp.AmqpClient;
   import dev.snowdrop.vertx.amqp.AmqpMessage;
   import dev.snowdrop.vertx.amqp.AmqpSender;
   import org.apache.activemq.artemis.core.server.embedded.EmbeddedActiveMQ;
   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   import org.springframework.beans.factory.DisposableBean;
   import org.springframework.beans.factory.InitializingBean;
   import org.springframework.stereotype.Component;
   import reactor.core.Disposable;
   import reactor.core.publisher.Mono;
   
   import static dev.snowdrop.vertx.sample.amqp.AmqpSampleApplication.PROCESSING_REQUESTS_QUEUE;
   import static dev.snowdrop.vertx.sample.amqp.AmqpSampleApplication.PROCESSING_RESULTS_QUEUE;
   
   /**
    * Uppercase processor subscribes to the requests queue, converts each received message to uppercase and send it to the
    * results queue.
    */
   @Component
   public class UppercaseProcessor implements InitializingBean, DisposableBean {
   
       private final Logger logger = LoggerFactory.getLogger(UppercaseProcessor.class);
   
       private final AmqpClient client;
   
       private Disposable receiverDisposer;
   
       // Injecting EmbeddedActiveMQ to make sure it has started before creating this component.
       public UppercaseProcessor(AmqpClient client, EmbeddedActiveMQ server) {
           this.client = client;
       }
   
       /**
        * Create a processing requests receiver and subscribe to its messages publisher.
        */
       @Override
       public void afterPropertiesSet() {
           receiverDisposer = client.createReceiver(PROCESSING_REQUESTS_QUEUE)
               .flatMapMany(receiver -> receiver.flux()
                   .doOnCancel(() -> receiver.close().block())) // Close the receiver once subscription is disposed
               .flatMap(this::handleMessage)
               .subscribe();
       }
   
       /**
        * Cancel processing requests publisher subscription.
        */
       @Override
       public void destroy() {
           if (receiverDisposer != null) {
               receiverDisposer.dispose();
           }
       }
   
       /**
        * Convert the message body to uppercase and send it to the results queue.
        */
       private Mono<Void> handleMessage(AmqpMessage originalMessage) {
           logger.info("Processing '{}'", originalMessage.bodyAsString());
   
           AmqpMessage processedMessage = AmqpMessage.create()
               .withBody(originalMessage.bodyAsString().toUpperCase())
               .build();
   
           return client.createSender(PROCESSING_RESULTS_QUEUE)
               .map(sender -> sender.send(processedMessage))
               .flatMap(AmqpSender::close);
       }
   }

   Copy to Clipboard Toggle word wrap

6. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd myApp

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line:

      $ java -jar target/vertx-spring-boot-sample-amqp.jar

      Copy to Clipboard Toggle word wrap

   4. In a new terminal window, send a number of HTTP POST request that contain text strings to be processed to localhost

      $ curl -H "Content-Type: text/plain" -d 'Hello, World' -X POST http://localhost:8080
      $ curl -H "Content-Type: text/plain" -d 'Hello again' -X POST http://localhost:8080

      Copy to Clipboard Toggle word wrap

   5. Send an HTTP GET request to localhost. You receive a HTTP response with the strings in uppercase.

      $ curl http://localhost:8080
      HTTP/1.1 200 OK
      Content-Type: text/event-stream;charset=UTF-8
      transfer-encoding: chunked
      
      data:HELLO, WORLD
      
      data:HELLO AGAIN

      Copy to Clipboard Toggle word wrap

1. You make an HTTP POST request to the example application with the log message as the payload.
2. The HTTP controller routes the message to the REST endpoint used for publishing messages, and passes the message to the logger instance.
3. The HTTP controller publishes the received message to the log topic on Kafka.
4. KafkaLog instance receives the log message from a Kafka topic.

1. You send a HTTP GET request to the example application URL.
2. The controller gets the messages from the KafkaLog instance and returns them as the body of the HTTP response.

Procedure

1. Add the WebFlux HTTP Starter and the Apache Kafka Starter as dependencies in the pom.xml file of your application project:

   pom.xml

   ...
   <dependencies>
     ...
     <!-- Vert.x WebFlux starter used to handle HTTP requests -->
     <dependency>
       <groupId>dev.snowdrop</groupId>
       <artifactId>vertx-spring-boot-starter-http</artifactId>
     </dependency>
     <!-- Vert.x Kafka starter used to send and receive messages to/from Kafka cluster -->
     <dependency>
       <groupId>dev.snowdrop</groupId>
       <artifactId>vertx-spring-boot-starter-kafka</artifactId>
     </dependency>
     ...
   </dependencies>
   ...

   Copy to Clipboard Toggle word wrap

1. Create the KafkaLogger class. This class functions s a producer and sendas messages The KafkaLogger class defines how the Producer publishes messages (also called records) to the topic:

   /src/main/java/KafkaLogger.java

   ...
   final class KafkaLogger {
   
       private final KafkaProducer<String, String> producer;
   
       KafkaLogger(KafkaProducer<String, String> producer) {
           this.producer = producer;
       }
   
       public Mono<Void> logMessage(String body) {
           // Generic key and value types can be inferred if both key and value are used to create a builder
           ProducerRecord<String, String> record = ProducerRecord.<String, String>builder(LOG_TOPIC, body).build();
   
           return producer.send(record)
               .log("Kafka logger producer")
               .then();
       }
   }
   ...

   Copy to Clipboard Toggle word wrap

2. Crate KafkaLog class. This class functions as the consumer of kafka messages. KafkaLog retrieves messages from the topic an displays them in your terminal:

   /src/main/java/KafkaLog.java

   ...
   final class KafkaLog implements InitializingBean, DisposableBean {
   
       private final List<String> messages = new CopyOnWriteArrayList<>();
   
       private final KafkaConsumer<String, String> consumer;
   
       private Disposable consumerDisposer;
   
       KafkaLog(KafkaConsumer<String, String> consumer) {
           this.consumer = consumer;
       }
   
       @Override
       public void afterPropertiesSet() {
           consumerDisposer = consumer.subscribe(LOG_TOPIC)
               .thenMany(consumer.flux())
               .log("Kafka log consumer")
               .map(ConsumerRecord::value)
               .subscribe(messages::add);
       }
   
       @Override
       public void destroy() {
           if (consumerDisposer != null) {
               consumerDisposer.dispose();
           }
           consumer.unsubscribe()
               .block(Duration.ofSeconds(2));
       }
   
       public List<String> getMessages() {
           return messages;
       }
   }
   ...

   Copy to Clipboard Toggle word wrap

3. Create the class file that contains the the HTTP REST controller. The controller that exposes REST resources that your application uses to handle the logging and reading of messages.

   /src/main/java/Controller.java

   package dev.snowdrop.vertx.sample.kafka;
   
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.PostMapping;
   import org.springframework.web.bind.annotation.RequestBody;
   import org.springframework.web.bind.annotation.RestController;
   import reactor.core.publisher.Flux;
   import reactor.core.publisher.Mono;
   
   import static org.springframework.http.MediaType.TEXT_EVENT_STREAM_VALUE;
   
   /**
    * HTTP controller exposes GET and POST resources to log messages and to receive the previously logged ones.
    */
   @RestController
   public class Controller {
   
       private final KafkaLogger logger;
   
       private final KafkaLog log;
   
       public Controller(KafkaLogger logger, KafkaLog log) {
           this.logger = logger;
           this.log = log;
       }
   
       /**
        * Get a Flux of previously logged messages.
        */
       @GetMapping(produces = TEXT_EVENT_STREAM_VALUE)
       public Flux<String> getMessages() {
           return Flux.fromIterable(log.getMessages());
       }
   
       /**
        * Log a message.
        */
       @PostMapping
       public Mono<Void> logMessage(@RequestBody String body) {
           return logger.logMessage(body.trim());
       }
   }

   Copy to Clipboard Toggle word wrap

4. Crate the YAML template that contains the URLs that producers and consumers in your Apache Kafka Cluster use to log and read messages. In this example, the consumer and producer on your Apache Kafka Cluster communicate using port 9092 on localhost by default. Note, that you must configure the producers and consumers separately, as the following example shows:

   /src/main/resources/application.yml

   vertx:
     kafka:
       producer:
         bootstrap:
            # The producer in your cluster uses this URL to publish messages to the log.
           servers: localhost:9092
         key:
             # This class assigns the mandatory key attribute that is assigned to each message.
           serializer: org.apache.kafka.common.serialization.StringSerializer
         value:
             # This class assigns the mandatory value attribute that is assigned to each message.
           serializer: org.apache.kafka.common.serialization.StringSerializer
       consumer:
         bootstrap:
           servers: localhost:9092 # The consumer in your cluster uses this URL to read messages from the log.
         group:
           id: log # The consumer group IDs used to define a group of consumers that subscribe to the same topic. In this example, all consumers belong in the same consumer group.
         key:
           deserializer: org.apache.kafka.common.serialization.StringDeserializer # This class generates the mandatory key attribute that is assigned to each message.
         value:
           deserializer: org.apache.kafka.common.serialization.StringDeserializer # This class generates the mandatory value attribute that is assigned to each message.

   Copy to Clipboard Toggle word wrap

5. OPTIONAL: Run and test your application locally:

   1. Navigate to the root directory of your Maven project:

      $ cd vertx-spring-boot-sample-kafka

      Copy to Clipboard Toggle word wrap

   2. Package your application:

      $ mvn clean package

      Copy to Clipboard Toggle word wrap

   3. Start your application from the command line:

      $ java -jar target/vertx-spring-boot-sample-kafka.jar

      Copy to Clipboard Toggle word wrap

   4. In a new terminal window, send a number of HTTP POST request that contain messages formatted as text strings to localhost. The messages are all published to the log topic.

      $ curl -H "Content-Type: text/plain" -d 'Hello, World' -X POST http://localhost:8080
      $ curl -H "Content-Type: text/plain" -d 'Hello again' -X POST http://localhost:8080
      ...

      Copy to Clipboard Toggle word wrap

   5. Send an HTTP GET request to localhost. You receive a HTTP response that contains all the messages in the topic that your consumers subscribe to.

      $ curl http://localhost:8080
      HTTP/1.1 200 OK
      Content-Type: text/event-stream;charset=UTF-8
      transfer-encoding: chunked
      
      data:Hello, World
      
      data:Hello, again
      ...

      Copy to Clipboard Toggle word wrap