json - 如何在不消除对象歧义的情况下使用 circe 解码 ADT

Question

假设我有这样的 ADT:

sealed trait Event

case class Foo(i: Int) extends Event
case class Bar(s: String) extends Event
case class Baz(c: Char) extends Event
case class Qux(values: List[String]) extends Event

circe 中 Decoder[Event] 实例的默认泛型派生期望输入 JSON 包含一个包装器对象，该对象指示表示哪个案例类:

scala> import io.circe.generic.auto._, io.circe.parser.decode, io.circe.syntax._
import io.circe.generic.auto._
import io.circe.parser.decode
import io.circe.syntax._

scala> decode[Event]("""{ "i": 1000 }""")
res0: Either[io.circe.Error,Event] = Left(DecodingFailure(CNil, List()))

scala> decode[Event]("""{ "Foo": { "i": 1000 }}""")
res1: Either[io.circe.Error,Event] = Right(Foo(1000))

scala> (Foo(100): Event).asJson.noSpaces
res2: String = {"Foo":{"i":100}}

这种行为意味着如果两个或多个 case 类具有相同的成员名称，我们永远不必担心歧义，但这并不总是我们想要的——有时我们知道展开的编码是明确的，或者我们想通过以下方式消除歧义指定每个案例类应该尝试的顺序，否则我们不在乎。

如何在没有包装器的情况下编码和解码我的 Event ADT(最好不必从头开始编写编码器和解码器)？

(这个问题经常出现——例如今天早上在 Gitter 上的 this discussion with Igor Mazor。)

Answer 1

枚举 ADT 构造函数

获得所需表示的最直接方法是对案例类使用泛型派生，但为 ADT 类型显式定义实例:

import cats.syntax.functor._
import io.circe.{ Decoder, Encoder }, io.circe.generic.auto._
import io.circe.syntax._

sealed trait Event

case class Foo(i: Int) extends Event
case class Bar(s: String) extends Event
case class Baz(c: Char) extends Event
case class Qux(values: List[String]) extends Event

object Event {
  implicit val encodeEvent: Encoder[Event] = Encoder.instance {
    case foo @ Foo(_) => foo.asJson
    case bar @ Bar(_) => bar.asJson
    case baz @ Baz(_) => baz.asJson
    case qux @ Qux(_) => qux.asJson
  }

  implicit val decodeEvent: Decoder[Event] =
    List[Decoder[Event]](
      Decoder[Foo].widen,
      Decoder[Bar].widen,
      Decoder[Baz].widen,
      Decoder[Qux].widen
    ).reduceLeft(_ or _)
}

请注意，我们必须在解码器上调用 widen(它由 Cats 的 Functor 语法提供，我们在第一次导入时将其引入范围)，因为 Decoder 类型类不是协变的。 circe 类型类的不变性是 some controversy 的问题。 (例如，Argonaut 已经从不变变为协变并返回)，但它有足够的好处，它不太可能改变，这意味着我们偶尔需要这样的解决方法。

还值得注意的是，我们显式的 Encoder 和 Decoder 实例将优先于我们从 io.circe 获得的通用派生实例.generic.auto._ 导入(请参阅我的幻灯片 here 了解有关此优先级如何工作的一些讨论)。

我们可以像这样使用这些实例:

scala> import io.circe.parser.decode
import io.circe.parser.decode

scala> decode[Event]("""{ "i": 1000 }""")
res0: Either[io.circe.Error,Event] = Right(Foo(1000))

scala> (Foo(100): Event).asJson.noSpaces
res1: String = {"i":100}

这很有效，如果您需要指定尝试 ADT 构造函数的顺序，这是目前最好的解决方案。但是，必须像这样枚举构造函数显然并不理想，即使我们免费获得了案例类实例。

更通用的解决方案

我注意到 on Gitter ，我们可以通过使用circe-shapes模块来避免写出所有案例的大惊小怪:

import io.circe.{ Decoder, Encoder }, io.circe.generic.auto._
import io.circe.shapes
import shapeless.{ Coproduct, Generic }

implicit def encodeAdtNoDiscr[A, Repr <: Coproduct](implicit
  gen: Generic.Aux[A, Repr],
  encodeRepr: Encoder[Repr]
): Encoder[A] = encodeRepr.contramap(gen.to)

implicit def decodeAdtNoDiscr[A, Repr <: Coproduct](implicit
  gen: Generic.Aux[A, Repr],
  decodeRepr: Decoder[Repr]
): Decoder[A] = decodeRepr.map(gen.from)

sealed trait Event

case class Foo(i: Int) extends Event
case class Bar(s: String) extends Event
case class Baz(c: Char) extends Event
case class Qux(values: List[String]) extends Event

然后:

scala> import io.circe.parser.decode, io.circe.syntax._
import io.circe.parser.decode
import io.circe.syntax._

scala> decode[Event]("""{ "i": 1000 }""")
res0: Either[io.circe.Error,Event] = Right(Foo(1000))

scala> (Foo(100): Event).asJson.noSpaces
res1: String = {"i":100}

这适用于 encodeAdtNoDiscr 和 decodeAdtNoDiscr 范围内的任何 ADT。如果我们希望它受到更多限制，我们可以在这些定义中将通用 A 替换为我们的 ADT 类型，或者我们可以使定义为非隐式并为我们想要编码的 ADT 显式定义隐式实例这边。

这种方法的主要缺点(除了额外的 circe-shapes 依赖)是构造函数将按字母顺序尝试，如果我们有模棱两可的案例类(其中成员名称和类型)，这可能不是我们想要的是一样的)。

future

generic-extras 模块在这方面提供了更多的可配置性。我们可以这样写，例如:

import io.circe.generic.extras.auto._
import io.circe.generic.extras.Configuration

implicit val genDevConfig: Configuration =
  Configuration.default.withDiscriminator("what_am_i")

sealed trait Event

case class Foo(i: Int) extends Event
case class Bar(s: String) extends Event
case class Baz(c: Char) extends Event
case class Qux(values: List[String]) extends Event

然后:

scala> import io.circe.parser.decode, io.circe.syntax._
import io.circe.parser.decode
import io.circe.syntax._

scala> (Foo(100): Event).asJson.noSpaces
res0: String = {"i":100,"what_am_i":"Foo"}

scala> decode[Event]("""{ "i": 1000, "what_am_i": "Foo" }""")
res1: Either[io.circe.Error,Event] = Right(Foo(1000))

我们有一个额外的字段来指示构造函数，而不是 JSON 中的包装器对象。这不是默认行为，因为它有一些奇怪的极端情况(例如，如果我们的一个案例类有一个名为 what_am_i 的成员)，但在许多情况下它是合理的，并且在 generic-extras 中得到支持自从引入了该模块。

这仍然没有得到我们想要的，但它比默认行为更接近。我也一直在考虑将 withDiscriminator 更改为使用 Option[String] 而不是 String，使用 None表示我们不想要一个额外的字段来指示构造函数，从而为我们提供与上一节中的 circe-shapes 实例相同的行为。

如果您有兴趣看到这种情况发生，请打开 an issue ，或者(甚至更好)pull request . :)