处理表单提交
定义一个表单
play.api.data 包中包含了一些助手方法,用于处理HTTP表单数据提交和验证。操纵表单提交最容易的方式是定义一个 play.api.data.Form 结构:
import play.api.data._
import play.api.data.Forms._
val loginForm = Form(
tuple(
"email" -> text,
"password" -> text
)
)
该表单可以从Map[String,String]中生成一个(String, String)结果值。
val anyData = Map("email" -> "bob@gmail.com", "password" -> "secret")
val (user, password) = loginForm.bind(anyData).get
如果在上下文中包含request,你还可以直接从request内容中绑定:
val (user, password) = loginForm.bindFromRequest.get
构造复杂对象
一个表单对像可以使用函数来构造和解构值。例如你可以定义一个form来包装已有的case class:
import play.api.data._
import play.api.data.Forms._
case class User(name: String, age: Int)
val userForm = Form(
mapping(
"name" -> text,
"age" -> number
)(User.apply)(User.unapply)
)
val anyData = Map("email" -> "bob@gmail.com", "age" -> "18")
val user: User = userForm.bind(anyData).get
注意:使用 tuple 和 mapping 的不同在于,当你使用 tuple 时,构造和析构不需要指定(我们知道怎样构造和解构一个tuple,对吧?)。
mapping 方法仅让你定义你的自定义函数。当你想构造和解构一个case class,你只不过是使用 apply 和 unapply 函数,它们能精确的做到。
当然,通常Form签名不会精确的匹配case class。让我们举个包含额外的 checkbox 字段标识是否接受服务条款的例子。我们不需要將checkbox属性加入User类中。
它只是为了表单验证而加入的一个虚拟字段,一旦验证通过,该值便毫无用处。
由于我们可以自定义构造和解构函数,很容量处理这种情形:
val userForm = Form(
mapping(
"name" -> text,
"age" -> number,
"accept" -> checked("Please accept the terms and conditions")
)(
(name, age, _) => User(name, age),
(user: User) => Some(user.name, user.age, false)
)
)
注意:解析函数用于我们使用现有的User值填充表单的时候。这会对当我们需要从数据库加载User对象,填充表单,修改的这类用例很帮助。
定义约束
每一次映射,你都可以定义额外的约束,它將在绑定阶段被检查:
import play.api.data._
import play.api.data.Forms._
import play.api.data.validation.Constraints._
case class User(name: String, age: Int)
val userForm = Form(
mapping(
"name" -> text verifying(required),
"age" -> number verifying(min(0), max(100))
)(User.apply)(User.unapply)
)
注意:也可以写成
mapping(
"name" -> nonEmptyText,
"age" -> number(min=0, max=100)
)
你也可以在字段上特设一些限制:
val loginForm = Form(
tuple(
"email" -> nonEmptyText,
"password" -> text
) verifying("Invalid user name or password", {
case (e, p) => User.authenticate(e,p).isDefined
})
)
处理绑定失败
如果你定义了约束,你也需要处理绑定失败的情形。你可以使用 fold 完成:
loginForm.bindFromRequest.fold(
formWithErrors => // binding failure, you retrieve the form containing errors,
value => // binding success, you get the actual value
)
使用默认初始值填充表单
有时,你需要用现有值填充表单,特别是编辑数据的时候:
val filledForm = userForm.fill(User("Bob", 18))
嵌套值
表单映射可以定义嵌套值:
case class User(name: String, address: Address)
case class Address(street: String, city: String)
val userForm = Form(
mapping(
"name" -> text,
"address" -> mapping(
"street" -> text,
"city" -> text
)(Address.apply)(Address.unapply)
)(User.apply, User.unapply)
)
当你使用这种嵌套值的时候,从浏览器发送来的表单数据必须像address.street , address.city这样命名。
列表值
表单映射可以定义列表值:
case class User(name: String, emails: List[String])
val userForm = Form(
mapping(
"name" -> text,
"emails" -> list(text)
)(User.apply, User.unapply)
)
当你像这样使用列表值时,从浏览器发来的表单数据必须使用类似emails[0] , emails[1] , emails[2]的方式命名。
可选值
表单映射也可以定义可选值:
case class User(name: String, email: Option[String])
val userForm = Form(
mapping(
"name" -> text,
"email" -> optional(text)
)(User.apply, User.unapply)
)
注意:如果request不包含该值或值为空时,email域將会被忽略并设为None。
现在你可以综合可选值,嵌套和列表值来处理任何复杂的表单。
使用表单模版助手
Play提供了几个在HTML模版中渲染表单字段的助手方法。