在运行时获取 Scala 变量名称

Question

是否可以在运行时获取 scala 变量的名称？

例如，是否可以编写一个函数 getIntVarName(variable: Int): String ，其行为如下？

val myInt = 3
assert("myInt" === getIntVarName(myInt))

Answer 1

对于您需要做的事情，在我看来，不需要运行时，因为您已经在编译时定义了 myInt 变量。如果是这种情况，您只需要通过宏进行一些 AST 操作。

请

package com.natalinobusa.macros

import scala.language.experimental.macros
import scala.reflect.macros.blackbox.Context

object Macros {

  // write macros here
  def getName(x: Any): String = macro impl

  def impl(c: Context)(x: c.Tree): c.Tree = {
    import c.universe._
    val p = x match {
      case Select(_, TermName(s)) => s
      case _ => ""
    }
    q"$p"
  }
}

注意，宏必须编译为单独的子项目，并且不能是必须应用宏替换的同一项目的一部分。检查此模板以了解如何定义此类宏子项目： https://github.com/echojc /scala-宏模板

scala> import Macros._
import Macros._

scala> val myInt = 3
myInt: Int = 3

scala> "myInt" == getName(myInt)
res6: Boolean = true

Answer 2

您可以使用 scala-nameof 获取变量名称、函数名称、类成员名称或类型姓名。它发生在编译时，因此不涉及反射，也不需要运行时依赖。

val myInt = 3
assert("myInt" === nameOf(myInt))

将编译为：

val myInt = 3
assert("myInt" === "myInt")

Answer 3

基本上是做不到的。

JVM 不通过方法句柄提供任何内容（请记住，Scala 属性在字节码中被编码为方法以支持统一访问原则）。您可以获得的最接近的方法是使用反射来查找在特定类上定义的方法列表 - 我认为这对您的特定需求没有帮助。

可以将其实现为 Scala 功能，但需要编译器插件从 AST 中获取相关符号名称并将其作为字符串文字推送到代码中，因此我无法演示在一个简短的代码片段中:)

反射中经常出现的另一个命名问题是方法参数。至少这一点我可以帮忙。我这里有一个正在进行中的反射库，它基于编译器生成的 scala 签名，如下所示由scalap使用。它还远未准备好投入实际使用，但正在积极开发中。

Answer 4

在这样的元数据方面，Scala 还没有比 Java 更多的东西。密切关注 Scala Reflection 项目，但我怀疑它会很快提供对局部变量的访问。同时，请考虑使用字节码检查器库，例如 ASM。另一个重要的警告：局部变量名称在编译过程中会丢失，因此您需要在“调试”模式下编译以保留它们。

Answer 5

我认为不可能获取变量的名称，但您可以使用对象尝试：

object Test1 {
  def main(args: Array[String]) {
    object MyVar {
      def value = 1
    }
    println(MyVar.getClass)
  }
}

此打印：class Test1$MyVar$2$。这样你就可以从中得到“MyVar”。

Answer 6

这可以通过 Scala 3 宏来实现（在编译时完成）。

创建一个宏对象（必须位于单独的文件中）：

import scala.quoted.{Expr, Quotes}

object NameFromVariable :

  def inspectCode(x: Expr[Any])(using Quotes): Expr[String] =
    val name = x.show.split("""\.""").last
    Expr(name)

然后您的类中需要一个内联方法。

inline def getIntVarName(inline x: Any): Any = ${ NameFromVariable.inspectCode('x) }

并使用这种方法，例如：

val myInt = 3
assert("myInt" === getIntVarName(myInt))

参见官方文档： https:// docs.scala-lang.org/scala3/guides/macros/macros.html