Перечисление конструкторов ADT
Самый простой способ получить желаемое представление - использовать общий вывод для классов case, но явно определенные экземпляры для типа 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 не является ковариантным. Инвариантность классов типов Circe является предметом некоторых разногласий (например, Аргонавт перешел от инвариантного к ковариантному и обратно), но у него достаточно преимуществ, и вряд ли он изменится, а это значит, что нам время от времени нужны подобные обходные пути.
Также стоит отметить, что наши явные экземпляры 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, на данный момент это лучшее решение. Однако необходимость перечислять такие конструкторы явно не идеальна, даже если мы получим экземпляры класса case бесплатно.
Более общее решение
Как я отмечаю, в Gitter, мы можем избежать суеты, связанной с записью всех случаев, используя модуль circe-shape :
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}
Это будет работать для любого ADT везде, где encodeAdtNoDiscr и decodeAdtNoDiscr находятся в области видимости. Если бы мы хотели, чтобы он был более ограниченным, мы могли бы заменить общий A на наши типы ADT в этих определениях, или мы могли бы сделать определения неявными и явно определить неявные экземпляры для ADT, которые мы хотим закодировать таким образом.
Основным недостатком этого подхода (помимо дополнительной зависимости круговых фигур) является то, что конструкторы будут проверяться в алфавитном порядке, что может быть не тем, что нам нужно, если у нас есть неоднозначные классы case (где имена и типы элементов совпадают. ).
Будущее
В этом отношении модуль 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 у нас есть дополнительное поле, которое указывает конструктор. Это не поведение по умолчанию, поскольку у него есть несколько странных угловых случаев (например, если в одном из наших классов case был член с именем what_am_i), но во многих случаях это разумно и поддерживается в общих дополнительных функциях с момента появления этого модуля.
Это по-прежнему не дает нам того, чего мы хотим, но ближе, чем поведение по умолчанию. Я также подумывал об изменении withDiscriminator, чтобы он принимал Option[String] вместо String, где None указывает, что нам не нужно дополнительное поле, указывающее конструктор, что дает нам то же поведение, что и наши экземпляры Circe-shape в предыдущем разделе.
Если вы хотите, чтобы это произошло, откройте проблему или (что еще лучше) pull request. :)
person
Travis Brown
schedule
10.02.2017
