Play Scala 2.5.x - Play JSON開發指南

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類型

JsValuetrait是所有基本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有兩個子類JsSuccessJsError,分別用來處理成功和失敗兩種情況:

    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完美結合,開發出高性能的異步非阻塞系統。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,001評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,786評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,986評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,204評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,964評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,354評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,410評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,554評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,106評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,918評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,093評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,648評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,342評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,755評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,009評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,839評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,107評論 2 375

推薦閱讀更多精彩內容