用于编码/解码arity 0的密封特征实例的Circe实例？

Question

我使用密封的特征作为枚举来进行详尽的模式匹配。在我使用case对象而不是case类扩展我的特征的情况下，我希望编码和解码(通过Circe)仅仅是一个普通字符串。

例如：

sealed trait State
case object On extends State
case object Off extends State

val a: State = State.Off
a.asJson.noSpaces // trying for "Off"

decode[State]("On") // should be State.On

我知道这在0.5.0中是可配置的，但是有没有人能帮我写点东西在发布之前帮我渡过难关呢？

Answer 1

要突出显示问题-假设此ADT：

sealed trait State
case object On extends State
case object Off extends State

circe的泛型派生将(目前)生成以下编码：

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

scala> On.asJson.noSpaces
res0: String = {}

scala> (On: State).asJson.noSpaces
res1: String = {"On":{}}

这是因为泛型派生机制是建立在Shapeless的LabelledGeneric之上的，它将case对象表示为空的HList。这可能永远是默认行为，因为它干净、简单和一致，但它并不总是您想要的(正如您注意到的，即将到来的configuration options将支持替代方案)。

您可以通过为case对象提供自己的通用实例来覆盖此行为：

import io.circe.Encoder
import shapeless.{ Generic, HNil }

implicit def encodeCaseObject[A <: Product](implicit
  gen: Generic.Aux[A, HNil]
): Encoder[A] = Encoder[String].contramap[A](_.productPrefix)

这就是说，“如果A的泛型表示是一个空的HList，那么就把它编码成一个JSON字符串”。对于静态类型为自身的case对象，它的工作方式与我们预期的一样：

scala> On.asJson.noSpaces
res2: String = "On"

当值被静态类型化为基类型时，情况就有点不同了：

scala> (On: State).asJson.noSpaces
res3: String = {"On":"On"}

我们得到了一个State的泛型派生实例，它遵循我们手动定义的case对象的泛型实例，但它仍然将它们包装在一个对象中。如果您仔细考虑，这是有意义的- ADT可以包含case类，只能合理地将其表示为JSON对象，因此对象包装器和构造器名称键方法可以说是最合理的做法。

但这并不是我们唯一能做的事情，因为我们确实静态地知道ADT是包含case类还是只包含case对象。首先，我们需要一个新的类型类来证明ADT只由case对象组成(请注意，我在这里假设有一个新的开始，但它应该可以与泛型派生一起工作)：

import shapeless._
import shapeless.labelled.{ FieldType, field }

trait IsEnum[C <: Coproduct] {
  def to(c: C): String
  def from(s: String): Option[C]
}

object IsEnum {
  implicit val cnilIsEnum: IsEnum[CNil] = new IsEnum[CNil] {
    def to(c: CNil): String = sys.error("Impossible")
    def from(s: String): Option[CNil] = None
  }

  implicit def cconsIsEnum[K <: Symbol, H <: Product, T <: Coproduct](implicit
    witK: Witness.Aux[K],
    witH: Witness.Aux[H],
    gen: Generic.Aux[H, HNil],
    tie: IsEnum[T]
  ): IsEnum[FieldType[K, H] :+: T] = new IsEnum[FieldType[K, H] :+: T] {
    def to(c: FieldType[K, H] :+: T): String = c match {
      case Inl(h) => witK.value.name
      case Inr(t) => tie.to(t)
    }
    def from(s: String): Option[FieldType[K, H] :+: T] =
      if (s == witK.value.name) Some(Inl(field[K](witH.value)))
        else tie.from(s).map(Inr(_))
  }
}

然后是我们的通用Encoder实例：

import io.circe.Encoder

implicit def encodeEnum[A, C <: Coproduct](implicit
  gen: LabelledGeneric.Aux[A, C],
  rie: IsEnum[C]
): Encoder[A] = Encoder[String].contramap[A](a => rie.to(gen.to(a)))

不妨把解码器也写出来。

import cats.data.Xor, io.circe.Decoder

implicit def decodeEnum[A, C <: Coproduct](implicit
  gen: LabelledGeneric.Aux[A, C],
  rie: IsEnum[C]
): Decoder[A] = Decoder[String].emap { s =>
  Xor.fromOption(rie.from(s).map(gen.from), "enum")
}

然后：

scala> import io.circe.jawn.decode
import io.circe.jawn.decode

scala> import io.circe.syntax._
import io.circe.syntax._

scala> (On: State).asJson.noSpaces
res0: String = "On"

scala> (Off: State).asJson.noSpaces
res1: String = "Off"

scala> decode[State](""""On"""")
res2: cats.data.Xor[io.circe.Error,State] = Right(On)

scala> decode[State](""""Off"""")
res3: cats.data.Xor[io.circe.Error,State] = Right(Off)

这就是我们想要的。