Play的Response处理

2016-01-17

默认情况下，不需要指定Content-Length这个响应头，Play框架会根据响应内容自动计算出来，如

1
2
3

def normal = Action {
    Ok("Hello, Response")
}

会自动生成如下的响应头

1
2
3

Content-Length:15
Content-Type:text/plain; charset=utf-8
Date:Sun, 17 Jan 2016 05:26:14 GMT

可以使用play.api.libs.iteratee.Enumerator来生成响应内容，如

def normal = Action {
    Result(
      header = ResponseHeader(200),
      body = Enumerator("Hello, Enumerator".getBytes())
    )
}

这时也会生成Content-Length响应头，如下

1 2	Content-Length:17 Date:Sun, 17 Jan 2016 05:31:15 GMT

在Play框架中，会把所有的相应内容都加载到内存，再计算出响应内容的长度。如果响应内容很多，就会占用很多内容，这时就需要自己来指定Content-Length来解决，如：

def normal = Action {
    import play.api.libs.concurrent.Execution.Implicits._
    val file = new File("d:\\a.pdf")
    Result(
      header = ResponseHeader(200, Map(CONTENT_LENGTH -> file.length().toString)),
      body = Enumerator.fromFile(file)
    )
}

如果要处理文件，可以通过Ok.sendFile方法，如

1
2
3

def header = Action {
    Ok.sendFile(content = new File("d:\\a.pdf"))
}

这时会生成如下的响应头：

Content-Disposition:attachment; filename="a.pdf"
Content-Length:54503
Content-Type:application/pdf
Date:Sun, 17 Jan 2016 05:40:49 GMT

在浏览器访问时，会自动下载这个文件，文件名为a.pdf

也可以指定其他的下载文件名，如:

1
2
3

def header = Action {
    Ok.sendFile(content = new File("d:\\a.pdf"), fileName = _ => "custom.pdf")
}

这时生成的响应头如下：

Content-Disposition:attachment; filename="custom.pdf"
Content-Length:54503
Content-Type:application/pdf
Date:Sun, 17 Jan 2016 05:42:32 GMT

也可以通过指定inline参数，让浏览器直接打开这个文件，如

1
2
3

def header = Action {
    Ok.sendFile(content = new File("d:\\a.pdf"), fileName = _ => "custom.pdf", inline = true)
}

这时生成的响应头如下：

1
2
3

Content-Length:54503
Content-Type:application/pdf
Date:Sun, 17 Jan 2016 05:43:44 GMT

浏览器会直接显示支持的文件格式的内容。

在Play中，支持Chunked传输形式，如

def chunked = Action {
    import play.api.libs.concurrent.Execution.Implicits._
    val stream = new FileInputStream("d:\\a.pdf")
    Ok.chunked(Enumerator.fromStream(stream))
}

也可以通过Enumerator的apply方法生成chunked的内容，如

1
2
3

def chunked = Action {
    Ok.chunked(Enumerator("Hello", "World", "zhulx").andThen(Enumerator.eof))
}

在Play中，可以通过chunked机制来实现comet，如

def comet = Action {
    val events = Enumerator(
      """<script>console.log('hello')</script>""",
      """<script>console.log('World')</script>"""
    )

    Ok.chunked(events).as(HTML)
}

这样，在浏览器的控制台就会打印日志。

可以通过play.api.libs.iteratee.Enumeratee来转换Enumerator对象，如

import play.api.libs.concurrent.Execution.Implicits._
def toCometMessage = Enumeratee.map[String] {
  data => Html( """<script>console.log('""" + data + """')</script>""")
}

def comet = Action {
  val events = Enumerator("Hello", "world")
  Ok.chunked(events &> toCometMessage)
}

也可以使用play.api.libs.Comet帮助类

def comet = Action {
   val events = Enumerator("Hello2", "World2")
   Ok.chunked(events &> Comet("console.log"))
}