Circe 编码密封特征和联合产品案例 class 失败

Question

我有以下情况class：

case class SmartMeterData(
  dateInterval: SmartMeterDataInterval = HalfHourInterval(),
  powerUnit: PowerUnit = KWH,
  smartMeterId: String,
  timestamp: String,
  value: Double
) {
  def timeIntervalInDuration: FiniteDuration = dateInterval match {
    case HalfHourInterval(_) => FiniteDuration(30, TimeUnit.MINUTES)
    case FullHourInterval(_) => FiniteDuration(60, TimeUnit.MINUTES)
  }
}
object SmartMeterData {
  sealed trait SmartMeterDataInterval { def interval: String }
  case class HalfHourInterval(interval: String = "HH") extends SmartMeterDataInterval
  case class FullHourInterval(interval: String = "FH") extends SmartMeterDataInterval

  sealed trait PowerUnit
  case object WH  extends PowerUnit
  case object KWH extends PowerUnit
  case object MWH extends PowerUnit
}

我刚刚编写了一个非常简单的单元测试来查看 Circe 是否适用于我的场景：

"SmartMeterData" should "successfully parse from a valid JSON AST" in {
    val js: String = """
      {
        "dateInterval" : "HH",
        "powerUnit" : "KWH",
        "smartMeterId" : "LCID-001-X-54",
        "timestamp" : "2012-10-12 00:30:00.0000000",
        "value" : 23.0
      }
      """
    val expectedSmartMeterData = SmartMeterData(smartMeterId = "LCID-001-X-54", timestamp = "2012-10-12 00:30:00.0000000", value = 23.0)
    decode[SmartMeterData](js) match {
      case Left(err) => fail(s"Error when parsing valid JSON ${err.toString}")
      case Right(actualSmartMeterData) =>
        assert(actualSmartMeterData equals expectedSmartMeterData)
    }
  }

但失败并出现以下错误：

Error when parsing valid JSON DecodingFailure(CNil, List(DownField(dateInterval)))

circe 是否存在已知的局限性，但它不适用于我的上述情况？

Answer 1

Circe 没有理由不能工作，但是按照您设计数据模型的方式，任何可以自动生成 encoder/decoder 工作的 Scala JSON 库的可能性基本上为零无需大量手动工作。

例如

sealed trait SmartMeterDataInterval { def interval: String }
case class HalfHourInterval(interval: String = "HH") extends SmartMeterDataInterval
case class FullHourInterval(interval: String = "FH") extends SmartMeterDataInterval

在任何自动为 case classes 派生实例的 Scala JSON 库中，两者的模式将遵循

{ "interval": "HH" }

对于HalfHourInterval和

 { "interval": "FH" }

for FullHourInterval（即因为每个都有一个名为 interval 的字符串字段，它们实际上是相同的 class）。事实上，您的模型允许您拥有 FullHourInterval("HH")，对于至少一种为 ADT 层次结构生成解码器的方法（文档中使用 shapeless 的方法）将是解码 [=20= 的结果]，因为它本质上采用匹配的词法顺序的第一个构造函数（即 FullHourInterval）。如果目的是只允许完整或半小时的间隔，那么我建议将其表示为：

case object HalfHourInterval extends SmartMeterDataInterval { def interval: String = "HH" } 
case object FullHourInterval extends SmartMeterDataInterval { def interval: String = "FH" }

我并不直接熟悉 circe 如何编码 case objects，但您可以很容易地为 SmartMeterDataInterval:

定义编码器和解码器

object SmartMeterDataInterval {
  implicit val encoder: Encoder[SmartMeterDataInterval] =
    Encoder.encodeString.contramap[SmartMeterDataInterval](_.interval)
  implicit val decoder: Decoder[SmartMeterDataInterval] =
    Decoder.decodeString.emap {
      case "HH" => Right(HalfHourInterval)
      case "FH" => Right(FullHourInterval)
      case _ => Left("not a valid SmartMeterDataInterval")
    }
 }

然后您将执行类似的操作来为 PowerUnit

定义 Encoder/Decoder

Circe 编码密封特征和联合产品案例 class 失败

Circe Encoding Sealed Traits and Co Product Case class Fails

json

scala

shapeless

circe