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 s。这可能永远是默认行为，因为它干净，简单且一致，但并不总是你想要的（正如你注意到即将推出的configuration options将支持替代品）。

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

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)

这说，＆＃34;如果A的通用表示是空的HList，则将其编码为JSON字符串＆＃34;的名称。并且它可以像我们期望的那样静态输入自己的案例对象：

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

当静态输入值作为基本类型时，故事有点不同：

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

我们得到State的一般派生实例，它尊重我们手动定义的case对象的通用实例，但它仍然将它们包装在一个对象中。如果您考虑它，这有一定意义 - ADT 可以包含案例类，它们只能合理地表示为JSON对象，因此object-wrapper-with-constructor-name-key方法可以说是最合理的事情。

这不是我们唯一可以做的事情，因为我们做静态地知道ADT是包含案例类还是仅包含案例对象。首先，我们需要一个新类型，它见证了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)

这就是我们想要的。

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

1 个答案: