从Play 2 Scala控制器提供静态/公共/文件

Question

从Play Framework 2 Scala控制器提供静态文件的首选方法是什么？

该文件与我的应用程序捆绑在一起，因此无法对文件系统绝对/path/to/the/file进行硬编码，因为它的位置取决于Play应用程序恰好安装的位置。

该文件放在public / dir中，但不在app / assets /中，因为我不希望Play编译它。

（我不是简单地添加到该文件的路由的原因是，在访问该文件之前需要登录，否则它是没用的。）

这是我到目前为止所做的，但这在我的生产服务器上中断了。

object Application ...

  def viewAdminPage = Action ... {
    ... authorization ...
    val adminPageFile = Play.getFile("/public/admin/index.html")
    Ok.sendFile(adminPageFile, inline = true)
  }

在我的routes文件中，我有这一行：

GET /-/admin/ controllers.Application.viewAdminPage

问题是在我的生产服务器上，会发生以下错误： FileNotFoundException: app1/public/admin/index.html

有没有其他方法，而不是Play.getFile和OK.sendFile，来指定要服务的文件？生产中从未打破过？

（我的应用程序安装在/some-dir/app1/，我从/some-dir/开始（没有app1/） - 如果我从/some-dir/app1/启动应用程序，也许一切都会有用。但我想知道一个“应该”如何做，以提供一个静态文件从控制器内部？所以一切都始终在生产服务器上工作，无论我从哪里开始应用程序）

Answer 1

Play有一个内置的方法：

  Ok.sendResource("public/admin/file.html", classLoader)

您可以使用Environment或environment.classLoader从注入的this.getClass.getClassLoader获取类加载器。

Answer 2

检查Streaming HTTP responses doc

def index = Action {
  Ok.sendFile(
    content = new java.io.File("/tmp/fileToServe.pdf"),
    fileName = _ => "termsOfService.pdf"
  )
}

您可以将一些随机字符串添加到fileName（每个已登录用户的个人），以避免在经过身份验证的用户和非验证用户之间共享下载链接，还可以制作高级下载统计信息。

Answer 3

我这样做了:(但请参阅下面的更新！）

val fileUrl: java.net.URL = this.getClass().getResource("/public/admin/file.html")
val file = new java.io.File(adminPageUrl.toURI())
Ok.sendFile(file, inline = true)

（this是控制器，它（并且必须）与正在服务的文件位于同一个包中。）

这是一个相关的问题：open resource with relative path in java

更新

通过URI访问文件会导致错误：IllegalArgumentException: URI is not hierarchical，如果文件随后位于JAR中，如果您运行Play就是这种情况：play stage然后target/start。

因此，我将文件作为流读取，将其转换为String，并将该字符串作为HTML发送：

val adminPageFileString: String = {
  // In prod builds, the file is embedded in a JAR, and accessing it via
  // an URI causes an IllegalArgumentException: "URI is not hierarchical".
  // So use a stream instead.
  val adminPageStream: java.io.InputStream =
    this.getClass().getResourceAsStream("/public/admin/index.html")
  io.Source.fromInputStream(adminPageStream).mkString("")
}

...

return Ok(adminPageFileString) as HTML

Answer 4

手动方法如下：

val url = Play.resource(file)
url.map { url =>
  val stream = url.openStream()
  val length = stream.available 
  val resourceData = Enumerator.fromStream(stream)

  val headers = Map(
        CONTENT_LENGTH -> length.toString,
        CONTENT_TYPE -> MimeTypes.forFileName(file).getOrElse(BINARY),
        CONTENT_DISPOSITION -> s"""attachment; filename="$name"""")

  SimpleResult(
    header = ResponseHeader(OK, headers), 
    body = resourceData)

使用资产控制器的等价物如下：

val name = "someName.ext"

val response = Assets.at("/public", name)(request)
response
  .withHeaders(CONTENT_DISPOSITION -> s"""attachment; filename="$name"""")

Answer 5

另一种变体，不使用String，而是通过流式传输文件内容：

def myStaticRessource() = Action { implicit request =>

  val contentStream = this.getClass.getResourceAsStream("/public/content.html")

  Ok.chunked(Enumerator.fromStream(contentStream)).as(HTML)

}