Cats-tagless - Scala 宏注释错误

Question

我使用cats-tagless lib 创建了一个简单的trait：

@finalAlg
@autoFunctorK(true)
trait MyService[F[_]] {

  def put(element: Element): F[Element]

  def get(elementId: Id): F[Element]

  def all(): F[List[Element]]

  def delete(elementId: Id): F[Unit]
}

但是当我尝试编译它时，我得到了一个错误：

Error:(8, 7) macro annotation could not be expanded (the most common reason for that is that you need to enable the macro paradise plugin; another possibility is that you try to use macro annotation in the same compilation run that defines it)

我还将addCompilerPlugin("org.scalamacros" % "paradise" % "2.1.1" cross CrossVersion.full) 添加到plugins.sbt 文件和build.sbt 中，但没有帮助。你能帮我解决吗？

我的build.sbt 文件如下所示：

addCompilerPlugin(("org.scalameta" % "paradise" % "3.0.0-M11").cross(CrossVersion.full))

lazy val commonSettings = Seq(
  libraryDependencies ++= Seq(
    "org.typelevel" %% "cats-core" % CatsVersion,
    "org.typelevel" %% "cats-effect" % "1.2.0",
    "org.typelevel" %% "cats-tagless-macros" % "0.5",
    "org.typelevel" %% "cats-tagless-legacy-macros" % "0.5",
    "org.typelevel" %% "cats-mtl-core" % "0.5.0",
  )
)

Answer 1

在一个空的新项目中使用这个build.sbt：

scalaVersion := "2.12.8"

libraryDependencies ++= Seq(
  "org.typelevel" %% "cats-tagless-macros" % "0.5",
  "org.typelevel" %% "cats-tagless-legacy-macros" % "0.5"
)

addCompilerPlugin(
  "org.scalameta" % "paradise" % "3.0.0-M11" cross CrossVersion.full
)

这段代码：

import cats.tagless._

case class Element()
case class Id()

@finalAlg
@autoFunctorK(true)
trait MyService[F[_]] {
  def put(element: Element): F[Element]
  def get(elementId: Id): F[Element]
  def all(): F[List[Element]]
  def delete(elementId: Id): F[Unit]
}

编译得很好，正如 here 所宣传的那样。

如果我删除 addCompilerPlugin("org.scalameta" % "paradise" % "3.0.0-M11" cross CrossVersion.full)，我会收到相同的错误消息：

无法扩展宏注解（最常见的原因是您需要启用宏天堂插件；另一种可能是您尝试在定义它的同一编译运行中使用宏注解）

同样，这是记录在案的，链接页面说：

宏注解（@finalAlg、@autoFunctorK、@autoInvariantK等）仍然依赖scalameta，所以需要在build.sbt中添加scalameta依赖。

所以看来你需要它是因为@finalAlg 和@autoFunctorK。

请注意，我没有修改 project/ 中的任何内容。

---

编辑

如果您有多个子项目，则必须将编译器插件添加到实际需要它的子项目中。请注意

addCompilerPlugin(foobar)

本质上只是

libraryDependencies += compilerPlugin(foobar)

所以在你的情况下，你可能应该尝试类似

  libraryDependencies ++= Seq(
    "org.typelevel" %% "cats-core" % "1.6.0",
    "org.typelevel" %% "cats-effect" % "1.2.0",
    "org.typelevel" %% "cats-tagless-macros" % "0.5",
    "org.typelevel" %% "cats-tagless-legacy-macros" % "0.5",
    "org.typelevel" %% "cats-mtl-core" % "0.5.0",
    compilerPlugin(("org.scalameta" % "paradise" % "3.0.0-M11")
      .cross(CrossVersion.full))
  )

然后将其添加到您的 algebra 子项目中。