Circe 解码为由多个案例类扩展的密封特征

Question

我以前见过类似的问题，但没有一个有效。我认为他们会问一些不同的问题，所以我在这里问。我在一个文件中有这样的东西：

sealed trait Thing
case class SomeThing() extends Thing
case class OtherThing() extends Thing

并在另一个文件中：

val str = //valid json
val decoded = decode[Thing](str)
println(decoded)

我得到：

Left(DecodingFailure(...))

如果我这样做，这会起作用：

val str = //valid json
val decoded = decode[SomeThing](str)
println(decoded)

Answer 1

我必须为序列化/反序列化编写自己的编码器和解码器。

例子，

import io.circe._, io.circe.generic.auto._, io.circe.parser._, io.circe.syntax._

object CirceSubtypesSerialisers {

  def main(args: Array[String]): Unit = {

    sealed trait Data

    case class OptionsData(data: Seq[String]) extends Data
    case class TextData(data: String) extends Data

    object Data {
      implicit val decodeData: Decoder[Data] = Decoder[OptionsData].map[Data](identity).or(Decoder[TextData].map[Data](identity))

      implicit val encodeData: Encoder[Data] = Encoder.instance {
        case options @ OptionsData(_) => options.asJson
        case text @ TextData(_) => text.asJson
      }
    }

    val optionsJson ="""{ "data": ["option1", "option2"] }""".stripMargin

    decode[Data](optionsJson) match {
      case Right(r: OptionsData) => println(r)
      case Left(l) => println(l)
    }


    val textJson ="""{ "data": "hey, how can i help ya?" }""".stripMargin

    decode[Data](textJson) match {
      case Right(r: TextData) => println(r)
      case Left(l) => println(l)
    }

  }

}

输出：

OptionsData(List(option1, option2))
TextData(hey, how can i help ya?)

这也在https://circe.github.io/circe/codec.html#warnings-and-known-issues和JsonCodec 中提到，用于密封特征需要明确的对象定义

Answer 2

您可以使用 circe-generic-extras 并为您的 json 添加类型鉴别器：

在你的 build.sbt 中：

libraryDependencies ++= Seq(
  "io.circe" %% "circe-generic-extras" % "0.12.2",
  "io.circe" %% "circe-parser" % "0.12.2"
)

现在让我们定义我们的类并序列化+反序列化它们：

sealed trait Thing
case class SomeThing() extends Thing
case class OtherThing() extends Thing

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

implicit val customConfig: Configuration =
  Configuration.default.withSnakeCaseMemberNames.withDiscriminator("type")

val thing: Thing = SomeThing()

// serialize thing to json
val jsString: String = thing.asJson.spaces2
println(s"serialized $thing to:\n$jsString")
/* serialized SomeThing() to:
{
"type" : "SomeThing"
}
*/

// deserialize json to thing
val errorOrMyTrait: Either[io.circe.Error, Thing] = parser.decode[Thing](jsString)

println(errorOrMyTrait) // Right(SomeThing())

请注意，现在序列化的 json 包含密封类的类型