从案例类中获取字段名称列表

Question

我只需要获取案例类的字段名称。我对它的价值观不感兴趣。 我认为

getClass.getDeclaredFields.map(_.getName)

会返回字段名称列表。

scala> case class User(id: Int, name: String)
defined class User

scala> User.getClass.getDeclaredFields
res14: Array[java.lang.reflect.Field] = Array(public static final User$ User$.MODULE$)

scala> User.getClass.getDeclaredFields.toList
res15: List[java.lang.reflect.Field] = List(public static final User$ User$.MODULE$)

scala> val user = User(1, "dude")
user: User = User(1,dude)

scala> user.getClass.getDeclaredFields.toList
res16: List[java.lang.reflect.Field] = List(private final int User.id, private final java.lang.String User.name)

这个 User$.MODULE$ 是什么？那是什么？

当您有案例类的实例时，方法 getDeclaredFields 可以正常工作，但我不想创建实例来仅获取字段。

为什么这不是真的：

User.getClass.getDeclaredFields.map(_.getName) == List("id", "name")

？

Answer 1

通过使用

User.getClass

，您指的是 Scala 默认为案例类创建的类伴生对象，而不是案例类本身。要获取案例类的类对象，请使用

classOf[User]

。

或者，您可以使用 Scala 的反射 API 来获取案例类的元数据，这会为您提供更多信息：

import scala.reflect.runtime.universe._

def classAccessors[T: TypeTag]: List[MethodSymbol] = typeOf[T].members.collect {
  case m: MethodSymbol if m.isCaseAccessor => m
}.toList

在 sbt 控制台测试：

scala> case class User(name: String, age: Int)
defined class User

scala> classAccessors[User]
res0: List[reflect.runtime.universe.MethodSymbol] = List(value age, value name)

Answer 2

开始

Scala 2.13

、

case classes

（这是

Product

的实现）现在提供了 productElementNames 方法，该方法返回其字段名称的迭代器。

从案例类的实例（比如说

case class Person(name: String, age: Int)

）中，可以检索其字段的

List

：

Person("hello", 28).productElementNames.toList
// List[String] = List(name, age)

Answer 3

遵循 Andrey Tyukin 解决方案，仅获取 Scala 2.12 中的字段列表：

val fields: List[String] = classOf[Dummy].getDeclaredFields.map(_.getName).toList

Answer 4

User.getClass

并不提供与 Java 中的

User.class

等效的功能，但它提供

User

类的伴生对象的类。您可以使用

Class

检索

User

的

classOf[User]

对象。

edit：哦，

User$.MODULE$

是内部使用的单例实例的访问器。当您用 Java 编写单例时，可以将其视为相当于

MyClass.INSTANCE

。

Answer 5

如果您还想知道为什么某些 Scala 反射代码无法再编译，这里有一个使用良好的 ol' Java 反射的粗略解决方案（显然，自大约公元前 1300 年以来，它一直以完全相同的方式工作） :

case class User(b: Int, a: String)
val u = User(42, "JohnDoe")

classOf[User]
.getDeclaredFields
.map{ f => 
  f.setAccessible(true)
  val res = (f.getName, f.get(u))
  f.setAccessible(false)
  res
}

它将同时获取名称和值：

Array((b,42), (a,bob))

顺序似乎与构造函数中的顺序相同。

Answer 6

如果您使用 Spark，这是获取字段的最简单方法：

val cols = Seq(CaseClassModel()).toDF().columns

注意：CaseClassModel 应该初始化字段

Answer 7

使用

Shapeless

提取案例类字段名称

LabelledGeneric

Aux pattern

https://svejcar.dev/posts/2019/10/22/extracting-case-class-field-names-with-shapeless/

“Scala 2.13 在 Product 特征中添加了新方法

productElementNames

”

...但是基于

Shapeless

的方法是作者推荐的

Answer 8

在 Scala 3 中，元编程结构为我们提供了更符合 Scala 习惯的解决方案：

import scala.deriving.Mirror
import scala.compiletime.constValueTuple
case class User(id: Int, name: String)
val userMirror = summon[Mirror.Of[User]]
constValueTuple[userMirror.MirroredElemLabels].toList.asInstanceOf[List[String]]