Content negotiation


原文:Content negotiation

内容协商是一个让相同资源(URI)的不同表现成为可能的机制。它是有用的,如,为了写一个支持多种输出格式(XML, JSON, 等等)的Web Services。本质上,服务端驱动的协商是使用了 Accept* 请求的头执行。你可以在HTTP规范中找到更多关于内容协商的信息。

语言

Play在方法play.api.mvc.Controller#lang中使用它,这个方法提供一个隐式的 play.api.i18n.Lang 值给你的Action,因此他们自动的使用了最佳的语言(如果你的应用支持,否则你的应用的默认语言会被使用)。

内容

实际上,Accept 头没有真的包含MIME 类型而是媒体范围(例如,请求接受所有的文本结果会设置为 text/* 范围,而/ 范围意味着所有的结果类型都接受)。Controllers 提供一个较高水平的render 方法来帮助你处理媒体范围。例如考虑下面的Action定义:

val list = Action { implicit request =>  
val items = Item.findAll  
render {  
case Accepts.Html() => Ok(views.html.list(items))  
case Accepts.Json() => Ok(Json.toJson(items))  
}
}

Accepts.Html() 和 Accepts.Json() 是提取器,它们测试是否已给的媒体范围匹配各自的 text/html 和application/json 。render 方法从 play.api.http.MediaRange到play.api.mvc.Result 使用了部分功能,并试着按优先次序把它运用到每一个在请求Accept 头中找到的媒体范围。如果没有你的方法不支持可接受的媒体范围, 会返回NotAcceptable结果。例如,如果客户端对Accept头使用下面的值: /;q=0.5,application/json发起请求,意味着它接受任何结果类型而不只是JSON,上面的代码将返回JSON形式。如果另一个客户端对Accept 头使用这样的值: application/xml,意味着它只接受XML,上面的代码将返回NotAcceptable。

请求提取器

详见 play.api.mvc.AcceptExtractors.Accepts 对象的API文档,它在render 方法中方便的为Play提供了支持的MIME 类型的列表。你可以容易的为一个给定的MIME类型使用play.api.mvc.Acceptingcase class, 创建你自动的提取器,例如下面的代码创建一个提取器检测媒体范围是否匹配 audio/mp3MIME类型:

val AcceptsMp3 = Accepting("audio/mp3")  
render {  
case AcceptsMp3() => ???  
}
}

祝青

继续阅读此作者的更多文章