要在 Scala 中映射的案例类

Question

有没有一种好的方法可以将 Scala case class 实例转换

case class MyClass(param1: String, param2: String)
val x = MyClass("hello", "world")

为某种映射，例如

getCCParams(x) returns "param1" -> "hello", "param2" -> "world"

适用于任何 case 类，而不仅仅是预定义的。 我发现您可以通过编写询问底层 Product 类的方法来提取案例类名称，例如，

def getCCName(caseobj: Product) = caseobj.productPrefix 
getCCName(x) returns "MyClass"

所以我正在寻找类似的解决方案，但针对案例类字段。 我想象一个解决方案可能必须使用 Java 反射，但我不想编写一些如果案例类的底层实现发生变化的话可能会在 Scala 的未来版本中中断的东西。

目前，我正在开发 Scala 服务器，并使用案例类定义协议及其所有消息和异常，因为它们是一个如此美丽、简洁的构造。 但随后我需要将它们转换为 Java 映射，以便通过消息传递层发送以供任何客户端实现使用。 我当前的实现只是分别为每个案例类定义一个翻译，但最好找到一个通用的解决方案。

Answer 1

Scala 3 的现代变体也可能会稍微简化，如以下示例所示，该示例类似于 Walter Chang 如上所述。

def getCCParams(cc: AnyRef): Map[String, Any] =
  cc.getClass.getDeclaredFields
    .tapEach(_.setAccessible(true))
    .foldLeft(Map.empty)((a, f) => a + (f.getName -> f.get(cc)))

Answer 2

使用Java反射，但访问级别没有改变。 将 Product 和 case 类转换为 Map[String, String]：

def productToMap[T <: Product](obj: T, prefix: String): Map[String, String] = {
  val clazz = obj.getClass
  val fields = clazz.getDeclaredFields.map(_.getName).toSet
  val methods = clazz.getDeclaredMethods.filter(method => fields.contains(method.getName))
  methods.foldLeft(Map[String, String]()) { case (acc, method) =>
    val value = method.invoke(obj).toString
    val key = if (prefix.isEmpty) method.getName else s"${prefix}_${method.getName}"
    acc + (key -> value)
  }
}

Answer 3

因为案例类扩展了 Product，所以可以简单地使用 .productIterator 来获取字段值：

def getCCParams(cc: Product) = cc.getClass.getDeclaredFields.map( _.getName ) // all field names
                .zip( cc.productIterator.to ).toMap // zipped with all values

或者：

def getCCParams(cc: Product) = {          
      val values = cc.productIterator
      cc.getClass.getDeclaredFields.map( _.getName -> values.next ).toMap
}

Product 的一个优点是您无需在字段上调用 ​​setAccessible 来读取其值。 另一个是productIterator不使用反射。

请注意，此示例适用于简单的案例类，这些类不会扩展其他类，也不会在构造函数之外声明字段。

Answer 4

这应该有效：

def getCCParams(cc: AnyRef) =
  cc.getClass.getDeclaredFields.foldLeft(Map.empty[String, Any]) { (a, f) =>
    f.setAccessible(true)
    a + (f.getName -> f.get(cc))
  }

Answer 5

从 Scala 2.13 开始，case 类（作为 Product）随 productElementNames 方法，返回字段名称的迭代器。

通过压缩字段名称和通过 productIterator 我们一般可以获取关联的Map：

// case class MyClass(param1: String, param2: String)
// val x = MyClass("hello", "world")
(x.productElementNames zip x.productIterator).toMap
// Map[String,Any] = Map("param1" -> "hello", "param2" -> "world")

Answer 6

如果有人寻找递归版本，这里是 @Andrejs 解决方案的修改：

def getCCParams(cc: Product): Map[String, Any] = {
  val values = cc.productIterator
  cc.getClass.getDeclaredFields.map {
    _.getName -> (values.next() match {
      case p: Product if p.productArity > 0 => getCCParams(p)
      case x => x
    })
  }.toMap
}

它还将嵌套的案例类扩展为任何嵌套级别的映射。

Answer 7

如果您不关心将其设为通用函数，那么这是一个简单的变体：

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

def personToMap(person: Person): Map[String, Any] = {
  val fieldNames = person.getClass.getDeclaredFields.map(_.getName)
  val vals = Person.unapply(person).get.productIterator.toSeq
  fieldNames.zip(vals).toMap
}

scala> println(personToMap(Person("Tom", 50)))
res02: scala.collection.immutable.Map[String,Any] = Map(name -> Tom, age -> 50)

Answer 8

如果您碰巧使用 Json4s，您可以执行以下操作：

import org.json4s.{Extraction, _}

case class MyClass(param1: String, param2: String)
val x = MyClass("hello", "world")

Extraction.decompose(x)(DefaultFormats).values.asInstanceOf[Map[String,String]]

Answer 9

使用解释器包中的 ProductCompletion 解决方案：

import tools.nsc.interpreter.ProductCompletion

def getCCParams(cc: Product) = {
  val pc = new ProductCompletion(cc)
  pc.caseNames.zip(pc.caseFields).toMap
}

Answer 10

我不知道nice...但这似乎有效，至少对于这个非常非常基本的例子来说。 它可能需要一些工作，但可能足以让您开始？ 基本上它会过滤掉案例类（或任何其他类：/）中的所有“已知”方法

object CaseMappingTest {
  case class MyCase(a: String, b: Int)

  def caseClassToMap(obj: AnyRef) = {
    val c = obj.getClass
    val predefined = List("$tag", "productArity", "productPrefix", "hashCode",
                          "toString")
    val casemethods = c.getMethods.toList.filter{
      n =>
        (n.getParameterTypes.size == 0) &&
        (n.getDeclaringClass == c) &&
        (! predefined.exists(_ == n.getName))

    }
    val values = casemethods.map(_.invoke(obj, null))
    casemethods.map(_.getName).zip(values).foldLeft(Map[String, Any]())(_+_)
  }

  def main(args: Array[String]) {
    println(caseClassToMap(MyCase("foo", 1)))
    // prints: Map(a -> foo, b -> 1)
  }
}

Answer 11

你可以使用无形的。

让

case class X(a: Boolean, b: String,c:Int)
case class Y(a: String, b: String)

定义一个LabelledGeneric表示

import shapeless._
import shapeless.ops.product._
import shapeless.syntax.std.product._
object X {
  implicit val lgenX = LabelledGeneric[X]
}
object Y {
  implicit val lgenY = LabelledGeneric[Y]
}

定义两个类型类来提供toMap方法

object ToMapImplicits {

  implicit class ToMapOps[A <: Product](val a: A)
    extends AnyVal {
    def mkMapAny(implicit toMap: ToMap.Aux[A, Symbol, Any]): Map[String, Any] =
      a.toMap[Symbol, Any]
        .map { case (k: Symbol, v) => k.name -> v }
  }

  implicit class ToMapOps2[A <: Product](val a: A)
    extends AnyVal {
    def mkMapString(implicit toMap: ToMap.Aux[A, Symbol, Any]): Map[String, String] =
      a.toMap[Symbol, Any]
        .map { case (k: Symbol, v) => k.name -> v.toString }
  }
}

然后你可以像这样使用它。

object Run  extends App {
  import ToMapImplicits._
  val x: X = X(true, "bike",26)
  val y: Y = Y("first", "second")
  val anyMapX: Map[String, Any] = x.mkMapAny
  val anyMapY: Map[String, Any] = y.mkMapAny
  println("anyMapX = " + anyMapX)
  println("anyMapY = " + anyMapY)

  val stringMapX: Map[String, String] = x.mkMapString
  val stringMapY: Map[String, String] = y.mkMapString
  println("anyMapX = " + anyMapX)
  println("anyMapY = " + anyMapY)
}

打印

anyMapX = 地图(c -> 26, b -> 自行车, a -> true)

anyMapY = Map(b -> 第二个, a -> 第一个)

stringMapX = Map(c -> 26, b -> 自行车, a -> true)

stringMapY = Map(b -> 第二个, a -> 第一个)

对于嵌套案例类，（因此嵌套映射）
检查另一个答案

Answer 12

commons.mapper.Mappers.Mappers.beanToMap(caseClassBean)

详细信息：https://github.com/hank-whu/common4s