什么是Action?
一个Play应用接收到的请求一般都交给 Action 来处理。
而一个 play.api.mvc.Action 本质上就是一个 (play.api.mvc.Request => play.api.mvc.Result) 函数,它被用来处理请求并返回结果。
def echo = Action { request =>
Ok("Got request [" + request + "]")
}
Action 返回的每个 play.api.mvc.Result 都代表着一个HTTP响应。这里的 Ok() 将创建一个 200 OK 响应,包含一个 text/plain 响应体。更多HTTP响应例子请移步 play.api.mvc.Result。
创建一个Action
对于任意继承 BaseController 的子类来说,Action 都是其默认的 action builder。此 action builder 包含一些创建 Action 的辅助方法。
最简单的就是接受一个表达式块,并返回一个 Result:
Action {
Ok("Hello world")
}
此方法的确会创建一个 Action,但是我们不会得到请求 request 的引用。而在Action中常常需要一个HTTP request。要得到Request对象,你可以使用如下 Request => Request 函数 :
Action { request =>
Ok("Got request [" + request + "]")
}
更常用的做法是将 request 标识为 implicit,使之可以被其它API隐式调用:
Action { implicit request =>
Ok("Got request [" + request + "]")
}
如果将代码分解为方法,那么你在action中可以传递这个隐式的request:
def action = Action { implicit request =>
anotherMethod("Some para value")
Ok("Got request [" + request + "]")
}
def anotherMethod(p: String)(implicit request: Request[_]) = {
// do something that needs access to the request
}
最后一种创建Action的方式是定义一个额外的 BodyParser 参数:
Action(parse.json) { implicit request =>
Ok("Got request [" + request + "]")
}
后面会详述 parser 有关内容。现在你只需要知道其它创建Action的方法会使用一个默认的 Any content body parser。每本书都是这个套路 : (
Controllers 就是action产生器
在Play中,controller就是一个用于生产Action值的对象。
典型的Controller一般被定义为类,以利用依赖注入。
注意:请记住,未来的Play版本将不再支持将controller定义为objects。推荐的做法是使用 classes。
先看一个最简单的无参方法:
package controllers
import javax.inject.Inject
import play.api.mvc._
class Application @Inject()
(cc: ControllerComponents)
extends AbstractController(cc) {
def index = Action {
Ok("It works!")
}
}
当然,action产生器也可以带参数,这些参数可以在一个Action闭包中被捕获:
def hello(name: String) = Action {
Ok("Hello " + name)
}
简单results
我们先来看简单results:它是一个发送给客户端的,带有状态码、一些HTTP头及body的HTTP results。
这些results定义在 play.api.mvc.Result 中:
import play.api.http.HttpEntity
def index = Action {
Result(
header = ResponseHeader(200, Map.empty),
body = HttpEntity.Strict(ByteString("Hello world!"), Some("text/plain"))
)
}
当然,也提供了一些辅助工具用于创建常用的result,如上文提到的 Ok 方法:
def index = Action {
Ok("Hello world!")
}
上面两段代码将产生一模一样的result。
下面是一些其他的例子:
val ok = Ok("Hello world!")
val notFound = NotFound
val pageNotFound = NotFound(<h1>Page not found</h1>)
val badRequest = BadRequest(views.html.form(formWithErrors))
val oops = InternalServerError("Oops")
val anyStatus = Status(488)("Strange response type")
所有这些辅助方法都在 play.api.mvc.Results 特质及伴生对象中。
Redirects也是简单results
浏览器重定向到一个新的URL只是另一种简单result。不同的地方只是这种result不含有response体。
同样的,我们内置了一些开箱即用的辅助方法来产生redirect:
def index = Action {
Redirect("/user/home")
}
默认将使用 303 SEE_OTHER 响应类型,你也可以通过如下方法来自定义:
def index = Action {
Redirect("/user/home", MOVED_PERMANENTLY)
}
TODO 虚拟页面
可以使用一个用TODO定义的空的Action实现:相应的result是一个标准的 'Not implemented yet' 页面:
def index(name:String) = TODO