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構文によって提供され、最初のインポートでスコープに含めます) 。DecoderCirce の型クラスの不変性については議論の余地があります (たとえば、Argonaut は不変から共変へ、そしてその逆へと移行しました) が、変更される可能性が低いほど十分な利点があります。
Encoderまた、明示的なインスタンスとインスタンスが、インポートDecoderから取得する一般的な派生インスタンスよりも優先されることにも注意してください(この優先順位付けの仕組みについては、こちらのスライドを参照してください)。io.circe.generic.auto._
これらのインスタンスは次のように使用できます。
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 コンストラクターが試行される順序を指定できるようにする必要がある場合は、これが現在の最適なソリューションです。このようにコンストラクターを列挙しなければならないことは、ケース クラスのインスタンスを無料で取得したとしても、明らかに理想的ではありません。
より一般的なソリューション
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ある任意の ADT で機能します。decodeAdtNoDiscrより制限したい場合はA、これらの定義でジェネリックを ADT 型に置き換えるか、定義を非暗黙的にして、この方法でエンコードする ADT の暗黙的なインスタンスを明示的に定義することができます。
このアプローチの主な欠点は (追加の circe-shapes の依存関係は別として)、コンストラクターがアルファベット順に試行されることです。これは、あいまいなケース クラス (メンバー名と型が同じ) がある場合には望ましくない可能性があります。 ）。
未来
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 のラッパー オブジェクトの代わりに、コンストラクターを示す追加のフィールドがあります。これは、いくつかの奇妙なコーナー ケース (たとえば、ケース クラスの 1 つに という名前のメンバーがあった場合what_am_i) があるため、デフォルトの動作ではありませんが、多くの場合、これは合理的であり、そのモジュールが導入されて以来、generic-extras でサポートされています。
これはまだ、私たちが望んでいるものとまったく同じではありませんが、デフォルトの動作よりは近いものです。また、前のセクションの circe-shapes インスタンスと同じ動作を与えて、コンストラクターを示す余分なフィールドが必要ないことを示して、の代わりにwithDiscriminatorを取るように変更することも検討しています。Option[String]StringNone
これを確認したい場合は、Issue を開くか、 (さらに良いことに) pull requestを開いてください。:)