Docs: flatMapConcat (#28584)

This commit is contained in:
Christopher Batey 2020-04-27 15:46:16 +01:00 committed by GitHub
parent c2945a3e7f
commit 23ea1a4fed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 84 additions and 4 deletions

View file

@ -4,19 +4,33 @@ Transform each input element into a `Source` whose elements are then flattened i
@ref[Nesting and flattening operators](../index.md#nesting-and-flattening-operators)
@@@div { .group-scala }
## Signature
@@signature [Flow.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Flow.scala) { #flatMapConcat }
@apidoc[Flow.flatMapConcat](Flow) { scala="#flatMapConcat[T,M](f:Out=%3akka.stream.Graph[akka.stream.SourceShape[T],M]):FlowOps.this.Repr[T]" java="#flatMapConcat(akka.japi.function.Function)" }
@@@
See also: @ref:[flatMapMerge](flatMapMerge.md)
## Description
Transform each input element into a `Source` whose elements are then flattened into the output stream through
concatenation. This means each source is fully consumed before consumption of the next source starts.
## Example
In the following example `flatMapConcat` is used to create a `Source` for each incoming customerId. This could be, for example,
a calculation or a query to a database. Each customer is then passed to `lookupCustomerEvents` which returns
a `Source`. All the events for a customer are delivered before moving to the next customer.
Scala
: @@snip [FlatMapConcat.scala](/akka-docs/src/test/scala/docs/stream/operators/sourceorflow/FlatMapConcat.scala) { #flatmap-concat}
Java
: @@snip [FlatMapConcat.java](/akka-docs/src/test/java/jdocs/stream/operators/sourceorflow/FlatMapConcat.java) { #flatmap-concat }
## Reactive Streams semantics
@@@div { .callout }

View file

@ -0,0 +1,35 @@
/*
* Copyright (C) 2019-2020 Lightbend Inc. <https://www.lightbend.com>
*/
package jdocs.stream.operators.sourceorflow;
import akka.NotUsed;
import akka.actor.ActorSystem;
import akka.stream.javadsl.Source;
import java.util.Arrays;
public class FlatMapConcat {
private static ActorSystem system = null;
// #flatmap-concat
// e.g. could be a query to a database
private Source<String, NotUsed> lookupCustomerEvents(String customerId) {
return Source.from(Arrays.asList(customerId + "-event-1", customerId + "-event-2"));
}
// #flatmap-concat
void example() {
// #flatmap-concat
Source.from(Arrays.asList("customer-1", "customer-2"))
.flatMapConcat(this::lookupCustomerEvents)
.runForeach(System.out::println, system);
// prints - events from each customer consecutively
// customer-1-event-1
// customer-1-event-2
// customer-2-event-1
// customer-2-event-2
// #flatmap-concat
}
}

View file

@ -0,0 +1,31 @@
/*
* Copyright (C) 2020 Lightbend Inc. <https://www.lightbend.com>
*/
package docs.stream.operators.sourceorflow
import akka.NotUsed
import akka.actor.ActorSystem
import akka.stream.scaladsl.Source
object FlatMapConcat {
implicit val system: ActorSystem = ActorSystem()
// #flatmap-concat
val source: Source[String, NotUsed] = Source(List("customer-1", "customer-2"))
// e.g. could b a query to a database
def lookupCustomerEvents(customerId: String): Source[String, NotUsed] = {
Source(List(s"$customerId-event-1", s"$customerId-event-2"))
}
source.flatMapConcat(customerId => lookupCustomerEvents(customerId)).runForeach(println)
// prints - events from each customer consecutively
// customer-1-event-1
// customer-1-event-2
// customer-2-event-1
// customer-2-event-2
// #flatmap-concat
}