web-dev-qa-db-ja.com

play.api.libs.jsonを使用してオブジェクトをjsonにシリアル化する

比較的単純なモデルをjsonにシリアル化しようとしています。たとえば、次のjson表現を取得したいと思います。

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

適切な読み取りおよび書き込みメソッドを使用して独自のFormat [User]を作成する必要がありますか、それとも他の方法がありますか？ https://github.com/playframework/Play20/wiki/Scalajson を見てきましたが、まだ少し迷っています。

jsonscalaplayframeworkplayframework-2.0playframework-json
15
LuxuryMode

はい、独自の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]))

詳細については、 ドキュメント を参照してください。

22
Travis Brown

Userがケースクラスであるという事実のおかげで、次のようなこともできます。

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

独自のFormat [User]を作成せずに。読み取りでも同じことができます。

implicit val userImplicitReads = Json.reads[User]

ドキュメントで見つかりませんでした。APIへのリンクは次のとおりです： http://www.playframework.com/documentation/2.2.x/api/scala/index.html#play.api。 libs.json.Json $

8
Paweł Kozikowski