Question

我的请求中有一个可选字段：

case class SearchRequest(url: String, nextAt: Option[Date])

我的协议是：

object SearchRequestJsonProtocol extends DefaultJsonProtocol {
    implicit val searchRequestFormat = jsonFormat(SearchRequest, "url", "nextAt")
}

如何将nextAt字段标记为可选，以便正确读取和接受以下JSON对象：

{"url":"..."}
{"url":"...", "nextAt":null}
{"url":"...", "nextAt":"2012-05-30T15:23Z"}

我实际上并不关心空案例，但如果你有详细信息，那就太好了。我使用的是spray-json，并且如果原始JSON对象上没有它，那么使用Option会跳过该字段。

Answer 1

为我工作（spray-json 1.1.1 scala 2.9.1 build）

import cc.spray.json._
import cc.spray.json.DefaultJsonProtocol._

// string instead of date for simplicity
case class SearchRequest(url: String, nextAt: Option[String])

// btw, you could use jsonFormat2 method here
implicit val searchRequestFormat = jsonFormat(SearchRequest, "url", "nextAt")

assert {
  List(
    """{"url":"..."}""",
    """{"url":"...", "nextAt":null}""",
    """{"url":"...", "nextAt":"2012-05-30T15:23Z"}""")
  .map(_.asJson.convertTo[SearchRequest]) == List(
    SearchRequest("...", None),
    SearchRequest("...", None),
    SearchRequest("...", Some("2012-05-30T15:23Z")))
}

Answer 2

您可能必须创建一个显式格式（警告：psuedocodish）：

object SearchRequestJsonProtocol extends DefaultJsonProtocol {
    implicit object SearchRequestJsonFormat extends JsonFormat[SearchRequest] {
        def read(value: JsValue) = value match {
            case JsObject(List(
                    JsField("url", JsString(url)),
                    JsField("nextAt", JsString(nextAt)))) =>
                SearchRequest(url, Some(new Instant(nextAt)))

            case JsObject(List(JsField("url", JsString(url)))) =>
                SearchRequest(url, None)

            case _ =>
                throw new DeserializationException("SearchRequest expected")
        }

        def write(obj: SearchRequest) = obj.nextAt match {
            case Some(nextAt) => 
                JsObject(JsField("url", JsString(obj.url)),
                         JsField("nextAt", JsString(nextAt.toString)))
            case None => JsObject(JsField("url", JsString(obj.url)))
        }
    }
}

Answer 3

使用NullOptions特征禁用跳过null： https://github.com/spray/spray-json#nulloptions 例： https://github.com/spray/spray-json/blob/master/src/test/scala/spray/json/ProductFormatsSpec.scala

Answer 4

不知道这是否对你有帮助，但你可以在case类定义中给该字段一个默认值，所以如果该字段不在json中，它将为它分配默认值。

Answer 5

易。

import cc.spray.json._
trait MyJsonProtocol extends DefaultJsonProtocol {
  implicit val searchFormat = new JsonWriter[SearchRequest] {
    def write(r: SearchRequest): JsValue = {
      JsObject(
        "url" -> JsString(r.url),
        "next_at" -> r.nextAt.toJson,
      )
    }
  }
}

class JsonTest extends FunSuite with MyJsonProtocol {
test("JSON") {
    val search = new SearchRequest("www.site.ru", None)
    val marshalled = search.toJson
    println(marshalled)
  }
}

Answer 6

对于那些喜欢这篇文章并希望更新FrançoisBeausoleil对于较新版本的Spray（大约在2015年以后的版本）的答案的人，JsField已被弃用为JsValue的公共成员；您应该只提供一个元组列表，而不是JsFields。不过，他们的答案是随波逐流的。

如何在spray-json中表示可选字段？

6 个答案: