Бесшумный формат JSON для запечатанных признаков с библиотекой Play 2.2

ИЗМЕНЕНО 22 сентября 2015 г.

Библиотека play-json-extra включает play-json-options, а также стратегию [play-json-extensions] ( плоская строка для объектов case, смешанных с объектами для классов case, без дополнительных $ option или $ type, если не требуется). Он также предоставляет сериализаторы и десериализаторы для перечислений на основе макраме.

Предыдущий ответ Теперь есть библиотека под названием play-json-options что позволяет писать:

implicit val format: Format[Foo] = Variants.format[Foo]

Это автоматически сгенерирует соответствующие форматы, а также устранит неоднозначность следующего случая, добавив атрибут $ variant (эквивалент атрибута class 0__)

sealed trait Foo
case class Bar(x: Int) extends Foo
case class Baz(s: String) extends Foo
case class Bah(s: String) extends Foo

будет генерировать

val bahJson = Json.obj("s" -> "hello", "$variant" -> "Bah") // This is a `Bah`
val bazJson = Json.obj("s" -> "bye", "$variant" -> "Baz") // This is a `Baz`
val barJson = Json.obj("x" -> "42", "$variant" -> "Bar") // And this is a `Bar`

Вот ручная реализация сопутствующего объекта Foo:

implicit val barFmt = Json.format[Bar]
implicit val bazFmt = Json.format[Baz]

object Foo {
  def unapply(foo: Foo): Option[(String, JsValue)] = {
    val (prod: Product, sub) = foo match {
      case b: Bar => (b, Json.toJson(b)(barFmt))
      case b: Baz => (b, Json.toJson(b)(bazFmt))
    }
    Some(prod.productPrefix -> sub)
  }

  def apply(`class`: String, data: JsValue): Foo = {
    (`class` match {
      case "Bar" => Json.fromJson[Bar](data)(barFmt)
      case "Baz" => Json.fromJson[Baz](data)(bazFmt)
    }).get
  }
}
sealed trait Foo
case class Bar(i: Int  ) extends Foo
case class Baz(f: Float) extends Foo

implicit val fooFmt = Json.format[Foo]   // ça marche!

Проверка:

val in: Foo = Bar(33)
val js  = Json.toJson(in)
println(Json.prettyPrint(js))

val out = Json.fromJson[Foo](js).getOrElse(sys.error("Oh no!"))
assert(in == out)

В качестве альтернативы прямое определение формата:

implicit val fooFmt: Format[Foo] = new Format[Foo] {
  def reads(json: JsValue): JsResult[Foo] = json match {
    case JsObject(Seq(("class", JsString(name)), ("data", data))) =>
      name match {
        case "Bar"  => Json.fromJson[Bar](data)(barFmt)
        case "Baz"  => Json.fromJson[Baz](data)(bazFmt)
        case _      => JsError(s"Unknown class '$name'")
      }

    case _ => JsError(s"Unexpected JSON value $json")
  }

  def writes(foo: Foo): JsValue = {
    val (prod: Product, sub) = foo match {
      case b: Bar => (b, Json.toJson(b)(barFmt))
      case b: Baz => (b, Json.toJson(b)(bazFmt))
    }
    JsObject(Seq("class" -> JsString(prod.productPrefix), "data" -> sub))
  }
}

В идеале я хотел бы автоматически сгенерировать методы apply и unapply. Похоже, мне нужно будет либо использовать отражение, либо погрузиться в макросы.

Небольшое исправление для предыдущего ответа от 0__ относительно прямого определения формата - метод чтения не работал, и вот мой рефакторинг к нему, чтобы он также стал более идиоматическим -

def reads(json: JsValue): JsResult[Foo] = {

  def from(name: String, data: JsObject): JsResult[Foo] = name match {
    case "Bar"  => Json.fromJson[Bar](data)(barFmt)
    case "Baz"  => Json.fromJson[Baz](data)(bazFmt)
    case _ => JsError(s"Unknown class '$name'")
  }

  for {
    name <- (json \ "class").validate[String]
    data <- (json \ "data").validate[JsObject]
    result <- from(name, data)
  } yield result
}

Play 2.7

sealed traits поддерживаются в play-json.

object Foo{
  implicit val format = Json.format[Foo]
}

Играть в 2.6

Теперь это можно сделать элегантно с помощью play-json-производных-кодеков.

Просто добавьте это:

object Foo{
    implicit val jsonFormat: OFormat[Foo] = derived.oformat[Foo]()
}

См. Здесь полный пример: ScalaFiddle