Вопрос по spray-json, scala – Как представить необязательные поля в Spray-JSON?

16

У меня есть дополнительное поле для моих запросов:

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, и у меня сложилось впечатление, что использование Option пропустит поле, если оно отсутствует в исходном объекте JSON.

Ваш Ответ

6   ответов
26

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")))
}
Ах, я использую Spray-JSON 1.0.0, Scala 2.9.0.1. Я хочу обновить в ближайшее время, но я не там. еще. Спасибо за Ваш ответ! François Beausoleil
у меня тоже работает; игнорировать другой ответ и обновить.
0

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)
  }
}
7

использованиеNullOptions черта, чтобы отключить пропускnulls: https://github.com/spray/spray-json#nulloptions Example: https://github.com/spray/spray-json/blob/master/src/test/scala/spray/json/ProductFormatsSpec.scala

0

кто выбирает этот пост и хочет обновить ответ Фрэнсиса Босолея о более новых версиях Spray (около 2015+?), JsField устарела как публичный член JsValue; Вы должны просто предоставить список кортежей вместо JsFields. Их ответ точен, хотя.

10

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)))
        }
    }
}
0

поможет ли это вам, но вы можете присвоить этому полю значение по умолчанию в определении класса дела, поэтому, если поле отсутствует в json, оно назначит ему значение по умолчанию.

Это не сработало для меня ... вам нужно что-то настроить?

Похожие вопросы