Spring Web

Spring 5.0 introduced compatibility with Reactive Streams, a library interoperability standardization effort co-lead by Lightbend (with Akka Streams) along with Kaazing, Netflix, Pivotal, Red Hat, Twitter and many others.

Thanks to adopting Reactive Streams, multiple libraries can now inter-op since the same interfaces are implemented by all these libraries. Akka Streams by-design, hides the raw reactive-streams types from end-users, since it allows for detaching these types from RS and allows for a painless migration to java.util.concurrent.Flow which was introduced in Java 9.

This Alpakka module makes it possible to directly return a Source in your Spring Web endpoints.

Project Info: Alpakka Spring Web
Artifact
com.lightbend.akka
akka-stream-alpakka-spring-web
2.0.0-RC1
JDK versions
Adopt OpenJDK 8
Adopt OpenJDK 11
Scala versions2.12.10, 2.11.12, 2.13.1
JPMS module nameakka.stream.alpakka.spring.web
License
Readiness level
Since 0.14, 2017-10-14
Home pagehttps://doc.akka.io/docs/alpakka/current
API documentation
Forums
Release notesIn the documentation
IssuesGithub issues
Sourceshttps://github.com/akka/alpakka

Artifacts

sbt
val AkkaVersion = "2.5.30"
libraryDependencies ++= Seq(
  "com.lightbend.akka" %% "akka-stream-alpakka-spring-web" % "2.0.0-RC1",
  "com.typesafe.akka" %% "akka-stream" % AkkaVersion
)
Maven
<properties>
  <akka.version>2.5.30</akka.version>
</properties>
<dependency>
  <groupId>com.lightbend.akka</groupId>
  <artifactId>akka-stream-alpakka-spring-web_2.12</artifactId>
  <version>2.0.0-RC1</version>
</dependency>
<dependency>
  <groupId>com.typesafe.akka</groupId>
  <artifactId>akka-stream_2.12</artifactId>
  <version>${akka.version}</version>
</dependency>
Gradle
versions += [
  AkkaVersion: "2.5.30"
]
dependencies {
  compile group: 'com.lightbend.akka', name: 'akka-stream-alpakka-spring-web_2.12', version: '2.0.0-RC1',
  compile group: 'com.typesafe.akka', name: 'akka-stream_2.12', version: versions.AkkaVersion
}

The table below shows direct dependencies of this module and the second tab shows all libraries it depends on transitively.

Direct dependencies
OrganizationArtifactVersion
com.typesafe.akkaakka-stream_2.122.5.30
org.scala-langscala-library2.12.10
org.springframework.bootspring-boot-autoconfigure2.1.2.RELEASE
org.springframeworkspring-context5.1.4.RELEASE
org.springframeworkspring-core5.1.4.RELEASE
Dependency tree
com.typesafe.akka    akka-stream_2.12    2.5.30
    com.typesafe.akka    akka-actor_2.12    2.5.30
        com.typesafe    config    1.3.3
        org.scala-lang.modules    scala-java8-compat_2.12    0.8.0
    com.typesafe.akka    akka-protobuf_2.12    2.5.30
    com.typesafe    ssl-config-core_2.12    0.3.8
        com.typesafe    config    1.3.3
        org.scala-lang.modules    scala-parser-combinators_2.12    1.1.2
    org.reactivestreams    reactive-streams    1.0.2
org.scala-lang    scala-library    2.12.10
org.springframework.boot    spring-boot-autoconfigure    2.1.2.RELEASE
    org.springframework.boot    spring-boot    2.1.2.RELEASE
org.springframework    spring-context    5.1.4.RELEASE
    org.springframework    spring-aop    5.1.4.RELEASE
        org.springframework    spring-beans    5.1.4.RELEASE
    org.springframework    spring-beans    5.1.4.RELEASE
    org.springframework    spring-expression    5.1.4.RELEASE
org.springframework    spring-core    5.1.4.RELEASE
    org.springframework    spring-jcl    5.1.4.RELEASE

Usage

Using Akka Streams in Spring Web (or Boot for that matter) is very simple, as Alpakka provides autoconfiguration to the framework, which means that Spring is made aware of Sources and Sinks etc.

All you need to do is include the above dependency (akka-stream-alpakka-spring-web), start your app as usual:

Java
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }
}

And you’ll be able to return Akka Streams in HTTP endpoints directly:

Java
import javax.annotation.PostConstruct;

import akka.NotUsed;
import akka.actor.ActorSystem;
import akka.event.LoggingAdapter;
import akka.stream.javadsl.Source;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.util.Assert;

@RestController
public class SampleController {

  @Value("${akka.stream.alpakka.spring.web.actor-system-name}")
  private String actorSystemName;

  @Autowired private ActorSystem system;

  @RequestMapping("/")
  public Source<String, NotUsed> index() {
    return Source.repeat("Hello world!").intersperse("\n").take(10);
  }

  @PostConstruct
  public void setup() {
    LoggingAdapter log = system.log();
    log.info("Injected ActorSystem Name -> {}", system.name());
    log.info("Property ActorSystemName -> {}", actorSystemName);
    Assert.isTrue((system.name().equals(actorSystemName)), "Validating ActorSystem name");
  }
}

Both javadsl and scaladsl Akka Stream types are supported.

In fact, since Akka supports Java 9 and the java.util.concurrent.Flow.* types already, before Spring, you could use it to adapt those types in your applications as well.

The provided configuration

The automatically enabled configuration is as follows:

Java

import akka.actor.ActorSystem; import akka.stream.ActorMaterializer; import akka.stream.Materializer; @Configuration @ConditionalOnClass(akka.stream.javadsl.Source.class) @EnableConfigurationProperties(SpringWebAkkaStreamsProperties.class) public class SpringWebAkkaStreamsConfiguration { private static final String DEFAULT_ACTORY_SYSTEM_NAME = "SpringWebAkkaStreamsSystem"; private final ActorSystem system; private final ActorMaterializer mat; private final SpringWebAkkaStreamsProperties properties; public SpringWebAkkaStreamsConfiguration(final SpringWebAkkaStreamsProperties properties) { this.properties = properties; final ReactiveAdapterRegistry registry = ReactiveAdapterRegistry.getSharedInstance(); system = ActorSystem.create(getActorSystemName(properties)); mat = ActorMaterializer.create(system); new AkkaStreamsRegistrar(mat).registerAdapters(registry); } @Bean @ConditionalOnMissingBean(ActorSystem.class) public ActorSystem getActorSystem() { return system; } @Bean @ConditionalOnMissingBean(Materializer.class) public ActorMaterializer getMaterializer() { return mat; } public SpringWebAkkaStreamsProperties getProperties() { return properties; } private String getActorSystemName(final SpringWebAkkaStreamsProperties properties) { Objects.requireNonNull( properties, String.format( "%s is not present in application context", SpringWebAkkaStreamsProperties.class.getSimpleName())); if (isBlank(properties.getActorSystemName())) { return DEFAULT_ACTORY_SYSTEM_NAME; } return properties.getActorSystemName(); } private boolean isBlank(String str) { return (str == null || str.isEmpty()); } }

In case you’d like to manually configure it slightly differently.

Shameless plug: Akka HTTP

While the integration presented here works, it’s not quite the optimal way of using Akka in conjunction with serving HTTP apps. If you’re new to reactive systems and picking technologies, you may want to have a look at Akka HTTP.

If, for some reason, you decided use Spring MVC this integration should help you achieve the basic streaming scenarios though.

Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.