HTTP routing[翻译]

原文:https://www.playframework.com/documentation/2.5.x/ScalaRouting

内置HTTP路由器

路由器的职责是负责转换每一个进入的HTTP请求给Action

一个HTTP请求可以被看做是由MVC框架的事件。这个事件包含两个主要的信息:

1.请求路径(e.g. /clients/1542, /photos/list), 包含查询字符串

2.HTTP 方法 (e.g. GET, POST, …).

路由是在可被编译的conf/routes文件中被定义的。这意味着你可以在你的浏览器中直接看到路由的错误信息

依赖注入

Play支持生成两种路由器的类型,一个是依赖注入路由器,另一个是静态路由。默认的是依赖注入路由器,这也是在Play种子Activator模板中的样例,因此我们推荐你使用依赖注入Contrlller。如果你需要使用静态Contrller,你可以通过在你的build.sbt配置文件里添加下面这样的配置来转换到静态路由生成器:

routesGenerator:= StaticRoutesGenerator

在Play的文档中的代码样例假定你使用了依赖注入路由生成器。如果你没有使用这个,你可以容易的改写代码样例到静态路由生成器,既可以使用@符号在路由的Controller的调用部分加上前缀,或者通过声明你的每一个Contrller为object而不是class。

路由文件的语法

conf/routes是路由器使用的配置文件。这个文件里出了应用需要的所有的路由。每个路由由HTTP方法和URI模式组成,这两个都与调用Action生成器相关。

让我们来看一看路由定义的样子:

GET  /clients/:idcontrollers.Clients.show(id: Long)

每一个路由以HTTP方法开始,下来是URI模式。最后一个元素是调用定义。

你也可以以#字符开头在路由文件中增加注释。

# Display a client.

GET     /clients/:id      controllers.Clients.show(id: Long)

你可以通过一个特殊的前缀“->”,告诉路由文件使用一个不同的路由器:

->      /api                  api.MyRouter

当你和String Interpolating Routing DSL也被称作SIRD路由整合时,或者当你使用了多个路由文件的子项目时,这非常有用。

HTTP方法

HTTP方法可以使用任何被HTTP (GET, PATCH, POST, PUT, DELETE, HEAD)支持的有效方法。

URI模式

URI模式定义了路由的请求路径,请求路径的部分可以是静态的。

静态路径

例如,为了准确的匹配到输入的 GET /clients/all 请求,你可以定义这样的路由:

GET  /clients/all      controllers.Clients.list()

动态路径

如果你想定义一个通过ID检索一个客户的路由,你将需要增加一个动态的部分:

GET  /clients/:idcontrollers.Clients.show(id: Long)

注意:URI模式可能会有多个动态的部分。

动态部分的默认匹配策略是通过正则表达式 [^/]+定义的,意思就是说任何一个定义为:id 的动态部分将严格的匹配一个URI路径段。不像其他的模式类型,在路由中路径段自动地URI-解码,而是在传递给你的Controller之前,并在反向路由中解码。

动态部分跨越多个/

如果你想让动态部分可以捕获多个通过正斜杠分割的URI路径段,你可以使用语法*id(没被称为使用.*正则表达的通配符模式)定义动态部分:

GET     /files/*   namecontrollers.Application.download(name)

这个配置匹配像GET /files/images/logo.png样的请求,动态部分name 将会捕捉到值images/logo.png 。

注意:跨越多个/的动态部分不会被路由器解码也不会被反向路由器编码。你的职责是验证任何用户可能的输入原生的URI段。反向路由器简单的做一个字符串的连接,因此你将需要确保结果路径是有效的,或不是,例如,含有多个前导斜杆或非ASCII字符。

自定义正则表达的动态部分

你也可以使用$id 语法为动态部分定义你自己的动态表达式:

GET  /items/$id<[0-9]+>    controllers.Items.show(id: Long)

就像通配符路由一样,参数不会被路由器编码或反向路由器解码。你的职责是验证输入,确保它在这个环境下的意义。

调用Action生成器方法

路由定义的最后一部分是调用。这部分必须定义一个有效的调用到一个返回 play.api.mvc.Action 值的方法,通常情况下是一个Controller的Action方法。

如果方法没有定义任何参数,仅使用完全限定的方法名:

GET  /                    controllers.Application.homePage()

如果Action方法定义了一些参数,所有这些参数的值将会在请求的URI中搜索,要么从URI路径本身提取,要么从查询字符串中。

# 从路径中提取page参数

GET  /:page            controllers.Application.show(page)

或者:

# 从查询字符串中提取页面参数

GET    /     controllers.Application.show(page)​​

相应的,在controllers.Application Controller中定义show方法:

def show(page: String) = Action {

loadContentFromDatabase(page).map { htmlContent =>

Ok(htmlContent).as("text/html")

}.getOrElse(NotFound)

}

参数类型

对于String类型的参数,输入参数是可以选的。如果你想让Play把传入的参数转换成特殊的Scala类型,你可以指定参赛类型:

GET  /clients/:idcontrollers.Clients.show(id: Long)

在 controllers.Clients Controller中相应的实现一个相同的show方法定义:

def show(id: Long) = Action {

Client.findById(id).map { client =>

Ok(views.html.Clients.display(client))

}.getOrElse(NotFound)

}

固定值的参数

有时你想为参数使用一个固定的值:

# Extract the page parameter from the path, or fix the value for /

GET  /            controllers.Application.show(page = "home")

GET  /:page                controllers.Application.show(page)

带有默认值的参数

在传入的请求没有找到值的时候,你也可以提供一个默认值:

# Pagination links, like /clients?page=3

GET /clients controllers.Clients.list(page: Int ?= 1)

Optional类型的参数

你也可以指定一个不需要在所有的请求中都出现的Optional类型的参数:

# The version parameter is optional. E.g. /api/list-all?version=3.0

GET /api/list-all controllers.Api.list(version: Option[String])

路由的优先级

许多路由可以匹配到相同的请求,如果有冲突,第一个路由(按声明的顺序)被使用。

反转路由

路由器也可以被用来从Scala调用内部生成URL。这让在一个单独的配置文件中集中所有的URI模式成为可能,因此你在重构你的应用是会更加自信。

对于路由文件中的每一个使用的Controller,路由器会在routes包中生成一个有相同签名的相同Action方法的‘Reverse Controller’,但是返回play.api.mvc.Call 而不是play.api.mvc.Action.

例如,如果你创建一个这样的Controller:

package controllers

import play.api._

import play.api.mvc._class

Application extends Controller { def hello(name: String) = Action { Ok("Hello " + name + "!") } }

并且如果你在conf/routes文件中增加了映射:

# Hello action

GET     /hello/:name     controllers.Application.hello(name)

然后你就可以使用controllers.routes.Application反转Controller反转URL到Action方法:

// Redirect to /hello/Bob

def helloBob = Action { Redirect(routes.Application.hello("Bob")) }

注意:每一个Controller包都有一个路由子包。因此Action controllers.admin.Application.hello 可以通过controllers.admin.routes.Application.hello(只要在路由文件中的这个路由之前没有其他可匹配的生成路径)被反转。

反转Action方法的原理很简单:它拿到你的参数,并在路由模式中替换它们。在路径段(:foo)的例子中,值在替换完成之前解码,对于正则模式和通配符模式,字符串在原始形态中被替换,因此值可以跨越多个段。确保当你把这些组件传递给反转路由时忘记了这些必须的组件,并避免传递无效的用户输入。

默认的Controller

Play有一个提供了几个有用的Action的默认Controller,这些可以在路由文件中直接调用:

# Redirects to https://www.playframework.com/ with 303 See Other

​GET  /about controllers.Default.redirect(to ="https://www.playframework.com/")

# Responds with 404 Not Found

​GET  /orders controllers.Default.notFound

# Responds with 500 Internal Server Error

​GET  /clients controllers.Default.error

​# Responds with 501 Not Implemented

​GET  /posts controllers.Default.todo

在这个例子中,GET / 重定向到外部的站点,但是它也可以重定向到其他的Action(如上面的例子中的/posts )。

自定义路由

Play提供了一个 DSL 来定义嵌入的路由器,这个路由器被称为 String Interpolating Routing DSL,或者简写为SIRD。这个DSL有很多用途,包括嵌入一个轻量级的Play服务,提供自定义或更高级的路由功能给规范的Play应用,在测试方面甩REST服务几条街。

详见String Interpolating Routing DSL

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,463评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,868评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,213评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,666评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,759评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,725评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,716评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,484评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,928评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,073评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,718评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 内置的HTTP路由器 这个路由器用于翻译每一个接收到的HTTP请求到对应的action(一个controller类...
    zerolinke阅读 1,952评论 0 0
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,028评论 25 707
  • 本系列主要翻译自《ASP.NET MVC Interview Questions and Answers 》- B...
    圣杰阅读 7,285评论 3 32
  • 青石的喷泉不停地唱晚 芦苇青草边,一围古筝山高水流 许是竹影婆娑 沉香袅袅,唉 这一个下午 . 当炭火煮熟一壶玉竹...
    东山岛高永川阅读 391评论 0 1