1 JSON開發簡介
Play提供了一套基于jackson開發的JSON庫,幫助開發者便捷地處理JSON數據。目前Play的JSON庫可以實現以下功能:
- 自動完成JSON對象和case class之間的雙向轉換
- 驗證JSON數據的合法性
- 直接作為HTTP的請求/響應數據,方便開發RESTful服務
目前Play的JSON庫已經分離成獨立項目,所以你可以很容易地將它引入到自己的項目:
libraryDependencies += "com.typesafe.play" %% "play-json" % playVersion
2 基本JSON類型
JsValue
trait是所有基本JSON類型的父類型,JSON庫提供的基本類型如下:
- JsString
- JsNumber
- JsBoolean
- JsObject
- JsArray
- JsNull
在日程開發中,我們很少跟這些JSON基本類型打交道。因為在Play中對于基本類型T(例如String, Int, ...)以及Seq[T]已經提供了默認的隱式轉換, 可以自動將其轉換成對應的JSON類型,例如:
//基本類型值
Json.obj("name" -> JsString("joymufeng"))
//可以簡寫成:
Json.obj("name" -> "joymufeng")
//序列類型值
Json.obj("emails" -> JsArray(Seq(JsString("a"), JsString("b"))))
//可以簡寫成:
Json.obj("emails" -> Seq("a", "b"))
在Play的JSON庫里,整形和浮點型都使用JsNumber表示,這是一個略為糟糕的設計,因為會導致JSON數據無法在多語言環境下共享。例如通過Java代碼向MongoDB寫入了一個整形數值,但是經過Play的JSON庫修改后變成了浮點型,Java代碼再次讀取時便會報錯。
3 基本的JSON操作
- 構建一個JsObject對象
//直接構建 val json = Json.obj( "name" -> "joymufeng", "emails" -> Json.arr("joymufeng@163.com"), "address" -> Json.obj( "province" -> "JiangSu", "city" -> "NanJing" ) ) //從JSON字符串構建 val json = Json.parse(""" { "name": "joymufeng", "emails": ["joymufeng@163.com"], "address": { "province": "JiangSu", "city" -> "NanJing" } } """)
- 常用操作
//read props val city = (json \ "address" \ "city").as[String] val cityOpt = (json \ "address" \ "city").asOpt[String] val emails = (json \ "emails").as[List[String]] //mutable var obj = Json.obj("a" -> 1) obj ++= Json.obj("b" -> 2) //obj: {"a":1,"b":2} //pretty print val prettyStr = Json.prettyPrint(obj)
4 JSON對象和case class互轉
Play雖然為基本類型T以及Seq[T]提供了默認的隱式轉換,但是case class的隱式轉換需要我們自己聲明,例如我們有如下兩個case class:
case class Address(province: String, city: String)
case class Person(name: String, emails: List[String], address: Address)
我們只需要聲明兩個隱式的Format對象就可以了:
import play.api.libs.json._
implicit val addressFormat = Json.format[Address]
implicit val personFormat = Json.format[Person]
//case class -> JSON object
val person = Person("joymufeng", List("joymufeng@163.com"), Address("JiangSu", "NanJing"))
val json = Json.toJson[Person](person)
//JSON object -> case class
val p1 = Json.fromJson[Person](json).get
val p2 = json.as[Person]
val p3 = json.asOpt[Person].get
我們發現Json.fromJson[Person](json)
返回的類型并不是Person
而是JsResult[Person]
,這是因為從JSON object到case class的轉換可能會發生錯誤,JsResult
有兩個子類JsSuccess
和JsError
,分別用來處理成功和失敗兩種情況:
Json.fromJson[Person](json) match {
case p: JsSuccess[Person] => println(p)
case e: JsError => println(e.errors)
}
5 小結
隨著NoSQL的不斷普及,JSON數據在Web開發中顯得越來越重要。使用Play提供的JSON庫可以大大簡化日常的開發工作。另外還有一些基于JSON庫的第三方模塊,例如Play-ReactiveMongo,利用該模塊將Play和MongoDB完美結合,開發出高性能的異步非阻塞系統。