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

【问题标题】：Get field names list from case class从案例类中获取字段名称列表
【发布时间】：2015-07-02 16:19:19
【问题描述】：

我只需要获取案例类的字段名称。我对它的价值观不感兴趣。我以为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")?

【问题讨论】：

标签： scala

【解决方案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)

【讨论】：

它们似乎以 lexo 顺序返回。有没有办法让它们按照代码中声明的顺序返回？
这个答案有一个线程解释了如何按顺序排列：stackoverflow.com/a/16079804/1586965

【解决方案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)

【讨论】：

太好了！哦，我在 spark .. 2.13 在 spark 4 中，这将是 3 年
这种方法令人沮丧的是你需要一个相关类型的实例，这在某些情况下并不理想

【解决方案3】：

User.getClass 没有给你相当于 Java 中的User.class，但它给了你User 类的伴生对象的类。您可以使用classOf[User] 检索User 的Class 对象。

edit：哦，User$.MODULE$ 是内部使用的单例实例的访问器。当您在 Java 中编写单例时，可以将其视为等同于 MyClass.INSTANCE。

【讨论】：

【解决方案4】：

如果您还想知道为什么某些 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))

顺序好像和构造函数中的一样。

【讨论】：

这种方法很好，但请注意，如果您有任何成员字段不在默认构造函数中，.getDeclaredFields 也会返回这些字段，并且不会区分两者
@Andrey Tyukin，如何在通用方法中使用它 def getFields[T]() : List[Field] = ???

【解决方案5】：

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

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

【讨论】：

【解决方案6】：

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

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

注意：CaseClassModel 应该初始化字段

【讨论】：

请您在您的代码中添加更多内容@Devendra Parhate

【解决方案7】：

用Shapeless提取案例类字段名

LabelledGenericAux pattern

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

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

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

【讨论】：