如何从递归生成值的流创建akka-stream源？

Question

我需要遍历一个形状像树的API。例如，目录结构或讨论的线索。可以通过以下流程对其进行建模：

type ItemId = Int
type Data = String
case class Item(data: Data, kids: List[ItemId])

def randomData(): Data = scala.util.Random.alphanumeric.take(2).mkString 

// 0 => [1, 9]
// 1 => [10, 19]
// 2 => [20, 29]
// ...
// 9 => [90, 99]
// _ => []
// NB. I don't have access to this function, only the itemFlow.
def nested(id: ItemId): List[ItemId] =
  if (id == 0) (1 to 9).toList
  else if (1 <= id && id <= 9) ((id * 10) to ((id + 1) * 10 - 1)).toList
  else Nil

val itemFlow: Flow[ItemId, Item, NotUsed] = 
  Flow.fromFunction(id => Item(randomData, nested(id)))

如何遍历这些数据？我已经完成了以下工作：

import akka.NotUsed
import akka.actor.ActorSystem
import akka.stream._
import akka.stream.scaladsl._

import scala.concurrent.Await
import scala.concurrent.duration.Duration

implicit val system = ActorSystem()
implicit val materializer = ActorMaterializer()

val loop = 
  GraphDSL.create() { implicit b =>
    import GraphDSL.Implicits._

    val source = b.add(Flow[Int])
    val merge  = b.add(Merge[Int](2))
    val fetch  = b.add(itemFlow) 
    val bcast  = b.add(Broadcast[Item](2))

    val kids   = b.add(Flow[Item].mapConcat(_.kids))
    val data   = b.add(Flow[Item].map(_.data))

    val buffer = Flow[Int].buffer(100, OverflowStrategy.dropHead)

    source ~> merge ~> fetch           ~> bcast ~> data
              merge <~ buffer <~ kids  <~ bcast

    FlowShape(source.in, data.out)
  }

val flow = Flow.fromGraph(loop)


Await.result(
  Source.single(0).via(flow).runWith(Sink.foreach(println)),
  Duration.Inf
)

system.terminate()

但是，由于我使用的是带有缓冲区的流，因此Stream永远不会完成。

当上游完成并且已排空缓冲的元素时，

将完成

Flow.buffer

我多次阅读了Graph cycles, liveness, and deadlocks部分，但我仍然在努力寻找答案。

这将创建一个活动锁：

import java.util.concurrent.atomic.AtomicInteger

def unfold[S, E](seed: S, flow: Flow[S, E, NotUsed])(loop: E => List[S]): Source[E, NotUsed] = {
  // keep track of how many element flows, 
  val remaining = new AtomicInteger(1) // 1 = seed

  // should be > max loop(x)
  val bufferSize = 10000

  val (ref, publisher) =
    Source.actorRef[S](bufferSize, OverflowStrategy.fail)
      .toMat(Sink.asPublisher(true))(Keep.both)
      .run()

  ref ! seed

  Source.fromPublisher(publisher)
    .via(flow)
    .map{x =>
      loop(x).foreach{ c =>
        remaining.incrementAndGet()
        ref ! c
      }
      x
    }
    .takeWhile(_ => remaining.decrementAndGet > 0)
}

编辑:我添加了一个git存储库来测试您的解决方案https://github.com/MasseGuillaume/source-unfold

Answer 1

我通过编写自己的GraphStage解决了这个问题。

import akka.NotUsed
import akka.stream._
import akka.stream.scaladsl._
import akka.stream.stage.{GraphStage, GraphStageLogic, OutHandler}

import scala.concurrent.ExecutionContext

import scala.collection.mutable
import scala.util.{Success, Failure, Try}

import scala.collection.mutable

def unfoldTree[S, E](seeds: List[S], 
                     flow: Flow[S, E, NotUsed],
                     loop: E => List[S],
                     bufferSize: Int)(implicit ec: ExecutionContext): Source[E, NotUsed] = {
  Source.fromGraph(new UnfoldSource(seeds, flow, loop, bufferSize))
}

object UnfoldSource {
  implicit class MutableQueueExtensions[A](private val self: mutable.Queue[A]) extends AnyVal {
    def dequeueN(n: Int): List[A] = {
      val b = List.newBuilder[A]
      var i = 0
      while (i < n) {
        val e = self.dequeue
        b += e
        i += 1
      }
      b.result()
    }
  }
}

class UnfoldSource[S, E](seeds: List[S],
                         flow: Flow[S, E, NotUsed],
                         loop: E => List[S],
                         bufferSize: Int)(implicit ec: ExecutionContext) extends GraphStage[SourceShape[E]] {

  val out: Outlet[E] = Outlet("UnfoldSource.out")
  override val shape: SourceShape[E] = SourceShape(out)

  override def createLogic(inheritedAttributes: Attributes): GraphStageLogic = new GraphStageLogic(shape) with OutHandler {  
    // Nodes to expand
    val frontier = mutable.Queue[S]()
    frontier ++= seeds

    // Nodes expanded
    val buffer = mutable.Queue[E]()

    // Using the flow to fetch more data
    var inFlight = false

    // Sink pulled but the buffer was empty
    var downstreamWaiting = false

    def isBufferFull() = buffer.size >= bufferSize

    def fillBuffer(): Unit = {
      val batchSize = Math.min(bufferSize - buffer.size, frontier.size)
      val batch = frontier.dequeueN(batchSize)
      inFlight = true

      val toProcess =
        Source(batch)
          .via(flow)
          .runWith(Sink.seq)(materializer)

      val callback = getAsyncCallback[Try[Seq[E]]]{
        case Failure(ex) => {
          fail(out, ex)
        }
        case Success(es) => {
          val got = es.size
          inFlight = false
          es.foreach{ e =>
            buffer += e
            frontier ++= loop(e)
          }
          if (downstreamWaiting && buffer.nonEmpty) {
            val e = buffer.dequeue
            downstreamWaiting = false
            sendOne(e)
          } else {
            checkCompletion()
          }
          ()
        }
      }

      toProcess.onComplete(callback.invoke)
    }
    override def preStart(): Unit = {
      checkCompletion()
    }

    def checkCompletion(): Unit = {
      if (!inFlight && buffer.isEmpty && frontier.isEmpty) {
        completeStage()
      }
    } 

    def sendOne(e: E): Unit = {
      push(out, e)
      checkCompletion()
    }

    def onPull(): Unit = {
      if (buffer.nonEmpty) {
        sendOne(buffer.dequeue)
      } else {
        downstreamWaiting = true
      }

      if (!isBufferFull && frontier.nonEmpty) {
        fillBuffer()
      }
    }

    setHandler(out, this)
  }
}

Answer 2

未完成的原因

我不认为流永远不会完成的原因是由于“使用带有缓冲区的流”。与this question类似的实际原因是，使用默认参数eagerClose=False的合并在source和buffer完成之前都在等待它(合并)完成。但缓冲区正在等待合并完成。所以merge正在等待缓冲区，而buffer正在等待合并。

eagerClose merge

您可以在创建合并时设置eagerClose=True。但不幸的是，使用急切关闭可能会导致一些子ItemId值永远不会被查询。

间接解决方案

如果您为树的每个级别物化一个新的流，那么可以将递归提取到流的外部。

您可以使用itemFlow构造查询函数

val itemQuery : Iterable[ItemId] => Future[Seq[Data]] = 
  (itemIds) => Source.apply(itemIds)
                     .via(itemFlow)
                     .runWith(Sink.seq[Data])

此查询函数现在可以包装在递归助手函数中：

val recQuery : (Iterable[ItemId], Iterable[Data]) => Future[Seq[Data]] = 
  (itemIds, currentData) => itemQuery(itemIds) flatMap { allNewData =>
      val allNewKids = allNewData.flatMap(_.kids).toSet

      if(allNewKids.isEmpty)
        Future.successful(currentData ++ allNewData)
      else
        recQuery(allNewKids, currentData ++ data)
  }

创建的流的数量将等于树的最大深度。

不幸的是，由于涉及Futures，这个递归函数不是尾递归，如果树太深，可能会导致“堆栈溢出”。

Answer 3

啊，阿卡溪中循环的乐趣。我有一个非常类似的问题，我以一种非常棘手的方式解决了它。这可能会对你有所帮助。

黑客解决方案：

  // add a graph stage that will complete successfully if it sees no element within 5 seconds
  val timedStopper = b.add(
    Flow[Item]
      .idleTimeout(5.seconds)
      .recoverWithRetries(1, {
        case _: TimeoutException => Source.empty[Item]
      }))

  source ~> merge ~> fetch ~> timedStopper ~> bcast ~> data
  merge <~ buffer <~ kids <~ bcast

这样做是在最后一个元素通过timedStopper阶段后5秒，该阶段成功地完成了流。这是通过使用idleTimeout来实现的，它使用TimeoutException使流失败，然后使用recoverWithRetries将失败转化为成功的完成。(我确实提到过它很麻烦)。

如果元素之间的间隔可能超过5秒，或者如果您不能承受流“实际”完成和Akka拾取之间的长时间等待，这显然是不合适的。谢天谢地，这两个都不是我们关心的问题，在这种情况下，它实际上工作得很好！

非hacky解决方案

不幸的是，我能想到的不通过超时作弊的唯一方法是非常非常复杂的。

基本上，您需要能够跟踪两件事：

• 是否有任何元素仍在缓冲区中，或正在被发送到缓冲区中
• 是传入的源代码开放

当且仅当两个问题的答案都为否时，才完成流。原生Akka构建块可能无法处理此问题。但是，自定义图形阶段可能会。一种选择可能是编写一个替代Merge的程序，并让它以某种方式了解缓冲区的内容，或者可能让它跟踪它接收的is和广播发送到缓冲区的is。问题是，即使在最好的情况下，自定义图阶段的编写也不是特别令人愉快，更不用说在像这样的阶段中混合逻辑了。

警告

Akka流不能很好地处理循环，特别是它们计算完成的方式。因此，这可能不是您遇到的唯一问题。

例如，我们在非常相似的结构中遇到的一个问题是，源中的失败被视为流成功完成，并实现了成功的Future。问题是，在默认情况下，失败的阶段将使其下行失败，但会取消其上行(对于这些阶段，这将被视为成功完成)。对于像你这样的循环，结果是一场竞争，因为取消沿着一个分支传播，而失败则沿着另一个分支传播。您还需要检查如果接收器出错会发生什么情况；根据广播的取消设置，取消可能不会向上传播，而源将愉快地继续引入元素。

最后一个选择:完全避免处理流的递归逻辑。在一个极端情况下，如果有任何方法可以让您编写一个尾递归方法，一次取出所有嵌套项并将其放入流阶段，那么您的问题就解决了。另一方面，我们正在认真考虑为我们自己的系统使用Kafka队列。