1. 是什么
Routes 的存在是为了匹配请求中的URL
和定义的controller#action
.
让我来简单地举个例子:config/routes.rb
是你程序的大门,门后有许多细小的路径通向你想要真正到达的目的地,每条路径的入口处都有一个路牌,告诉你目的地的名称,通过辨别路牌你就可以到达最终想要的目的地而不用担心迷路。那么分析一下上述例子,每一条路径就是你定义的一个你定义的route
规则,路口的路牌是请求中HTTP动词 + URL
的组合,道路通向的目的地是某个控制器的特定行为。除匹配功能之外,路径还提供了些附带功能,比如自动生成_url 和 _path
帮助方法,分别用来表示该路径的绝对路径和相对路径,而不需要使用硬编码字符串。
2. 在哪定义
快速浏览routes.rb
: 所有路径的定义在传给 Rails.application.routes.draw
的一个大大的block
中。定义路径的代码是简单的红宝石代码,你需要按照特定的规则定义路径,主要的定义方式有两种: 普通路径和资源路径,稍后会详细介绍。当有请求进入时,代码块中的代码自顶向下执行,请求会查看每个路径的路牌是否匹配,并被分发到第一个匹配的路径,如果没有匹配的路径,程序会返回给调用者一个HTTP 404
.
3. 普通路径
普通路径又称为非资源路径,虽然大多数情况下你使用的都是资源型的路径,但是某些特定的情况,普通路径会更加合理,比如某些无法抽象成资源的时候,或是在遗留系统中给老的URL
匹配一些新的行为等等。下面列出了一些常见的例子:
root to: 'pages#main'
get 'users/:id', to: 'users#show'
get 'users/:id', to: 'users#show', defaults: { format: 'json' }
get 'users/:id', to: 'users#show', as: :members # members_path(@user)
4. 资源路径
资源路径使用一条语句可以快速定义多条路径规则,这些路径规则符合特定规律,所以便于其他程序员阅读代码。在学习资源路径之前先要理解两个概念: CRUD, RESTful.
RESTful 把事物抽象成资源,在不同层次统一操作类型。如用户注册操作,发送一个对用户资源的创建操作请求 -> 通过路径匹配到了控制器的创建行为 -> 在数据库中插一条新的用户记录。CRUD 把对资源的操作抽象为四类 CREATE, READ, UPDATE, DELETE
.
4.1 帮助方法
RESTful
路径会自动生成一堆helper
:
photos_url/path
映射到 index, create
new_photo_url/path
映射到 new
edit_photo_url/path
映射到 edit
photo_url/path
映射到 show, update, destroy
Tip: 可以在控制台里通过使用 app.xxx_path
来查看路径
Tip: 可以在控制台里通过使用 app.url_for(@user)
来查看完整路径
Tip: 若URL
中包含subdomain
要使用_url
来确保路径是完整的
4.2 单资源
单资源没有index
单资源生成如下的helper
:
new_geocoder_url/path
映射到 new
edit_geocoder_url/path
映射到 edit
geocoder_url/path
映射到 create, show, update, destroy
Tip: 资源名是单数形式,但是对应的controller
名称依然是复数
Tip: 单资源在使用form_for
定义表单时,要制定url
,否则会错误
form_for @geocoder, url: geocoder_path do |f|
5. 路径高级用法
(1) 一次定义多个资源:resources :photos, :books, :videos
(2) 嵌套资源:多层嵌套会污染路径,降低可读性,保持单层嵌套
(3) 嵌套资源最佳实现:浅嵌套,使用shallow
只嵌套index, create, new
(4) 在资源中添加额外路径:member, collection
注意两者逻辑区别
(5) 使用controller
来指定资源所对应的控制器
例如:map.resources :photos, :controller => "images"
帮助方法时会依据资源的名称生成,而不是controller
的名称
因此,在这个例子里,就会得到photos_path, new_photo_path
等等.
(6) 使用namespace
来管理你的路径和控制器
控制器必须包裹在命名空间模块中,并所属与相应的文件目录下;
路径包含相同的命名空间来和控制器相匹配
(7) 若想打破路径命名空间和控制器模块相匹配的规则,使用scope
使用module
选项可以去除url
路径和帮助方法中的命名空间名称,保持简洁
使用path
选项可以在url
中增添虚拟的命名空间名称,增加路径的逻辑结构
使用as
选项可以在生成的帮助方法中添加前缀名称
(8) 使用concern
来共享某个路径,如共享子资源,命名空间包含路径等
(9) 使用only 和 except
限制自动生成的路径规则
(10) 使用constraints
生成自定义限制
constraints: { id: /^\d/ }
限制参数格式
constraints subdomain: 'admin'
限制子域名
6. 路径的查看和测试
个人觉得给路径写测试没什么必要,使用以下方式看看一就好啦
网页版查看路径信息:http://localhost:3000/rails/info/routes
命令行查看路径信息:$ rake routes # -g 过滤请求条件, -c 过滤控制器条件
$ rake routes -g new_user
$ rake routes -g POST
$ rake routes -g /admin/users/:id
$ rake routes -c users
$ rake routes -c admin/users