Asynchronous Streaming Request Processing in Spring MVC 4.2 + Spring Boot

Author: Shazin Sadakath


With the release of Spring 4.2 version, Three new classes have been introduced to handle Requests Asynchronously of the Servlet Thread. Which are;

  1. ResponseBodyEmitter
  2. SseEmitter
  3. StreamingResponseBody

ResponseBodyEmitter enables to send DeferredResult with a compatible HttpMessageConverter. Results can be emitted from threads which are not necessarily the Servlet Request Thread of the Servlet Container.

 

SseEmitter is used to send Server Sent Events to the Client. Server Sent Events has a fixed format and the response type for the result will be text/event-stream.

 

StreamingResponseBody is used to send raw unformatted data such as bytes to the client asynchronously of the Servlet Thread.

 

ResponseBodyEmitter and SseEmitter has a method named complete to mark its completion and StreamingResponseBody will complete when there is no more data to send. 

 

All three options will be keeping alive a connection to the endpoint until the end of the request.

 

StreamingResponseBody is particularly useful for streaming large files such as Media Files as writing of the bytes to the Response's OutputStream will be done asynchronously. StreamingResponseBody has a writeTo(OutputStream os) call back method which needs to be overridden inorder to support streaming.

 

I wrote a small Spring Boot Application to showcase the StreamingResponseBody capabilities in terms of Streaming large files. The application source code can be found at www.github.com/shazin/itube. Below is a screen shot of the application.

 

 

 

 

In order to send the Video files streaming to the Projekktor player in the web page following code snippet is used.

@RequestMapping(method = RequestMethod.GET, value = "/{video:.+}")
public StreamingResponseBody stream(@PathVariable String video)
  throws FileNotFoundException {
 File videoFile = videos.get(video);
 final InputStream videoFileStream = new FileInputStream(videoFile);
 return (os) -> {
  readAndWrite(videoFileStream, os);
 };
}

And a Custom Web Configuration to over ride default timeout behavior to no timeout and finally configuring an AsyncTaskExecutor
 

@Configuration
public static class WebConfig extends WebMvcConfigurerAdapter {

 @Override
 public void configureAsyncSupport(AsyncSupportConfigurer configurer) {
  configurer.setDefaultTimeout(-1);
  configurer.setTaskExecutor(asyncTaskExecutor());
 }
  
 @Bean
 public AsyncTaskExecutor asyncTaskExecutor() {
  return new SimpleAsyncTaskExecutor("async");
 }
  
}

References

  1. Spring MVC 4.2: New and Noteworthy - Rossen Stoyanchev
  2. Projekktor Player
  3. Videos Downloaded From Videezy


Tags: Streaming SpringMVC SpringBoot Asynchronous
Views: 2350
Register for more exciting articles

Comments

Please login or register to post a comment.


There are currently no comments.