Cats Effect 3 入门指南：函数式并发编程基础

Cats Effect 3 入门指南：函数式并发编程基础

什么是 Cats Effect

Cats Effect 是一个强大的 Scala 函数式编程库，它提供了一套完整的工具集来处理异步和并发编程。它基于纯函数式编程原则，特别是"效果"（effect）的概念，使得开发者能够以声明式的方式构建可靠、可组合的并发应用程序。

环境配置

添加依赖

要开始使用 Cats Effect 3，首先需要在项目中添加依赖。对于 SBT 项目，在 build.sbt 文件中添加：

libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.7"

对于 ScalaJS 项目，使用三个百分号 %%% 替代两个百分号 %%。

编译器插件推荐

对于 Scala 2 用户，强烈建议添加 better-monadic-for 编译器插件，它可以修复 Scala 语言中 for 推导式的一些意外行为：

addCompilerPlugin("com.olegpy" %% "better-monadic-for" % "0.3.1")

编译器选项

建议启用非单位语句警告，这有助于捕获潜在的问题：

scalacOptions += "-Wnonunit-statement"

第一个 Cats Effect 程序

创建一个简单的 Cats Effect 应用程序非常简单。以下是一个打印"Hello, World!"的完整示例：

import cats.effect.{IO, IOApp}

object HelloWorld extends IOApp.Simple {
  val run = IO.println("Hello, World!")
}

这个程序可以通过 sbt run 命令运行。IOApp.Simple 是 Cats Effect 提供的便捷入口点，特别适合简单的应用程序。

并发编程示例

Cats Effect 的强大之处在于其简洁而强大的并发原语。下面是一个有趣的 FizzBuzz 变体实现，展示了如何使用轻量级线程（纤维）进行并发编程：

import cats.effect.{IO, IOApp}
import scala.concurrent.duration._

object StupidFizzBuzz extends IOApp.Simple {
  val run =
    for {
      ctr <- IO.ref(0)

      wait = IO.sleep(1.second)
      poll = wait *> ctr.get

      _ <- poll.flatMap(IO.println(_)).foreverM.start
      _ <- poll.map(_ % 3 == 0).ifM(IO.println("fizz"), IO.unit).foreverM.start
      _ <- poll.map(_ % 5 == 0).ifM(IO.println("buzz"), IO.unit).foreverM.start

      _ <- (wait *> ctr.update(_ + 1)).foreverM.void
    } yield ()
}

这个例子展示了：

1. 使用 IO.ref 创建可变状态
2. 使用 start 方法启动并发纤维
3. 组合多个 IO 操作
4. 使用 foreverM 创建无限循环

REPL 交互

在 REPL 环境中试验 Cats Effect 非常方便。推荐使用 Ammonite REPL：

import $ivy.`org.typelevel::cats-effect:3.5.7`

import cats.effect.unsafe.implicits._
import cats.effect.IO

val program = IO.println("Hello, World!")
program.unsafeRunSync()

注意：unsafeRunSync() 仅适用于 REPL 环境，不应在生产代码中使用。

取消长时间运行的任务

在 REPL 中，可以使用 unsafeRunCancelable() 来启动可取消的任务：

import cats.effect.unsafe.implicits._
import cats.effect.IO

lazy val loop: IO[Unit] = IO.println("loop until cancel..") >> IO.sleep(2.seconds) >> loop
val cancel = loop.unsafeRunCancelable()

调用 cancel() 可以停止这个无限循环的任务。

测试框架集成

MUnit 集成

MUnit 是一个流行的 Scala 测试框架，与 Cats Effect 集成良好：

libraryDependencies += "org.typelevel" %% "munit-cats-effect-3" % "1.0.6" % Test

测试示例：

import cats.effect.IO
import munit.CatsEffectSuite

class ExampleSuite extends CatsEffectSuite {
  test("IO 计算结果正确") {
    IO.pure(1).map(_ + 2) flatMap { result =>
      IO(assertEquals(result, 3))
    }
  }
}

Weaver 测试框架

Weaver 是专为 Cats Effect 设计的测试框架，特别适合大量 I/O 操作的测试：

libraryDependencies += "com.disneystreaming" %% "weaver-cats" % "0.7.6" % Test
testFrameworks += new TestFramework("weaver.framework.CatsEffect")

测试示例：

import cats.effect.IO
import weaver._

object ExampleSuite extends SimpleIOSuite {
  test("IO 计算结果正确") {
    IO.pure(1).map(_ + 2) map { result =>
      expect.eql(result, 3)
    }
  }
}

其他测试框架支持

Cats Effect 还支持多种其他测试框架，包括 ScalaTest、Specs2、µTest 和 MiniTest。例如，与 Specs2 集成：

libraryDependencies += "org.typelevel" %% "cats-effect-testing-specs2" % "1.2.0" % Test

测试示例：

import cats.effect.IO
import cats.effect.testing.specs2.CatsEffect
import org.specs2.mutable.Specification

class ExampleSpec extends Specification with CatsEffect {
  "示例" should {
    "验证 IO 计算结果" in {
      IO.pure(1).map(_ + 2) flatMap { result =>
        IO(result mustEqual 3)
      }
    }
  }
}

总结

Cats Effect 3 提供了一套完整的工具集，使得在 Scala 中进行函数式并发编程变得简单而强大。从基本的 IO 操作到复杂的并发模式，Cats Effect 都能提供优雅的解决方案。通过本文的入门指南，您应该已经掌握了开始使用 Cats Effect 所需的基础知识。