我的合成产品编码不明确。

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和Shapeless coproducts将值编码为JSON，这个值可能是其中的任何一个。

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)))

如何在我的编码中消除余积的元素歧义？

- Travis Brown

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 的情况下，由于名称重叠没有歧义的危险，但对于 coproducts 存在。不过，在这两种情况下，您都可以使用 Shapeless 的标记机制向 JSON 表示添加标签，该标记将值与类型级别符号标记。

带有标签的 hlist 称为“记录”，而具有标签的 coproduct 称为“联合”。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编码包含标签（并且看起来像从case类和密封的特质层次结构获取的编码），您可以使用记录或coproducts告诉circe-shapes以最小的额外语法和运行时开销来实现此目的。

- Travis Brown