You are viewing the documentation for the 2.0.8 release in the 2.0.x series of releases. The latest stable release series is 2.4.x.

§ボディパーサー

§ボディパーサーの概要

HTTP PUT や POST リクエストはボディを含みます。このボディは Content-Type リクエストヘッダで指定さえしておけば、どんなフォーマットであっても構いません。**ボディパーサー** はリクエストボディを Java の値に変換する役割を持ちます。

ノート: BodyParser は Java を使って直接実装する事は出来ません。Play の BodyParser はリクエストボディの内容を Iteratee[Array[Byte], A] を使ってインクリメンタルに処理する必要があるため、 Scala で実装しなければなりません。

しかし Play が提供するデフォルトの BodyParser はほとんどのケースで十分機能します(Json、Xml、テキストの解析やファイルアップロードなど)。そしてこれらのデフォルトパーサーを再利用して独自のボディパーサーを作ることができます。例えば、テキストのパーサーから RDF のパーサーを提供することができます。

§`BodyParser` API

Java では全てのボディパーサーは play.mvc.Http.RequestBody を生成します。ボディパーサーから算出されたこの値は request().body() から取得できます。

public static Result index() {
  RequestBody body = request().body();
  return ok("Got body: " + body);
}

アクションで使用する BodyParser を指定したい場合は、@BodyParser.Of アノテーションを使用します。

@BodyParser.Of(BodyParser.Json.class)
public static Result index() {
  RequestBody body = request().body();
  return ok("Got json: " + body.asJson());
}

§`Http.RequestBody` API

先ほど Java の API では全てのボディパーサーは play.mvc.Http.RequestBody を提供すると述べました。このボディオブジェクトからはリクエストボディの内容を Java における適切な型で取得できます。

ノート: asText() や asJson() 等の RequestBody のメソッドは、パーサーがこのコンテントタイプをサポートしていない場合は null を返します。例えば、@BodyParser.Of(BodyParser.Json.class) アノテーションが付いたアクションメソッド内では、リクエストボディの asXml() を呼び出すと null を返します。

いくつかのパーサーは Http.RequestBody よりも明確な型 (つまり Http.RequestBody のサブクラス) を提供する事があります。リクエストボディを他の型に自動的にキャストするには as(...) ヘルパーメソッドを使用します。

@BodyParser.Of(BodyLengthParser.class)
pulic static Result index() {
  BodyLength body = request().body().as(BodyLength.class);
  ok("Request body length: " + body.getLength());
}

§デフォルトのボディパーサー： AnyContent

ボディパーサーを指定しない場合、Play はデフォルトのボディパーサーを使用します。このパーサーは Content-Type ヘッダから最も適切なコンテントタイプを推測してくれます。

text/plain: String。asText() でアクセスできます
application/json: JsonNode。asJson() でアクセスできます
text/xml: org.w3c.Document。asXml() でアクセスできます
application/form-url-encoded: Map<String, String[]>。asFormUrlEncoded() でアクセスできます
multipart/form-data: Http.MultipartFormData。asMultipartFormData() でアクセスできます
その他の Content-Type: Http.RawBuffer。asRaw()でアクセスできます

例えば、以下のように使用します。

pulic static Result save() {
  RequestBody body = request().body();
  String textBody = body.asText();
  
  if(textBody != null) {
    ok("Got: " + text);
  } else {
    badRequest("Expecting text/plain request body");
  }
}

§最大 content length

テキストベースのボディパーサー (**text**, json, xml, formUrlEncoded 等) は全てのコンテンツを一旦メモリにロードする必要があるため、最大 content length が設定されています。

デフォルトでは content length は 100KB です。

Tip: デフォルトの content length は application.conf から次のように定義できます。

parsers.text.maxLength=128K

最大の content length は @BodyParser.Of アノテーションで指定することができます。

// Accept only 10KB of data.
@BodyParser.Of(value = BodyParser.Text.class, maxLength = 10 * 1024)
pulic static Result index() {
  if(request().body().isMaxSizeExceeded()) {
    return badRequest("Too much data!");
  } else {
    ok("Got body: " + request().body().asText()); 
  }
}

次ページ: アクションの合成

§ボディパーサー