如何在不消除对象歧义的情况下使用 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 包含一个包装器对象，该对象指示 class 表示的是哪种情况：

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 classes 具有相同的成员名称，我们永远不必担心歧义，但这并不总是我们想要的——有时我们知道展开的编码是明确的，或者我们想通过指定每个案例 class 应该尝试的顺序来消除歧义，或者我们根本不在乎。

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

（这个问题经常出现——参见今天早上 Gitter 上的 this discussion with Igor Mazor。）

Answer 1

枚举 ADT 构造函数

获得所需表示的最直接方法是对案例 class 使用泛型推导，但为 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 类型class 不是协变的。 circe 类型 classes 的不变性是 some controversy 的问题（例如，Argonaut 已经从不变变为协变并返回），但它有足够的好处，不太可能改变，这意味着我们需要变通办法偶尔这样。

还值得注意的是，我们的显式 Encoder 和 Decoder 实例将优先于我们从 io.circe.generic.auto._ 导入中获得的 generically-derived 实例（参见我的幻灯片 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 构造函数的顺序，这是目前最好的解决方案。但是，必须像这样枚举构造函数显然并不理想，即使我们免费获得 case class 个实例。

更通用的解决方案

正如我注意到的 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。如果我们希望它更受限制，我们可以在这些定义中用我们的 ADT 类型替换泛型 A，或者我们可以定义 non-implicit 并为我们想要编码的 ADT 显式定义隐式实例方式。

这种方法的主要缺点（除了额外的 circe-shapes 依赖）是构造函数将按字母顺序进行尝试，如果大小写不明确，这可能不是我们想要的 classes（其中成员名称和类型相同）。

未来

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 中的包装器对象。这不是默认行为，因为它有一些奇怪的极端情况（例如，如果我们的案例 classes 有一个名为 what_am_i 的成员），但在许多情况下它是合理的并且在 generic-extras 自引入该模块以来。

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

如果您有兴趣看到这种情况发生，请打开 an issue, or (even better) a pull request。 :)

Answer 2

我最近需要处理很多 ADT 到 JSON，所以决定维护我自己的扩展库，它提供了一些不同的方法来使用注释和宏来解决它：

ADT 定义：

import org.latestbit.circe.adt.codec._


sealed trait TestEvent

@JsonAdt("my-event-1") 
case class MyEvent1(anyYourField : String /*, ...*/) extends TestEvent

@JsonAdt("my-event-2")
case class MyEvent2(anyOtherField : Long /*, ...*/) extends TestEvent

用法：


import io.circe._
import io.circe.parser._
import io.circe.syntax._

// This example uses auto coding for case classes. 
// You decide here if you need auto/semi/custom coders for your case classes.
import io.circe.generic.auto._ 

// One import for this ADT/JSON codec
import org.latestbit.circe.adt.codec._

// Encoding

implicit val encoder : Encoder[TestEvent] = 
  JsonTaggedAdtCodec.createEncoder[TestEvent]("type")

val testEvent : TestEvent = TestEvent1("test")
val testJsonString : String = testEvent.asJson.dropNullValues.noSpaces

// Decoding
implicit val decoder : Decoder[TestEvent] = 
  JsonTaggedAdtCodec.createDecoder[TestEvent] ("type")

decode[TestEvent] (testJsonString) match {
   case Right(model : TestEvent) => // ...
}

详情：https://github.com/abdolence/circe-tagged-adt-codec

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

How to decode an ADT with circe without disambiguating objects

json

scala

algebraic-data-types

circe

generic-derivation

枚举 ADT 构造函数

更通用的解决方案

未来