§Play JSON ライブラリとジェネリクス対応

§概要

Play の型クラスベースの JSON ライブラリを利用すると、各種の型クラスにジェネリクスのサポートを追加することができます。この機能は、例えば REST API を実装する場合に有効です。具体的には、REST API のレスポンスの構造をクラスなどに切り出しておき、エンドポイントに応じてレスポンスに含まれる要素だけを変更するというような使い方が可能です。

§Scala のジェネリクス機能

仮に、REST API の検索結果の基本構造を以下のように定義したとします。

case class SearchResults[T](
    elements: List[T], 
    page: Int, 
    pageSize: Int, 
    total :Int
)

このとき、JSON のシリアライズ・デシリアライズを行うメソッドが 総称型 List[T] を扱えるようにするためには、型クラス T の読み書きを行なう暗黙的な引数を用意する必要があります。

object SearchResults
{
  implicit def searchResultsReads[T](implicit fmt: Reads[T]): Reads[SearchResults[T]] = new Reads[SearchResults[T]] {
	def reads(json: JsValue): SearchResults[T] = new SearchResults[T] (
	  
     (json \ "elements") match {
      	case JsArray(ts) => ts.map(t => fromJson(t)(fmt))
      	case _ => throw new RuntimeException("Elements MUST be a list")
	  },
      (json \ "page").as[Int],
      (json \ "pageSize").as[Int],
      (json \ "total").as[Int]
    )
  }
  
  implicit def searchResultsWrites[T](implicit fmt: Writes[T]): Writes[SearchResults[T]] = new Writes[SearchResults[T]] {
    def writes(ts: SearchResults[T]) = JsObject(Seq(
        "page" -> JsNumber(ts.page),
        "pageSize" -> JsNumber(ts.pageSize),
        "total" -> JsNumber(ts.total),
        "elements" -> JsArray(ts.elements.map(toJson(_)))
    ))  
  }
}

§基本的な JSON データ型

先ほどの型クラスさえ用意しておけば、play.api.libs.json パッケージで定義されているあらゆる基本的なデータタイプを簡単に生成・利用することができます。

val input = """{"page": 1,"pageSize":2, "total": 3, "elements" : [1, 2, 3]}"""
val ret = play.api.libs.json.Json.parse(input).as[SearchResults[Int]]

§より複雑な型

より複雑な JSON オブジェクトに対応するためには、それ専用のシリアライズ・デシリアライズ方法を定義してください。

case class Foo(name: String, entry: Int) 

object Foo {
  implicit object FopReads extends Format[Foo] {
    def reads(json: JsValue) = Foo(
      (json \ "name").as[String],
      (json \ "entry").as[Int])
    def writes(ts: Foo) = JsObject(Seq(
      "name" -> JsString(ts.name),
      "entry" -> JsNumber(ts.entry)))
  }
}

これで、ケースクラス “Foo” が “SearchResults” の一部として利用できるようになります。

val input = """{"page": 1,"pageSize":2, "total": 3, "elements" : [ {"name" : "foo", "entry" : 1 }, {"name" : "bar", "entry" : 2 }]}"""
val ret = play.api.libs.json.Json.parse(input).as[SearchResults[Foo]]

このドキュメントの翻訳は Play チームによってメンテナンスされているものではありません。 間違いを見つけた場合、このページのソースコードを ここ で確認することができます。 ドキュメントガイドライン を読んで、お気軽にプルリクエストを送ってください。