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 没有理由不能工作，但是你设计数据 model 的方式，基本上没有任何 Scala JSON 库的机会可以自动生成没有大量手动工作的编码器/解码器。

例如

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

两者的架构，在任何 Scala JSON 库中，它自动为case class es 派生实例，将沿着

{ "interval": "HH" }

对于HalfHourInterval和

 { "interval": "FH" }

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

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

我并不直接熟悉 circe 如何对case object SmartMeterDataInterval进行编码，但是您可以很容易地为 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