Question

这个问题最近出现了几次，所以我在这里常见问题。假设我有一些像这样的案例类：

import io.circe._, io.circe.generic.semiauto._

object model {
  case class A(a: String)
  case class B(a: String, i: Int)
  case class C(i: Int, b: Boolean)

  implicit val encodeA: Encoder[A] = deriveEncoder
  implicit val encodeB: Encoder[B] = deriveEncoder
  implicit val encodeC: Encoder[C] = deriveEncoder
  implicit val decodeA: Decoder[A] = deriveDecoder
  implicit val decodeB: Decoder[B] = deriveDecoder
  implicit val decodeC: Decoder[C] = deriveDecoder
}

我希望使用circe和无形副产品对可能是其中任何一个的值进行编码。

import io.circe.shapes._, io.circe.syntax._
import shapeless._

import model._

type ABC = A :+: B :+: C :+: CNil

val c: ABC = Coproduct[ABC](C(123, false))

这看起来很好：

scala> c.asJson
res0: io.circe.Json =
{
  "i" : 123,
  "b" : false
}

但问题是我永远无法解码包含B元素的副产品，因为任何可以解码为B的有效JSON文档也可以解码为A，并且circe-shapes提供的副产品解码器按照它们在副产品中出现的顺序尝试元素。

scala> val b: ABC = Coproduct[ABC](B("xyz", 123))
b: ABC = Inr(Inl(B(xyz,123)))

scala> val json = b.asJson
json: io.circe.Json =
{
  "a" : "xyz",
  "i" : 123
}

scala> io.circe.jawn.decode[ABC](json.noSpaces)
res1: Either[io.circe.Error,ABC] = Right(Inl(A(xyz)))

如何在编码中消除副产品的元素歧义？

Answer 1

circe-shapes模块对没有标签的普通hlists和coproducts进行编码，如上所示：coproduct作为元素的纯JSON表示，hlist最终只是一个JSON数组（与默认元组编码相同）：

scala> ("xyz" :: List(1, 2, 3) :: false :: HNil).asJson.noSpaces
res2: String = ["xyz",[1,2,3],false]

在hlists的情况下，由于名称重叠而没有模棱两可的危险，但对于副产品则存在。但是，在这两种情况下，您都可以使用Shapeless的标记机制向JSON表示添加标签，该机制使用类型级符号标记值。

带有标签的hlist称为“记录”，带有标签的副产品是“联合”。 Shapeless为这两者提供了特殊的语法和操作，而circe-shapes与未标记的hlists或coproducts的处理方式不同。例如（假设上面的定义和导入）：

scala> import shapeless.union._, shapeless.syntax.singleton._
import shapeless.union._
import shapeless.syntax.singleton._

scala> type ABCL = Union.`'A -> A, 'B -> B, 'C -> C`.T
defined type alias ABCL

scala> val bL: ABCL = Coproduct[ABCL]('B ->> B("xyz", 123))
bL: ABCL = Inr(Inl(B(xyz,123)))

scala> val jsonL = bL.asJson
jsonL: io.circe.Json =
{
  "B" : {
    "a" : "xyz",
    "i" : 123
  }
}

scala> io.circe.jawn.decode[ABCL](jsonL.noSpaces)
res3: Either[io.circe.Error,ABCL] = Right(Inr(Inl(B(xyz,123))))

记录的编码类似地包括成员名称：

scala> ('a ->> "xyz" :: 'b ->> List(1) :: 'c ->> false :: HNil).asJson.noSpaces
res4: String = {"c":false,"b":[1],"a":"xyz"}

一般情况下，如果您希望您的hlist和coproduct编码包含标签（并且看起来像是通过案例类和密封特征层次结构从circe-generic获得的编码），您可以使用记录或副产品来表示circe-shapes用最少的额外语法和运行时开销来做到这一点。

我的coproduct编码含糊不清

1 个答案: