Сериализация объектов в json с помощью play.api.libs.json

Я пытаюсь сериализовать некоторые относительно простые модели в json. Например, я хотел бы получить json-представление:

case class User(val id: Long, val firstName: String, val lastName: String, val email: Option[String]) {
    def this() = this(0, "","", Some(""))
}

Нужно ли мне писать свой собственный формат [Пользователь] с соответствующими методами чтения и записи или есть какой-то другой способ? Я просмотрел https://github.com/playframework/Play20/wiki/Scalajson, но я все еще немного потерял.

ОТВЕТЫ

Ответ 1

Да, создание собственного экземпляра Format рекомендуемого подхода. Учитывая следующий класс, например:

case class User(
  id: Long, 
  firstName: String,
  lastName: String,
  email: Option[String]
) {
  def this() = this(0, "","", Some(""))
}

Экземпляр может выглядеть следующим образом:

import play.api.libs.json._

implicit object UserFormat extends Format[User] {
  def reads(json: JsValue) = User(
    (json \ "id").as[Long],
    (json \ "firstName").as[String],
    (json \ "lastName").as[String],
    (json \ "email").as[Option[String]]
  )

  def writes(user: User) = JsObject(Seq(
    "id" -> JsNumber(user.id),
    "firstName" -> JsString(user.firstName),
    "lastName" -> JsString(user.lastName),
    "email" -> Json.toJson(user.email)
  ))
}

И вы будете использовать его следующим образом:

scala> User(1L, "Some", "Person", Some("[email protected]"))
res0: User = User(1,Some,Person,Some([email protected]))

scala> Json.toJson(res0)
res1: play.api.libs.json.JsValue = {"id":1,"firstName":"Some","lastName":"Person","email":"[email protected]"}

scala> res1.as[User]
res2: User = User(1,Some,Person,Some([email protected]))

Подробнее см. документацию.

Ответ 2

Благодаря тому, что пользователь является классом case, вы также можете сделать что-то вроде этого:

implicit val userImplicitWrites = Json.writes[User]
val jsUserValue = Json.toJson(userObject)

без записи собственного формата [Пользователь]. Вы можете сделать то же самое с чтениями:

implicit val userImplicitReads = Json.reads[User]

Я не нашел его в документах, вот ссылка на api: http://www.playframework.com/documentation/2.2.x/api/scala/index.html#play.api.libs.json.Json $