我应该如何在 Scala 中指定类似 JSON 的非结构化数据的类型？

Question

我正在考虑将一个非常简单的文本模板库移植到 Scala，主要作为学习该语言的练习。 该库目前是用 Python 和 Javascript 实现的，其基本操作或多或少可以归结为（在 python 中）：

template = CompiledTemplate('Text {spam} blah {eggs[1]}')
data = { 'spam': 1, 'eggs': [ 'first', 'second', { 'key': 'value' }, true ] }
output = template.render(data)

在 Scala 中，这一切都不是非常困难，但我不清楚的是如何最好地做到这一点表示data参数的静态类型。

基本上，这个参数应该能够包含您在 JSON 中找到的各种内容：一些基元（字符串、整数、布尔值、null），或者零个或多个项目的列表，或者零个或多个项目的映射。 （就这个问题而言，映射可以被限制为具有字符串键，这似乎是 Scala 喜欢的方式。）

我最初的想法只是使用 Map[string, Any] 作为一个顶级对象，但这对我来说似乎并不完全正确。 事实上，我不想在其中添加任何类型的任意对象； 我只想要上面概述的元素。 同时，我认为在 Java 中我真正能够得到的最接近的是 Map，而且我知道 Scala 作者之一设计了 Java 的泛型。

我特别好奇的一件事是具有类似类型系统的其他函数式语言如何处理此类问题。 我有一种感觉，我真正想做的是提出一组可以进行模式匹配的案例类，但我不太能够想象它会是什么样子。

我有用 Scala 编程，但说实话，我的眼睛开始对协变/逆变的东西有点茫然，我希望有人能更清楚、更简洁地向我解释这一点。

Answer 1

您发现您需要某种案例类来对您的数据类型进行建模。 在函数式语言中，这些东西被称为“抽象数据类型”，你可以通过谷歌搜索来阅读有关 Haskell 如何使用它们的所有内容。 Scala 相当于 Haskell 的 ADT，使用密封特征和案例类。

让我们看一下 Scala 标准库或《Scala 编程》中对 JSON 解析器组合器的重写书。 它没有使用 Map[String, Any] 来表示 JSON 对象，也没有使用 Any 来表示任意 JSON 值，而是使用抽象数据类型 JsValue 来表示 JSON 值。 JsValue 有多个子类型，代表 JSON 值的可能类型：JsString、JsNumber、JsObject、JsArray、JsBoolean（JsTrue、JsFalse）和 JsNull。

操作这种形式的 JSON 数据涉及模式匹配。 由于 JsValue 是密封的，如果您没有处理所有情况，编译器会警告您。 例如，toJson 的代码（一种采用 JsValue 并返回该值的 String 表示形式的方法）如下所示

  def toJson(x: JsValue): String = x match {
    case JsNull => "null"
    case JsBoolean(b) => b.toString
    case JsString(s) => "\"" + s + "\""
    case JsNumber(n) => n.toString
    case JsArray(xs) => xs.map(toJson).mkString("[",", ","]")
    case JsObject(m) => m.map{case (key, value) => toJson(key) + " : " + toJson(value)}.mkString("{",", ","}")
  }

：两者都让我们确保我们正在处理每种情况，并且还从其 JsType 中“解开”底层值。 它提供了一种类型安全的方式来了解我们已经处理了每个案例。

此外，如果您在编译时知道正在处理的 JSON 数据的结构，您可以做一些非常酷的事情，例如 n8han 的提取器。 很强大的东西，大家看看吧。

Answer 2

嗯，有几种方法可以解决这个问题。 我可能只会使用 Map[String, Any] ，它应该可以很好地满足您的目的（只要地图来自 collection.immutable 而不是 集合.可变的）。 但是，如果您真的想要经历一些痛苦，可以为此给出一个类型：

sealed trait InnerData[+A] {
  val value: A
}

case class InnerString(value: String) extends InnerData[String]
case class InnerMap[A, +B](value: Map[A, B]) extends InnerData[Map[A, B]]
case class InnerBoolean(value: Boolean) extends InnerData[Boolean]

现在，假设您正在将 JSON data 字段读入 Scala名为 jsData 的字段，您可以为该字段指定以下类型：

val jsData: Map[String, Either[Int, InnerData[_]]

每次从 jsData 中提取字段时，您都需要进行模式匹配，检查该值是否为类型 Left[Int] 或 Right[InnerData[_]] （Either[Int, InnerData[_]] 的两个子类型）。 获得内部数据后，您可以对其进行模式匹配，以确定它是否表示 InnerString、InnerMap 或 InnerBoolean< /代码>。

从技术上讲，无论如何，您都必须执行这种模式匹配，以便在从 JSON 中提取数据后使用该数据。 类型正确的方法的优点是编译器会检查您以确保您没有错过任何可能性。 缺点是您不能跳过不可能的事情（例如 'eggs' 映射到 Int）。 此外，所有这些包装对象都会产生一些开销，因此请注意这一点。

请注意，Scala 确实允许您定义一个类型别名，这应该减少为此所需的 LoC 数量：

type DataType[A] = Map[String, Either[Int, InnerData[A]]]

val jsData: DataType[_]

添加一些隐式转换以使 API 变得漂亮，您应该一切都很好。

Answer 3

在“Scala 编程”中有关组合器解析的章节中，使用 JSON 作为示例。