Play路由器使用的配置文件为conf/routes,该文件列出了应用需要的所有路由规则。每条路由由HTTP方法和与Java调用相关联的URI组成。以下是路由配置的例子:
GET /clients/{id} Clients.show
路由配置总是从HTTP方法开始,URI作为中间部分,最后的元素是Java调用。在路由文件中可以使用#进行注释:
GET /clients/{id} Clients.show
3.1.1 HTTP方法#
HTTP协议支持以下所列的方法,用于指定客户请求服务器的动作,其中GET和POST是最为常用的两种方法:
GET
POST
PUT
DELETE
HEAD
Play同时也支持以WebSocket的方式来调用服务器端的Action方法,相关内容会在第八章进行详细介绍。
如果在路由文件中指定*作为HTTP方法,那么这个路由会匹配任何HTTP请求:
- /clients/{id} Clients.show
使用上述的路由配置,以下两个HTTP请求都会被框架接受:
GET /clients/1541
PUT /clients/1212
3.1.2 URI表达式#
URI表达式定义了路由规则需要的请求路径,请求路径中允许存在动态内容,但必须被声明在{}中。
/clients/all
以上的路由配置只能精确匹配到:
/clients/all
但是如果以包含动态部分配置路由规则:
/clients/{id}
则可以分别匹配:
/clients/12121
和
/clients/toto
如果某条路由配置的URI中需要包含多个动态部分,可以采用下例方法进行配置:
/clients/{id}/accounts/{accountId}
默认情况下,动态部分的匹配策略采用的是正则表达式/[^/]+/。也可以为动态部分定义自己的正则表达式,以下是使用正则表达式的例子。
路由规则只允许接受id为数字的值:
/clients/{<[0-9]+>id}
路由规则确保id是长度为4到10字符的小写单词:
/clients/{<[a-z]{4,10}>id}
正则表达式的使用非常灵活,还可以定义更多的路由规则,本节就不做赘述了。
注意:
动态部分指定后,控制器可以在HTTP参数map中获取该值。
默认情况下,Play将URI尾部的斜线(“/”)作为重要的组成部分,因为有无“/”将会出现不同的结果。比如:
GET /clients Clients.index
该路由规则会匹配/clients,而不是/clinets/(注意这里的区别),但可以通过在斜线后面增加问号来同时匹配两个URI:
GET /clients/? Clients.index
注意:
URI除了尾斜线不允许有其他可选的部分。
3.1.3 定义Java调用#
路由定义的最后部分为需要调用的Java方法:控制器中必须定义指定的Action方法,否则会提示找不到控制器方法的错误信息;必须声明为public static void方法;控制器需作为play.mvc.Controller的子类定义在controllers包中。
如果控制器没有在controllers包中定义,在配置路由规则时可以在其名称之前增加Java包(比如admin.Dashboard.index)的说明。由于controllers包本身被Play默认包含,所以用户在配置路由时不需要显式地指定。
GET /admin admin.Dashboard.index
3.1.4 404作为Action#
可以直接使用404作为路由配置中的Action部分。如果这样进行配置,对应的URL路径就会被Play应用所忽略。比如:
GET /favicon.ico 404
3.1.5 指定静态参数#
在某些情况下,可能会需要基于不同的参数值定义特殊路由。以下是预先定义好的Action:
public static void page(String id) {
Page page = Page.findById(id);
render(page);
}
针对该Action,常规的路由配置为:
GET /pages/{id} Application.page
现在给参数id=home的页面指定一条特殊的URL,需要通过设置静态参数来实现:
GET /home Application.page(id:'home')
GET /pages/{id} Application.page
当参数id=home时,两条路由配置等价,但是由于前者具有较高的优先级,所以被作为默认的URL来调用Application.page。
3.1.6 变量和脚本#
与模板中的使用方法类似,在routes文件中可以使用${...}作为变量表达式,使用%{...}作为脚本表达式,比如:
%{ context = play.configuration.getProperty('context', '') }%
GET ${context} Secure.login
GET ${context}/ Secure.login
共同学习,写下你的评论
评论加载中...
作者其他优质文章