在IntelliJ 2017中使用Scala宏注解打印方法返回值

我来帮你把这个Scala宏注解补全完善，让它能自动帮你打印方法的返回值～下面是完整的可运行代码，还有详细的解释和适配IntelliJ 2017的注意事项：

import scala.annotation.StaticAnnotation
import scala.language.experimental.macros
import scala.reflect.macros.blackbox

class PrintResult extends StaticAnnotation {
  def macroTransform(annottees: Any*): Any = macro PrintResult.impl
}

object PrintResult {
  def impl(c: blackbox.Context)(annottees: c.Expr[Any]*): c.Expr[Any] = {
    import c.universe._

    val result = annottees.map(_.tree).toList match {
      // 匹配带注解的方法定义
      case q"$mods def $methodName(...$args): $returnType = { ..$body }" :: Nil =>
        q"""
          $mods def $methodName(...$args): $returnType = {
            // 执行原方法体拿到结果
            val res = { ..$body }
            // 打印方法名和返回值
            println(s"Method '$methodName' returned: \$res")
            // 返回原结果，保证方法原有逻辑不变
            res
          }
        """
      // 处理注解用错地方的情况
      case _ =>
        c.abort(c.enclosingPosition, "@PrintResult 只能应用在方法上哦")
    }

    c.Expr[Any](result)
  }
}

关键部分拆解 #

• 宏注解核心入口：StaticAnnotation和macroTransform是Scala宏注解的基础结构，blackbox.Context是黑盒宏的上下文（Scala 2.11+推荐用黑盒宏，兼容性更好）。
• 匹配方法语法树：用q"..."字符串插值来匹配方法的抽象语法树（AST），把方法的修饰符、名称、参数、返回类型和方法体都提取出来，这样才能对方法逻辑做修改。
• 注入打印逻辑：生成的新方法会先执行原方法体拿到结果，打印方法名和返回值，再把结果返回——完全不影响原方法的功能，只是多了打印的附加逻辑。
• 错误提示：如果注解被误用到类、变量等非方法元素上，直接抛出编译错误，明确告诉用户正确的使用方式。

IntelliJ 2017适配注意点 #

• Scala版本选择：优先选2.11.x或2.12.x版本，IntelliJ 2017对Scala 2.13的支持有限，容易出现兼容性问题。
• 项目依赖配置：如果用sbt构建项目，需要在build.sbt里添加以下配置，保证宏注解能正常编译：

  libraryDependencies += "org.scala-lang" % "scala-reflect" % scalaVersion.value % Provided
  scalacOptions += "-language:experimental.macros"
  

• IDE开启宏支持：进入File > Settings > Languages & Frameworks > Scala > Compiler，勾选相关的实验性选项，避免IDE报不必要的红标。

使用示例 #

写个测试类试试效果：

object Test {
  @PrintResult
  def add(a: Int, b: Int): Int = a + b

  def main(args: Array[String]): Unit = {
    add(2, 3) // 运行后会打印：Method 'add' returned: 5
  }
}

运行main方法，就能看到方法的返回值被自动打印出来啦～

内容的提问来源于stack exchange，提问作者locorecto