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

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)

这个用户$ .MODULE $是什么？那是什么？

方法getDeclaredFields在你有一个case类的实例时工作正常，但是我不想创建一个实例以便只获取字段。

为什么这不是真的： 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

现在为Product的Scala 2.13，case classes（它们是productElementNames的实现）提供了一种{{3}}方法，该方法返回其字段名称上的迭代器。

从案例类的一个实例（例如case class Person(name: String, age: Int)）中，可以检索其字段中的List：

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

Answer 3

User.getClass在Java中没有提供等效的User.class，但它为您提供了User类的伴随对象的类。您可以使用Class检索User classOf[User]对象。

编辑：哦，User$.MODULE$是内部使用的单例实例的访问者。当你用Java编写单例时，可以认为它等同于MyClass.INSTANCE。

Answer 4

如果您还想知道为什么某些Scala反射代码不再编译，这是具有良好Java反射效果的粗略解决方案（显然，自1300年以来，它一直以完全相同的方式工作BC）：

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 5

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

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

注意：CaseClassModel应该已初始化字段

Answer 6

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

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

Answer 7

使用 Shapeless

提取案例类字段名称

LabelledGeneric Aux pattern

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

<块引用>

“Scala 2.13 在 Product trait 中添加了新方法 productElementNames”

...但作者推荐基于 Shapeless 的方法