功能性 Scala 日志累加器

Question

我主要使用 cats 库开发一个 Scala 项目。在那里，我们有像

这样的电话

for {
   _ <- initSomeServiceAndLog("something from a far away service")
   _ <- initSomeOtherServiceAndLog("something from another far away service")
   a <- b()
   c <- d(a)
  } yield c

想象一下 b 也记录了一些东西或者可能抛出一个业务错误（我知道，我们避免抛出 Scala，但现在不是这样）。我正在寻找一种解决方案来累积日志并最终将它们全部打印在一条消息中。为了开心，我看到 Cats 的 Writer Monad 可能是一个可以接受的解决方案。但是如果 b 方法抛出怎么办？要求是记录所有内容——所有以前的日志和错误消息，在一条消息中，带有某种唯一的跟踪 ID。有什么想法吗？提前致谢

Answer 1

使用 Writer (WriterT) 或 State (StateT) 等 monad 转换器实现功能性日志记录（以一种即使发生错误也能保留日志的方式）很难。但是，如果我们对 FP 方法不感兴趣，我们可以执行以下操作：

使用一些 IO monad
用它创建类似日志的内存存储
但是以功能方式实现

我个人会选择 cats.effect.concurrent.Ref 或 monix.eval.TaskLocal。

使用参考（和任务）的示例：

type Log = Ref[Task, Chain[String]]
type FunctionalLogger = String => Task[Unit]
val createLog: Task[Log] = Ref.of[Task, Chain[String]](Chain.empty)
def createAppender(log: Log): FunctionalLogger =
  entry => log.update(chain => chain.append(entry))
def outputLog(log: Log): Task[Chain[String]] = log.get

有了这样的帮手，我可以：

def doOperations(logger: FunctionalLogger) = for {
  _ <- operation1(logger) // logging is a side effect managed by IO monad
  _ <- operation2(logger) // so it is referentially transparent
} yield result

createLog.flatMap { log =>
  doOperations(createAppender(log))
    .recoverWith(...)
    .flatMap { result =>
       outputLog(log)
       ...
    }
}

但是，确保调用输出有点麻烦，因此我们可以使用某种形式的 Bracket 或 Resource 来处理它：

val loggerResource: Resource[Task, FunctionalLogger] = Resource.make {
  createLog // acquiring resource - IO operation that accesses something
} { log =>
  outputLog(log) // releasing resource - works like finally in try-catchso it should
    .flatMap(... /* log entries or sth */) // be called no matter if error occured
}.map(createAppender)

loggerResource.use { logger =>
  doSomething(logger)
}

如果你不喜欢显式地传递这个附加程序，你可以使用 Kleisli 来注入它：

type WithLogger[A] = Kleisli[Task, FunctionalLogger, A]

// def operation1: WithLogger[A]
// def operation2: WithLogger[B]

def doSomething: WithLogger[C] = for {
  a <- operation1
  b <- operation2
} yield c

loggerResource.use { logger =>
  doSomething(logger)
}

TaskLocal 的使用方式非常相似。

一天结束时，您将得到：

表示正在记录的类型
可变性通过 IO 管理，因此引用透明性不会丢失
确定即使 IO 失败，也会保留日志并发送结果

我相信有些纯粹主义者不会喜欢这个解决方案，但它具有 FP 的所有优点，所以我个人会使用它。

功能性 Scala 日志累加器

Functional scala log accumulator

scala

logging

scala-cats