2017-02-26 82 views
2

我有一个虚拟的类Foo其中有三个成员:为什么不是Option [String]类型的成员被序列化?

import play.api.libs.json.Json 

case class Foo(id: String, fooType: FooType, nextId: Option[String]) 

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

其中作为

import play.api.libs.json.Json 

case class FooType(a: String, b: String) 

object FooType { 
    implicit val fooTypeReads = Json.reads[FooType] 
    implicit val fooTypeFormat = Json.format[FooType] 
} 

我发现一些有趣的行为序列化Foo对象时FooType定义。如果我序列化Foo到JSON,解析JSONified富,我发现,所有的成员都正确解析:

val id = "id" 
val fooType = FooType("a", "b") 
val nextId = None 

val foo = Foo(id, fooType, nextId) 
val jsonFoo = Json.toJson(foo) 
val parsedFoo = Json.parse(jsonFoo.toString).as[Foo] 

assert(parsedFoo == foo) 
assert(parsedFoo.id == id) 
assert(parsedFoo.fooType == fooType) 
assert(parsedFoo.nextId.isEmpty) 

这是一件好事,因为这是我的期望。

然而,在我的下一个测试,我发现nextId序列化都:

val id = "id" 
val fooType = FooType("a", "b") 
val nextId = None 

val foo = Foo(id, fooType, nextId) 
val jsonFoo = Json.toJson(foo) 

assert((jsonFoo \ "id").as[String] == id) 
assert((jsonFoo \ "fooType").as[FooType] == fooType) 
assert((jsonFoo \ "nextId").as[Option[String]].isEmpty) 

这失败,出现以下错误:

Error:(38, 35) No Json deserializer found for type Option[String]. Try to implement an implicit Reads or Format for this type. 
    assert((jsonFoo \ "nextId").as[Option[String]].isEmpty) 

Error:(38, 35) not enough arguments for method as: (implicit fjs: play.api.libs.json.Reads[Option[String]])Option[String]. 
Unspecified value parameter fjs. 
    assert((jsonFoo \ "nextId").as[Option[String]].isEmpty) 

同样地,我发现当我打印由Json.toJson(foo)转储的JSON对象时,JSON对象中缺少nextId字段:

println(Json.prettyPrint(jsonFoo)) 

{ 
    "id" : "id", 
    "fooType" : { 
    "a" : "a", 
    "b" : "b" 
    } 
} 

但是,我可以解析nextId字段toOption;即

assert((jsonFoo \ "nextId").toOption.isEmpty) 

如果我的对象其中一个成员本身不能反序列化,我怎样才能从JSON正确解析对象?

回答

2

nextId字段是可序列化的,否则,根本不可能写入Foo到JSON。

jsonFoo: play.api.libs.json.JsValue = {"id":"id","fooType":{"a":"a","b":"b"}} 

您遇到的问题是,有没有ReadsOption[A]。选项由Play JSON特别处理。当使用JSON组合器时,我们使用readNullable[A]writeNullable[A]而不是read[Option[A]]write[Option[A]]。同样,当使用方法从JsValue中提取单个字段时,调用as将不起作用,因为它需要隐含的Reads[A]作为您提供的类型(在本例中为Reads[Option[String]],这不存在)。

相反,你需要使用asOpt,这将正确处理Option下:

scala> (jsonFoo \ "nextId").asOpt[String] 
res1: Option[String] = None 

nextId,因为你是序列化的值None不会出现在打印JSON。这是预期会发生的事情。由于该值是可选的,因此它会从JSON中省略(JavaScript中只有undefined)。如果它有一个值,它将会出现:

scala> Json.toJson(Foo("id", FooType("a", "b"), Option("abcdef"))) 
res3: play.api.libs.json.JsValue = {"id":"id","fooType":{"a":"a","b":"b"},"nextId":"abcdef"} 

如果某些东西不能用Play JSON进行序列化,它根本就不会编译。

+0

有趣。我可能希望'None'在Play中被序列化为'null'或'JsNull'对象,但我现在已经看到我必须为此定义一个自定义作者。感谢您花时间回答! – erip

+0

它只能走一条路。 JSON中缺少的字段或'null'将被映射到'Option',但'Option'只能映射到其他方式之一。设计师选择忽略该领域是更明智的做法。 –

+0

有道理。只要它能被正确解析,那就没问题 - 这是关键所在。 – erip

相关问题