在 Scala 中，如何以编程方式确定案例类的字段名称？

Question

在 Scala 中，假设我有一个像这样的案例类：

case class Sample(myInt: Int, myString: String)

有没有办法让我获得 Seq[(String, Class[_])]，或者更好的是，Seq[( String, Manifest)]，描述案例类的参数？

Answer 1

我正在回答我自己的问题以提供基本解决方案，但我也在寻找替代方案和改进。

---

一种选择是使用 ParaNamer，它也与 Java 兼容并且不限于案例类。在 Scala 中，另一个选项是解析附加到生成的类文件的 ScalaSig 字节。这两种解决方案都不适用于 REPL。

这是我尝试从 ScalaSig 中提取字段名称（使用 scalap 和 Scala 2.8.1）：

def valNames[C: ClassManifest]: Seq[(String, Class[_])] = {
  val cls = classManifest[C].erasure
  val ctors = cls.getConstructors

  assert(ctors.size == 1, "Class " + cls.getName + " should have only one constructor")
  val sig = ScalaSigParser.parse(cls).getOrElse(error("No ScalaSig for class " + cls.getName + ", make sure it is a top-level case class"))

  val classSymbol = sig.parseEntry(0).asInstanceOf[ClassSymbol]
  assert(classSymbol.isCase, "Class " + cls.getName + " is not a case class")

  val tableSize = sig.table.size
  val ctorIndex = (1 until tableSize).find { i =>
    sig.parseEntry(i) match {
      case m @ MethodSymbol(SymbolInfo("<init>", owner, _, _, _, _), _) => owner match {
        case sym: SymbolInfoSymbol if sym.index == 0 => true
        case _ => false
      }
      case _ => false
    }
  }.getOrElse(error("Cannot find constructor entry in ScalaSig for class " + cls.getName))

  val paramsListBuilder = List.newBuilder[String]
  for (i <- (ctorIndex + 1) until tableSize) {
    sig.parseEntry(i) match {
      case MethodSymbol(SymbolInfo(name, owner, _, _, _, _), _) => owner match {
        case sym: SymbolInfoSymbol if sym.index == ctorIndex => paramsListBuilder += name
        case _ =>
      }
      case _ =>
    }
  }

  paramsListBuilder.result zip ctors(0).getParameterTypes
}

免责声明：我不太了解 ScalaSig 的结构，应该考虑这一点作为一种启发式方法。 特别是，此代码做出以下假设：

• Case 类只有一个构造函数。
• 位置零处的签名条目始终是一个ClassSymbol。
• 该类的相关构造函数是第一个名为 的 MethodEntry，其所有者的 ID 为 0。
• 参数名称将构造函数条目作为所有者，并且始终位于该条目之后。

在嵌套案例类上它将失败（因为没有 ScalaSig）。

此方法也仅返回 Class 实例，而不返回 Manifest。

请随时提出改进建议！

Answer 2

这是使用纯 Java 反射的不同解决方案。

case class Test(unknown1: String, unknown2: Int)
val test = Test("one", 2)

val names = test.getClass.getDeclaredFields.map(_.getName)
// In this example, returns Array(unknown1, unknown2).

要获取 Seq[(String, Class[_])]，您可以执行以下操作：

val typeMap = test.getClass.getDeclaredMethods.map({
                x => (x.getName, x.getReturnType)
              }).toMap[String, Class[_]]
val pairs = names.map(x => (x, typeMap(x)))
// In this example, returns Array((unknown1,class java.lang.String), (two,int))

我不确定如何获取 Manifests。

Answer 3

又是我（两年后）。这是使用 Scala 反射的不同解决方案。它的灵感来自 博客文章，其本身的灵感来自于Stack Overflow 交换。下面的解决方案专门针对上述原始发帖者的问题。

在一个编译单元（REPL :paste 或已编译的 JAR）中，包含 scala-reflect 作为依赖项并编译以下内容（在 Scala 2.11 中测试，可能 在 Scala 2.10 中工作）：

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

object CaseClassFieldsExtractor {
  implicit def makeExtractor[T]: CaseClassFieldsExtractor[T] =
    macro makeExtractorImpl[T]

  def makeExtractorImpl[T: c.WeakTypeTag](c: Context):
                              c.Expr[CaseClassFieldsExtractor[T]] = {
    import c.universe._
    val tpe = weakTypeOf[T]

    val fields = tpe.decls.collectFirst {
      case m: MethodSymbol if (m.isPrimaryConstructor) => m
    }.get.paramLists.head

    val extractParams = fields.map { field =>
      val name = field.asTerm.name
      val fieldName = name.decodedName.toString
      val NullaryMethodType(fieldType) = tpe.decl(name).typeSignature

      q"$fieldName -> ${fieldType.toString}"
    }

    c.Expr[CaseClassFieldsExtractor[T]](q"""
      new CaseClassFieldsExtractor[$tpe] {
        def get = Map(..$extractParams)
      }
    """)
  }
}

trait CaseClassFieldsExtractor[T] {
  def get: Map[String, String]
}

def caseClassFields[T : CaseClassFieldsExtractor] =
  implicitly[CaseClassFieldsExtractor[T]].get

在另一个编译单元中（REPL 中的下一行或使用前一行作为依赖项编译的代码），像这样使用它：

scala> case class Something(x: Int, y: Double, z: String)
defined class Something

scala> caseClassFields[Something]
res0: Map[String,String] = Map(x -> Int, y -> Double, z -> String)

这似乎有点矫枉过正，但我​​还没有能够要得到再短一点。它的作用如下：

1. caseClassFields 函数创建一个中间 CaseClassFieldsExtractor，它隐式地存在、报告其发现并消失。
2. CaseClassFieldsExtractor 是一个具有伴随对象的特征，该伴随对象使用宏定义该特征的匿名具体子类。该宏可以检查案例类的字段，因为它具有有关案例类的丰富的编译器级信息。
3. CaseClassFieldsExtractor 及其伴随对象必须在检查案例类的前一个编译单元中声明，以便宏在您想要使用它时存在。
4. 您的案例类的类型数据通过 WeakTypeTag 传入。这评估为具有大量模式匹配的 Scala 结构，但我找不到任何文档。
5. 我们再次假设只有一个（“主”？）构造函数，但我认为 Scala 中定义的所有类只能有一个构造函数。由于该技术检查构造函数的字段，而不是类中的所有 JVM 字段，因此它不会因为缺乏通用性而影响我之前的解决方案。
6. 它使用准引号来构建 CaseClassFieldsExtractor 的匿名具体子类。
7. 所有这些“隐式”业务都允许宏被定义并封装在函数调用 (caseClassFields) 中，而不会在尚未定义时过早调用。

欢迎任何可以完善此解决方案或解释“隐式”如何准确执行其操作（或是否可以将其删除）的评论。

Answer 4

除了 Jim Pivarski 的回答之外，为了获得正确的字段顺序，需要在 decls 之后添加 sorted

val fields = tpe.decls.sorted.collectFirst {
  case m: MethodSymbol if (m.isPrimaryConstructor) => m
}.get.paramLists.head