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

时间:2011-06-08 17:00:53

标签: scala reflection case-class

在Scala中,假设我有一个这样的案例类:

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

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

3 个答案:

答案 0 :(得分:7)

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


一个选项,也与Java兼容,不限于案例类,是使用ParaNamer。在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的结构,这应该被视为启发式。特别是,此代码做出以下假设:

  • 案例类只有一个构造函数。
  • 位置零处签名的输入始终为ClassSymbol
  • 该类的相关构造函数是名为MethodEntry的第一个<init>,其所有者的ID为0。
  • 参数名称具有构造函数条目的所有者,并始终在该条目之后。

它将在嵌套的案例类中失败(因为没有ScalaSig)。

此方法也只返回Class个实例,而不是Manifest s。

请随时提出改进建议!

答案 1 :(得分:3)

这是一个使用普通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

答案 2 :(得分:1)

我又来了(两年后)。这是使用 Scala 反射的不同的不同解决方案。它的灵感来自blog post,它本身的灵感来自Stack Overflow exchange。以下解决方案专门针对上述原始海报的问题。

在一个编译单元(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是一个带有伴随对象的特征,它使用宏来定义此特征的匿名具体子类。宏可以检查你的case类的字段,因为它有关于case类的丰富的编译器级信息。
  3. CaseClassFieldsExtractor及其伴随对象必须在之前的编译单元中声明为检查您的案例类的那个,以便在您想要使用它时存在宏。
  4. 您的案例类型数据通过WeakTypeTag传递。这将评估Scala结构,其中包含大量模式匹配,并且没有我能找到的文档。
  5. 我们再次假设只有一个(&#34; primary&#34;?)构造函数,但我认为Scala中定义的所有类只能有一个构造函数。由于这种技术检查了构造函数的字段,而不是类中的所有JVM字段,因此它不容易因为缺乏一般性而损害我之前的解决方案。
  6. 它使用quasiquotes建立CaseClassFieldsExtractor的匿名,具体的子类。
  7. 所有这些&#34;隐含&#34; business允许定义宏并将其包含在函数调用(caseClassFields)中,而不是在它尚未定义时过早调用。
  8. 任何可以改进此解决方案的评论或解释&#34;究竟是如何影响&#34;做他们做的事(或者如果他们可以被删除)是受欢迎的。