如何使用jsonspray序列化具有特征的case类

时间:2014-01-06 09:24:14

标签: scala spray spray-json

我明白,如果我有:

case class Person(name: String)

我可以用

object PersonJsonImplicits extends DefaultJsonProtocol {
  implicit val impPerson = jsonFormat1(Person)
}

然后将其序列化为:

import com.example.PersonJsonImplicits._
import spray.json._
new Person("somename").toJson

然而,如果我有

trait Animal
case class Person(name: String) extends Animal

我的代码中有某处

val animal = ???

我需要序列化它,我想使用json spray

我应该添加哪个序列化程序我希望有类似的东西:

object AnimalJsonImplicits extends DefaultJsonProtocol {
  implicit val impAnimal = jsonFormat???(Animal)
}

也许我需要添加一些匹配器来检查Animal是什么类型的,这样如果它是一个人我会把它指向人但却一无所获......正在阅读https://github.com/spray/spray-json并且不明白该怎么做..

所以如何序列化

trait Animal
case class Person(name: String) extends Animal

用json喷雾?

3 个答案:

答案 0 :(得分:26)

您有几个选择:

选项1

扩展RootJsonFormat[Animal]并将您的自定义逻辑用于匹配不同类型的Animal

import spray.json._
import DefaultJsonProtocol._

trait Animal   
case class Person(name: String, kind: String = "person") extends Animal

implicit val personFormat = jsonFormat2(Person.apply)   
implicit object AnimalJsonFormat extends RootJsonFormat[Animal] {
  def write(a: Animal) = a match {
    case p: Person => p.toJson
  }
  def read(value: JsValue) = 
    // If you need to read, you will need something in the 
    // JSON that will tell you which subclass to use
    value.asJsObject.fields("kind") match {
      case JsString("person") => value.convertTo[Person]
    }
}

val a: Animal = Person("Bob")
val j = a.toJson
val a2 = j.convertTo[Animal]

如果将此代码粘贴到Scala REPL中,则会得到以下输出:

a: Animal = Person(Bob,person)
j: spray.json.JsValue = {"name":"Bob","kind":"person"}
a2: Animal = Person(Bob,person)

Source

选项2

另一种选择是为jsonFormatPerson的任何其他子类提供隐式Animal,然后编写序列化代码,如下所示:

def write(a: Animal) = a match {
  case p: Person => p.toJson
  case c: Cat => c.toJson
  case d: Dog => d.toJson
}

Source

答案 1 :(得分:0)

您可以添加一些额外的字段eq。 type进行序列化并在反序列化时使用它来确定特征实现:

trait Animal
case class Person(name: String) extends Animal
case class Lion(age: Int) extends Animal

implicit def personFormat = jsonFormat1(Person)
implicit def lionFormat = jsonFormat1(Lion)

implicit def animalFormat = 
  new RootJsonFormat[Animal] {
    override def read(json: JsValue): Animal = 
      json.asJsObject.fields.get("type") match {
        case Some(JsString("person")) => json.convertTo[Person]
        case Some(JsString("lion")) => json.convertTo[Lion]
        case t => deserializationError(s"Unable to deserialize Animal of type $t")
      }

    override def write(obj: Animal): JsValue =
      obj match {
        case e: Person => toJson(e, "person")
        case e: Lion => toJson(e, "lion")
      }

    def toJson[T](obj: T, objType: String)(implicit w: JsonWriter[T]): JsObject = {
      val o = obj.toJson.asJsObject
      o.copy(fields = o.fields + ("type" -> JsString(objType)))
    }
  }

答案 2 :(得分:0)

可以通过扩展RootJsonFormat来完成。可以从here中找到示例。