从外部开始的Rails路由

Chapters

1. Rails路由器的目的
   • 将URL连接到代码
   • 从代码生成路径和URL
   • 配置Rails路由器
2. 资源路由：Rails的默认设置
   • Web上的资源
   • CRUD、动词和动作
   • 路径和URL辅助方法
   • 同时定义多个资源
   • 单数资源
   • 控制器命名空间和路由
   • 嵌套资源
   • 路由关注点
   • 从对象创建路径和URL
   • 添加更多的RESTful操作
3. 非资源路由
   • 绑定参数
   • 动态片段
   • 静态片段
   • 查询字符串
   • 定义默认值
   • 命名路由
   • HTTP动词约束
   • 分段约束
   • 基于请求的约束
   • 高级约束
   • 路由全局匹配和通配符段
   • 重定向
   • 路由到Rack应用程序
   • 使用root
   • Unicode字符路由
   • 直接路由
   • 使用resolve
4. 自定义资源路由
   • 指定要使用的控制器
   • 指定约束条件
   • 覆盖命名路由助手
   • 覆盖 new 和 edit 段
   • 给命名路由助手添加前缀
   • 限制创建的路由
   • 翻译路径
   • 覆盖单数形式
   • 在嵌套资源中使用:as
   • 覆盖命名路由参数
5. 将非常大的路由文件拆分为多个小文件
   • 除非确实需要，否则不要使用此功能
6. 检查和测试路由
   • 列出现有路由
   • 测试路由

1 Rails路由器的目的

Rails路由器识别URL并将其分派给控制器的动作或Rack应用程序。它还可以生成路径和URL，避免在视图中硬编码字符串的需要。

1.1 将URL连接到代码

当您的Rails应用程序接收到传入请求时：

GET /patients/17

它会要求路由器将其与控制器动作匹配。如果第一个匹配的路由是：

get '/patients/:id', to: 'patients#show'

请求将被分派到patients控制器的show动作，并在params中传递{ id: '17' }。

注意：Rails在这里使用snake_case作为控制器名称，如果您有一个多个单词的控制器，比如MonsterTrucksController，您可以使用monster_trucks#show作为示例。

1.2 从代码生成路径和URL

您还可以生成路径和URL。如果上面的路由修改为：

get '/patients/:id', to: 'patients#show', as: 'patient'

并且您的应用程序在控制器中包含以下代码：

@patient = Patient.find(params[:id])

以及在相应的视图中包含以下内容：

<%= link_to 'Patient Record', patient_path(@patient) %>

那么路由器将生成路径/patients/17。这减少了视图的脆弱性，并使您的代码更容易理解。请注意，路由助手中不需要指定id。

1.3 配置Rails路由器

您的应用程序或引擎的路由位于文件config/routes.rb中，通常如下所示：

Rails.application.routes.draw do
  resources :brands, only: [:index, :show] do
    resources :products, only: [:index, :show]
  end

  resource :basket, only: [:show, :update, :destroy]

  resolve("Basket") { route_for(:basket) }
end

由于这是一个常规的Ruby源文件，您可以使用它的所有功能来帮助您定义路由，但是要小心变量名，因为它们可能与路由器的DSL方法冲突。

注意：包装您的路由定义的Rails.application.routes.draw do ... end块是必需的，以建立路由器DSL的范围，不能删除。

2 资源路由：Rails的默认设置

资源路由允许您快速声明给定资源控制器的所有常见路由。对resources的单个调用可以声明您的index、show、new、edit、create、update和destroy动作所需的所有路由。

2.1 Web上的资源

浏览器通过使用特定的HTTP方法（如GET、POST、PATCH、PUT和DELETE）请求URL来向Rails请求页面。每种方法都是对资源执行操作的请求。资源路由将多个相关请求映射到单个控制器中的动作。

当您的Rails应用程序接收到传入请求时：

DELETE /photos/17

它会要求路由器将其映射到控制器动作。如果第一个匹配的路由是：

resources :photos

Rails将将该请求分派到photos控制器的destroy动作，并在params中传递{ id: '17' }。

2.2 CRUD、动词和动作

在Rails中，资源路由提供了HTTP动词和URL到控制器动作的映射。按照惯例，每个动作还映射到数据库中的特定CRUD操作。路由文件中的单个条目，例如：

resources :photos

在您的应用程序中创建了七个不同的路由，都映射到Photos控制器：

注意：由于路由器使用HTTP动词和URL来匹配入站请求，因此四个URL映射到了七个不同的操作。

注意：Rails路由按照它们被指定的顺序进行匹配，所以如果你在resources :photos上方有一个get 'photos/poll'，那么resources行的show操作的路由将在get行之前匹配。要解决这个问题，将get行移到resources行之前，这样它将首先匹配。

2.3 路径和URL辅助方法

创建一个资源路由还将向应用程序的控制器公开一些辅助方法。以resources :photos为例：

• photos_path返回/photos
• new_photo_path返回/photos/new
• edit_photo_path(:id)返回/photos/:id/edit（例如，edit_photo_path(10)返回/photos/10/edit）
• photo_path(:id)返回/photos/:id（例如，photo_path(10)返回/photos/10）

每个辅助方法都有一个对应的_url辅助方法（例如photos_url），它返回以当前主机、端口和路径前缀为前缀的相同路径。

提示：要查找路由的路由辅助方法名称，请参见下面的列出现有路由。

2.4 同时定义多个资源

如果你需要为多个资源创建路由，可以通过一次调用resources来节省一些输入：

resources :photos, :books, :videos

这与以下代码完全相同：

resources :photos
resources :books
resources :videos

2.5 单数资源

有时，你有一个资源，客户端总是查找它而不引用ID。例如，你希望/profile始终显示当前登录用户的个人资料。在这种情况下，你可以使用单数资源将/profile（而不是/profile/:id）映射到show操作：

get 'profile', to: 'users#show'

将String传递给to:将期望一个controller#action格式。当使用Symbol时，to:选项应该替换为action:。当使用没有#的String时，to:选项应该替换为controller:：

get 'profile', action: :show, controller: 'users'

这个资源路由：

resource :geocoder
resolve('Geocoder') { [:geocoder] }

在你的应用程序中创建了六个不同的路由，都映射到Geocoders控制器：

注意：因为你可能希望将同一个控制器用于单数路由（/account）和复数路由（/accounts/45），单数资源映射到复数控制器。因此，例如，resource :photo和resources :photos会创建映射到同一个控制器（PhotosController）的单数和复数路由。

单数资源路由生成以下辅助方法：

• new_geocoder_path返回/geocoder/new
• edit_geocoder_path返回/geocoder/edit
• geocoder_path返回/geocoder

注意：调用resolve对于通过记录标识将Geocoder实例转换为路由是必要的。

与复数资源一样，以_url结尾的相同辅助方法也会包括主机、端口和路径前缀。

2.6 控制器命名空间和路由

你可能希望将一组控制器组织在一个命名空间下。最常见的情况是，你可能会将一些管理控制器分组到一个Admin::命名空间下，并将这些控制器放在app/controllers/admin目录下。你可以使用namespace块来路由到这样的一组控制器：

namespace :admin do
  resources :articles, :comments
end

这将为每个articles和comments控制器创建一些路由。对于Admin::ArticlesController，Rails将创建：

如果您希望将/articles（不带前缀/admin）路由到Admin::ArticlesController，您可以使用scope块指定模块：

scope module: 'admin' do
  resources :articles, :comments
end

这也可以用于单个路由：

resources :articles, module: 'admin'

如果您希望将/admin/articles路由到ArticlesController（不带Admin::模块前缀），您可以使用scope块指定路径：

scope '/admin' do
  resources :articles, :comments
end

这也可以用于单个路由：

resources :articles, path: '/admin/articles'

在这两种情况下，命名路由助手与不使用scope时保持相同。在最后一种情况下，以下路径映射到ArticlesController：

提示：如果您需要在namespace块内使用不同的控制器命名空间，可以指定绝对控制器路径，例如：get '/foo', to: '/foo#index'。

2.7 嵌套资源

通常会有逻辑上属于其他资源的子资源。例如，假设您的应用程序包括以下模型：

class Magazine < ApplicationRecord
  has_many :ads
end

class Ad < ApplicationRecord
  belongs_to :magazine
end

嵌套路由允许您在路由中捕获此关系。在这种情况下，您可以包含以下路由声明：

resources :magazines do
  resources :ads
end

除了杂志的路由之外，此声明还将路由广告到AdsController。广告URL需要一个杂志：

这也将创建诸如magazine_ads_url和edit_magazine_ad_path之类的路由助手。这些助手以Magazine的实例作为第一个参数（magazine_ads_url(@magazine)）。

2.7.1 嵌套的限制

如果需要，您可以将资源嵌套在其他嵌套资源中。例如：

resources :publishers do
  resources :magazines do
    resources :photos
  end
end

深度嵌套的资源很快变得繁琐。在这种情况下，例如，应用程序将识别以下路径：

/publishers/1/magazines/2/photos/3

相应的路由助手将是publisher_magazine_photo_url，您需要在所有三个级别指定对象。实际上，这种情况足够令人困惑，以至于Jamis Buck的一篇流行文章提出了一个关于良好Rails设计的经验法则：

提示：资源嵌套不应超过1级。

2.7.2 浅层嵌套

避免深层嵌套（如上所述）的一种方法是在父级下生成集合操作，以便了解层次结构，但不嵌套成员操作。换句话说，只构建具有唯一标识资源的最少信息的路由，如下所示：

resources :articles do
  resources :comments, only: [:index, :new, :create]
end
resources :comments, only: [:show, :edit, :update, :destroy]

这个想法在描述性路由和深层嵌套之间取得了平衡。存在一种简写语法可以通过shallow选项实现这一目标：

resources :articles do
  resources :comments, shallow: true
end

这将生成与第一个示例完全相同的路由。您还可以在父资源中指定:shallow选项，这样所有嵌套资源都将是浅层的：

resources :articles, shallow: true do
  resources :comments
  resources :quotes
  resources :drafts
end

这里的articles资源将生成以下路由：

DSL的shallow方法创建了一个作用域，在其中每个嵌套都是浅层的。这将生成与前一个示例相同的路由：

shallow do
  resources :articles do
    resources :comments
    resources :quotes
    resources :drafts
  end
end

scope有两个选项可以自定义浅层路由。:shallow_path在成员路径前加上指定的参数：

scope shallow_path: "sekret" do
  resources :articles do
    resources :comments, shallow: true
  end
end

这里的comments资源将生成以下路由：

:shallow_prefix选项将指定的参数添加到命名路由助手中：

scope shallow_prefix: "sekret" do
  resources :articles do
    resources :comments, shallow: true
  end
end

这里的comments资源将生成以下路由：

2.8 路由关注点

路由关注点允许您声明可以在其他资源和路由中重复使用的常见路由。要定义一个关注点，请使用concern块：

concern :commentable do
  resources :comments
end

concern :image_attachable do
  resources :images, only: :index
end

这些关注点可以在资源中使用，以避免代码重复并在路由之间共享行为：

resources :messages, concerns: :commentable

resources :articles, concerns: [:commentable, :image_attachable]

以上等同于：

resources :messages do
  resources :comments
end

resources :articles do
  resources :comments
  resources :images, only: :index
end

您还可以通过调用concerns在任何地方使用它们。例如，在scope或namespace块中：

namespace :articles do
  concerns :commentable
end

2.9 从对象创建路径和URL

除了使用路由助手之外，Rails还可以根据参数数组创建路径和URL。例如，假设您有以下路由集合：

resources :magazines do
  resources :ads
end

当使用magazine_ad_path时，您可以传递Magazine和Ad的实例，而不是数字ID：

<%= link_to '广告详情', magazine_ad_path(@magazine, @ad) %>

您还可以使用url_for与一组对象，Rails会自动确定您想要的路由：

<%= link_to '广告详情', url_for([@magazine, @ad]) %>

在这种情况下，Rails会看到@magazine是Magazine，@ad是Ad，因此会使用magazine_ad_path助手。在link_to等助手中，您可以只指定对象，而不是完整的url_for调用：

<%= link_to '广告详情', [@magazine, @ad] %>

如果您只想链接到杂志：

<%= link_to '杂志详情', @magazine %>

对于其他操作，您只需要将动作名称插入数组的第一个元素：

<%= link_to '编辑广告', [:edit, @magazine, @ad] %>

这使您可以将模型的实例视为URL，并且是使用资源风格的关键优势。

2.10 添加更多的RESTful操作

您不仅限于RESTful路由默认创建的七个路由。如果需要，您可以添加适用于集合或集合中的单个成员的其他路由。

2.10.1 添加成员路由

要添加成员路由，只需在资源块中添加一个member块：

resources :photos do
  member do
    get 'preview'
  end
end

这将识别/photos/1/preview的GET请求，并路由到PhotosController的preview动作，其中资源ID值传递给params[:id]。它还将创建preview_photo_url和preview_photo_path助手。

在成员路由的块中，每个路由名称指定将被识别的HTTP动词。您可以在这里使用get、patch、put、post或delete。如果没有多个member路由，您还可以将：on传递给路由，消除块：

resources :photos do
  get 'preview', on: :member
end

您可以省略：on选项，这将创建相同的成员路由，只是资源ID值将在params[:photo_id]而不是params[:id]中可用。路由助手也将从preview_photo_url和preview_photo_path重命名为photo_preview_url和photo_preview_path。

2.10.2 添加集合路由

要添加集合路由，使用collection块：

resources :photos do
  collection do
    get 'search'
  end
end

这将使Rails能够识别诸如/photos/search的GET请求，并路由到PhotosController的search动作。它还将创建search_photos_url和search_photos_path路由助手。

与成员路由一样，您可以将：on传递给路由：

resources :photos do
  get 'search', on: :collection
end

注意：如果您使用符号作为第一个位置参数来定义其他资源路由，请注意它与使用字符串不等效。符号推断控制器动作，而字符串推断路径。

2.10.3 添加其他新操作的路由

要使用：on快捷方式添加替代的新操作：

resources :comments do
  get 'preview', on: :new
end

这将使Rails能够识别诸如/comments/new/preview的GET请求，并路由到CommentsController的preview动作。它还将创建preview_new_comment_url和preview_new_comment_path路由助手。

提示：如果您发现自己向资源路由添加了许多额外的操作，那么是时候停下来问问自己是否正在掩盖另一个资源的存在了。

3 非资源路由

除了资源路由之外，Rails还对将任意URL路由到操作提供了强大的支持。在这里，您不会得到由资源路由自动生成的路由组。相反，您在应用程序中单独设置每个路由。

虽然通常应该使用资源路由，但仍然有许多地方适合使用更简单的路由。如果将应用程序的每个部分都强行塞入资源路由中，那是没有必要的。 特别是简单路由使得将旧的URL映射到新的Rails操作非常容易。

3.1 绑定参数

当设置一个常规路由时，你提供一系列符号，Rails将这些符号映射到传入的HTTP请求的各个部分。例如，考虑以下路由：

get 'photos(/:id)', to: 'photos#display'

如果一个传入请求/photos/1被该路由处理（因为它没有匹配到文件中的任何先前路由），那么结果将是调用PhotosController的display操作，并将最终参数"1"作为params[:id]可用。这个路由还将将传入请求/photos路由到PhotosController#display，因为:id是一个可选参数，用括号表示。

3.2 动态片段

你可以在常规路由中设置任意多个动态片段。任何片段都将作为params的一部分可用于操作。如果你设置了这个路由：

get 'photos/:id/:user_id', to: 'photos#show'

传入路径/photos/1/2将被分派到PhotosController的show操作。params[:id]将是"1"，params[:user_id]将是"2"。

提示：默认情况下，动态片段不接受点号 - 这是因为点号用作格式化路由的分隔符。如果你需要在动态片段中使用点号，请添加一个覆盖此行为的约束 - 例如，id: /[^\/]+/允许除斜杠之外的任何字符。

3.3 静态片段

在创建路由时，你可以通过不在片段前面添加冒号来指定静态片段：

get 'photos/:id/with_user/:user_id', to: 'photos#show'

这个路由将响应路径/photos/1/with_user/2。在这种情况下，params将是{ controller: 'photos', action: 'show', id: '1', user_id: '2' }。

3.4 查询字符串

params还将包括查询字符串中的任何参数。例如，使用这个路由：

get 'photos/:id', to: 'photos#show'

传入路径/photos/1?user_id=2将被分派到Photos控制器的show操作。params将是{ controller: 'photos', action: 'show', id: '1', user_id: '2' }。

3.5 定义默认值

你可以通过为:defaults选项提供一个哈希来在路由中定义默认值。这甚至适用于你没有指定为动态片段的参数。例如：

get 'photos/:id', to: 'photos#show', defaults: { format: 'jpg' }

Rails将匹配photos/12到PhotosController的show操作，并将params[:format]设置为"jpg"。

你还可以使用defaults块来为多个项定义默认值：

defaults format: :json do
  resources :photos
end

注意：你不能通过查询参数覆盖默认值 - 这是出于安全原因。唯一可以被覆盖的默认值是URL路径中的动态片段。

3.6 命名路由

你可以使用:as选项为任何路由指定一个名称：

get 'exit', to: 'sessions#destroy', as: :logout

这将在你的应用程序中创建logout_path和logout_url作为命名路由助手。调用logout_path将返回/exit。

你还可以使用这个方法来覆盖资源定义的路由方法，将自定义路由放在资源定义之前，像这样：

get ':username', to: 'users#show', as: :user
resources :users

这将定义一个user_path方法，它将在控制器、助手和视图中可用，它将转到一个如/bob的路由。在UsersController的show操作中，params[:username]将包含用户的用户名。如果你不想将参数名设置为:username，可以在路由定义中更改:username。

3.7 HTTP动词约束

通常，你应该使用get、post、put、patch和delete方法来限制路由到特定的动词。你可以使用match方法和:via选项一次匹配多个动词：

match 'photos', to: 'photos#show', via: [:get, :post]

你可以使用via: :all将所有动词匹配到特定的路由：

match 'photos', to: 'photos#show', via: :all

注意：将GET和POST请求都路由到单个操作具有安全性问题。通常情况下，除非有充分的理由，否则应避免将所有动词路由到一个操作。

注意：Rails中的GET不会检查CSRF令牌。你不应该从GET请求中写入数据库，有关更多信息，请参阅CSRF对策的安全指南。

3.8 分段约束

您可以使用:constraints选项来强制动态段的格式：

get 'photos/:id', to: 'photos#show', constraints: { id: /[A-Z]\d{5}/ }

这个路由将匹配路径如/photos/A12345，但不匹配/photos/893。您可以使用更简洁的方式表达相同的路由：

get 'photos/:id', to: 'photos#show', id: /[A-Z]\d{5}/

:constraints接受正则表达式，但不能使用正则表达式锚点。例如，以下路由将无效：

get '/:id', to: 'articles#show', constraints: { id: /^\d/ }

但是请注意，您不需要使用锚点，因为所有路由都在开头和结尾处锚定。

例如，以下路由将允许具有以数字开头的to_param值（如1-hello-world）的articles和以字母开头且不以数字开头的to_param值（如david）共享根命名空间：

get '/:id', to: 'articles#show', constraints: { id: /\d.+/ }
get '/:username', to: 'users#show'

3.9 基于请求的约束

您还可以根据返回String的Request对象上的任何方法来约束路由。

您可以像指定段约束一样指定基于请求的约束：

get 'photos', to: 'photos#index', constraints: { subdomain: 'admin' }

您还可以使用constraints块来指定约束：

namespace :admin do
  constraints subdomain: 'admin' do
    resources :photos
  end
end

注意：请求约束通过调用与哈希键同名的Request对象上的方法，并将返回值与哈希值进行比较来工作。因此，约束值应与相应的Request对象方法返回类型匹配。例如：constraints: { subdomain: 'api' }将与预期的api子域匹配。但是，使用符号constraints: { subdomain: :api }将不会匹配，因为request.subdomain返回的是字符串'api'。

注意：对于format约束有一个例外：虽然它是Request对象上的一个方法，但它也是每个路径上的隐式可选参数。段约束优先，并且只有在通过哈希强制执行时，format约束才会被应用。例如，get 'foo', constraints: { format: 'json' }将匹配GET /foo，因为默认情况下格式是可选的。但是，您可以使用lambda，如get 'foo', constraints: lambda { |req| req.format == :json }，这样路由将只匹配显式的JSON请求。

3.10 高级约束

如果您有更复杂的约束，可以提供一个响应matches?的对象，Rails将使用该对象。假设您想将受限制列表中的所有用户路由到RestrictedListController，您可以这样做：

class RestrictedListConstraint
  def initialize
    @ips = RestrictedList.retrieve_ips
  end

  def matches?(request)
    @ips.include?(request.remote_ip)
  end
end

Rails.application.routes.draw do
  get '*path', to: 'restricted_list#index',
    constraints: RestrictedListConstraint.new
end

您还可以将约束指定为lambda：

Rails.application.routes.draw do
  get '*path', to: 'restricted_list#index',
    constraints: lambda { |request| RestrictedList.retrieve_ips.include?(request.remote_ip) }
end

matches?方法和lambda都将request对象作为参数。

3.10.1 块形式的约束

您可以以块形式指定约束。这在需要将相同规则应用于多个路由时非常有用。例如：

class RestrictedListConstraint
  # ...与上面的示例相同
end

Rails.application.routes.draw do
  constraints(RestrictedListConstraint.new) do
    get '*path', to: 'restricted_list#index'
    get '*other-path', to: 'other_restricted_list#index'
  end
end

您也可以使用lambda：

Rails.application.routes.draw do
  constraints(lambda { |request| RestrictedList.retrieve_ips.include?(request.remote_ip) }) do
    get '*path', to: 'restricted_list#index'
    get '*other-path', to: 'other_restricted_list#index'
  end
end

3.11 路由全局匹配和通配符段

路由全局匹配是一种指定特定参数应与路由的所有剩余部分匹配的方法。例如：

get 'photos/*other', to: 'photos#unknown'

这个路由将匹配photos/12或/photos/long/path/to/12，将params[:other]设置为"12"或"long/path/to/12"。以星号为前缀的段被称为“通配符段”。

通配符段可以出现在路由的任何位置。例如：

get 'books/*section/:title', to: 'books#show'

将匹配books/some/section/last-words-a-memoir，params[:section]等于'some/section'，params[:title]等于'last-words-a-memoir'。

从技术上讲，一个路由甚至可以有多个通配符段。匹配器以直观的方式将段分配给参数。例如：

get '*a/foo/*b', to: 'test#index'

将匹配zoo/woo/foo/bar/baz，params[:a]等于'zoo/woo'，params[:b]等于'bar/baz'。 注意：通过请求'/foo/bar.json'，你的params[:pages]将等于'foo/bar'，请求格式为JSON。如果你想要恢复旧的3.0.x行为，你可以像这样提供format: false：

get '*pages', to: 'pages#show', format: false

注意：如果你想要使格式段成为必需的，不能省略，你可以像这样提供format: true：

get '*pages', to: 'pages#show', format: true

3.12 重定向

你可以使用路由器中的redirect助手将任何路径重定向到另一个路径：

get '/stories', to: redirect('/articles')

你还可以在重定向的路径中重用匹配的动态段：

get '/stories/:name', to: redirect('/articles/%{name}')

你还可以为redirect提供一个块，该块接收符号化的路径参数和请求对象：

get '/stories/:name', to: redirect { |path_params, req| "/articles/#{path_params[:name].pluralize}" }
get '/stories', to: redirect { |path_params, req| "/articles/#{req.subdomain}" }

请注意，默认的重定向是301“永久移动”重定向。请记住，某些Web浏览器或代理服务器会缓存这种类型的重定向，使旧页面无法访问。你可以使用:status选项来更改响应状态：

get '/stories/:name', to: redirect('/articles/%{name}', status: 302)

在所有这些情况下，如果你不提供前导主机（http://www.example.com），Rails将从当前请求中获取这些详细信息。

3.13 路由到Rack应用程序

在匹配器中，你可以指定任何Rack应用程序作为端点，而不是像'articles#index'这样的字符串，它对应于ArticlesController中的index操作：

match '/application.js', to: MyRackApp, via: :all

只要MyRackApp响应call并返回[status, headers, body]，路由器就无法区分Rack应用程序和操作之间的区别。这是使用via: :all的适当用法，因为你希望允许Rack应用程序根据需要处理所有动词。

注意：对于好奇的人来说，'articles#index'实际上扩展为ArticlesController.action(:index)，它返回一个有效的Rack应用程序。

注意：由于procs/lambdas是响应call的对象，你可以内联实现非常简单的路由（例如用于健康检查）：
get '/health', to: ->(env) { [204, {}, ['']] }

如果你将Rack应用程序指定为匹配器的端点，请记住接收应用程序中的路由将保持不变。对于以下路由，你的Rack应用程序应该期望路由为/admin：

match '/admin', to: AdminApp, via: :all

如果你希望Rack应用程序在根路径接收请求，而不是其他路径，请使用mount：

mount AdminApp, at: '/admin'

3.14 使用root

你可以使用root方法指定Rails应该将'/'路由到哪里：

root to: 'pages#main'
root 'pages#main' # 上述的快捷方式

你应该将root路由放在文件的顶部，因为它是最常用的路由，应该首先匹配。

注意：root路由只将GET请求路由到操作。

你还可以在命名空间和作用域中使用root。例如：

namespace :admin do
  root to: "admin#index"
end

root to: "home#index"

3.15 Unicode字符路由

你可以直接指定Unicode字符路由。例如：

get 'こんにちは', to: 'welcome#index'

3.16 直接路由

你可以通过调用direct直接创建自定义URL助手。例如：

direct :homepage do
  "https://rubyonrails.org"
end

# >> homepage_url
# => "https://rubyonrails.org"

块的返回值必须是url_for方法的有效参数。因此，你可以传递有效的字符串URL、哈希、数组、Active Model实例或Active Model类。

direct :commentable do |model|
  [ model, anchor: model.dom_id ]
end

direct :main do
  { controller: 'pages', action: 'index', subdomain: 'www' }
end

3.17 使用resolve

resolve方法允许自定义模型的多态映射。例如：

resource :basket

resolve("Basket") { [:basket] }

<%= form_with model: @basket do |form| %>
  <!-- basket form -->
<% end %>

这将生成单数URL/basket，而不是通常的/baskets/:id。

4 自定义资源路由

虽然resources生成的默认路由和助手通常可以满足你的需求，但你可能想以某种方式自定义它们。Rails允许你自定义资源助手的几乎所有通用部分。

4.1 指定要使用的控制器

:controller 选项允许您明确指定要用于资源的控制器。例如：

resources :photos, controller: 'images'

将识别以 /photos 开头的路径，但路由到 Images 控制器：

注意：使用 photos_path、new_photo_path 等来生成此资源的路径。

对于命名空间控制器，您可以使用目录表示法。例如：

resources :user_permissions, controller: 'admin/user_permissions'

这将路由到 Admin::UserPermissions 控制器。

注意：仅支持目录表示法。使用 Ruby 常量表示法（例如 controller: 'Admin::UserPermissions'）指定控制器可能会导致路由问题，并产生警告。

4.2 指定约束条件

您可以使用 :constraints 选项来指定对隐式 id 的所需格式。例如：

resources :photos, constraints: { id: /[A-Z][A-Z][0-9]+/ }

此声明将约束 :id 参数与提供的正则表达式匹配。因此，在这种情况下，路由器将不再将 /photos/1 匹配到此路由。而是 /photos/RR27 会匹配。

您可以使用块形式来指定应用于多个路由的单个约束条件：

constraints(id: /[A-Z][A-Z][0-9]+/) do
  resources :photos
  resources :accounts
end

注意：当然，您可以在此上下文中使用非资源路由中可用的更高级约束条件。

提示：默认情况下，:id 参数不接受点号 - 这是因为点号用作格式化路由的分隔符。如果您需要在 :id 中使用点号，请添加一个覆盖此行为的约束条件 - 例如 id: /[^\/]+/ 允许除斜杠以外的任何字符。

4.3 覆盖命名路由助手

:as 选项允许您覆盖命名路由助手的常规命名。例如：

resources :photos, as: 'images'

将识别以 /photos 开头的路径，并将请求路由到 PhotosController，但使用 :as 选项的值来命名助手。

4.4 覆盖 new 和 edit 段

:path_names 选项允许您覆盖路径中自动生成的 new 和 edit 段：

resources :photos, path_names: { new: 'make', edit: 'change' }

这将导致路由识别以下路径：

/photos/make
/photos/1/change

注意：此选项不会更改实际的动作名称。两个显示的路径仍将路由到 new 和 edit 动作。

提示：如果您希望统一更改所有路由的此选项，可以使用作用域，如下所示：

scope path_names: { new: 'make' } do
  # 其他路由
end

4.5 给命名路由助手添加前缀

您可以使用 :as 选项为 Rails 为路由生成的命名路由助手添加前缀。使用此选项可防止使用路径范围的路由之间发生名称冲突。例如：

scope 'admin' do
  resources :photos, as: 'admin_photos'
end

resources :photos

这将更改 /admin/photos 的路由助手，从 photos_path、new_photos_path 等变为 admin_photos_path、new_admin_photo_path 等。如果在作用域为 resources :photos 的情况下没有添加 as: 'admin_photos'，非作用域的 resources :photos 将没有任何路由助手。

要为一组路由助手添加前缀，请在 scope 中使用 :as：

scope 'admin', as: 'admin' do
  resources :photos, :accounts
end

resources :photos, :accounts

与之前一样，这将将 /admin 作用域的资源助手更改为 admin_photos_path 和 admin_accounts_path，并允许非作用域资源使用 photos_path 和 accounts_path。 注意：namespace作用域将自动添加：as以及：module和：path前缀。

4.5.1 参数作用域

您可以在路由前面加上一个命名参数：

scope ':account_id', as: 'account', constraints: { account_id: /\d+/ } do
  resources :articles
end

这将为您提供诸如/1/articles/9之类的路径，并允许您在控制器、助手和视图中将路径的account_id部分引用为params[:account_id]。

它还将生成以account_为前缀的路径和URL助手，您可以像预期的那样将对象传递给它们：

account_article_path(@account, @article) # => /1/article/9
url_for([@account, @article])            # => /1/article/9
form_with(model: [@account, @article])   # => <form action="/1/article/9" ...>

我们正在使用约束来限制作用域仅匹配类似ID的字符串。您可以更改约束以适应您的需求，或者完全省略它。：as选项也不是严格要求的，但是如果没有它，Rails在评估url_for([@account, @article])或依赖于url_for的其他助手（如form_with）时将引发错误。

4.6 限制创建的路由

默认情况下，Rails为应用程序中的每个RESTful路由创建七个默认操作（index、show、new、create、edit、update和destroy）的路由。您可以使用：only和：except选项来微调此行为。：only选项告诉Rails仅创建指定的路由：

resources :photos, only: [:index, :show]

现在，对/photos的GET请求将成功，但对/photos的POST请求（通常会路由到create操作）将失败。

：except选项指定Rails不应创建的路由或路由列表：

resources :photos, except: :destroy

在这种情况下，Rails将创建所有正常的路由，除了destroy的路由（对/photos/:id的DELETE请求）。

提示：如果您的应用程序有许多RESTful路由，使用：only和：except仅生成您实际需要的路由可以减少内存使用并加快路由过程。

4.7 翻译路径

使用scope，我们可以修改resources生成的路径名称：

scope(path_names: { new: 'neu', edit: 'bearbeiten' }) do
  resources :categories, path: 'kategorien'
end

Rails现在创建到CategoriesController的路由。

4.8 覆盖单数形式

如果要覆盖资源的单数形式，您应该通过inflections向变形器添加其他规则：

ActiveSupport::Inflector.inflections do |inflect|
  inflect.irregular 'tooth', 'teeth'
end

4.9 在嵌套资源中使用:as

：as选项会覆盖嵌套路由助手中自动生成的资源名称。例如：

resources :magazines do
  resources :ads, as: 'periodical_ads'
end

这将创建诸如magazine_periodical_ads_url和edit_magazine_periodical_ad_path之类的路由助手。

4.10 覆盖命名路由参数

：param选项会覆盖默认的资源标识符：id（用于生成路由的动态段的名称）。您可以在控制器中使用params[<:param>]访问该段。

resources :videos, param: :identifier

    videos GET  /videos(.:format)                  videos#index
           POST /videos(.:format)                  videos#create
 new_video GET  /videos/new(.:format)              videos#new
edit_video GET  /videos/:identifier/edit(.:format) videos#edit

Video.find_by(identifier: params[:identifier])

您可以覆盖关联模型的ActiveRecord::Base#to_param来构建URL：

class Video < ApplicationRecord
  def to_param
    identifier
  end
end

video = Video.find_by(identifier: "Roman-Holiday")
edit_video_path(video) # => "/videos/Roman-Holiday/edit"

5 将非常大的路由文件拆分为多个小文件

如果您在一个具有数千个路由的大型应用程序中工作，单个config/routes.rb文件可能会变得笨重且难以阅读。

Rails提供了一种使用draw宏将一个庞大的单个routes.rb文件拆分为多个小文件的方法。

您可以有一个包含所有管理员区域路由的admin.rb路由文件，另一个用于API相关资源的api.rb文件，等等。

# config/routes.rb

Rails.application.routes.draw do
  get 'foo', to: 'foo#bar'

  draw(:admin) # 将加载位于`config/routes/admin.rb`的另一个路由文件
end

# config/routes/admin.rb

namespace :admin do
  resources :comments
end

在Rails.application.routes.draw块内部调用draw(:admin)将尝试加载与给定参数相同名称的路由文件（在此示例中为admin.rb）。该文件需要位于config/routes目录或任何子目录中（例如config/routes/admin.rb或config/routes/external/admin.rb）。

您可以在admin.rb路由文件中使用常规的路由DSL，但不应该像在主config/routes.rb文件中那样将其包围在Rails.application.routes.draw块中。

5.1 除非确实需要，否则不要使用此功能

拥有多个路由文件会使发现和理解变得更加困难。对于大多数应用程序，即使是具有几百个路由的应用程序，开发人员使用单个路由文件更容易。Rails路由DSL已经提供了一种使用namespace和scope以有组织的方式拆分路由的方法。

6 检查和测试路由

Rails提供了用于检查和测试路由的工具。

6.1 列出现有路由

要获取应用程序中可用路由的完整列表，请在服务器以开发环境运行时在浏览器中访问http://localhost:3000/rails/info/routes。您还可以在终端中执行bin/rails routes命令以生成相同的输出。

这两种方法都会按照config/routes.rb中的顺序列出所有路由。对于每个路由，您将看到：

• 路由名称（如果有）
• 使用的HTTP动词（如果路由不响应所有动词）
• 要匹配的URL模式
• 路由的路由参数

例如，这是一个RESTful路由的bin/rails routes输出的一小部分：

    users GET    /users(.:format)          users#index
          POST   /users(.:format)          users#create
 new_user GET    /users/new(.:format)      users#new
edit_user GET    /users/:id/edit(.:format) users#edit

您还可以使用--expanded选项打开扩展表格格式模式。

$ bin/rails routes --expanded

--[ Route 1 ]----------------------------------------------------
Prefix            | users
Verb              | GET
URI               | /users(.:format)
Controller#Action | users#index
--[ Route 2 ]----------------------------------------------------
Prefix            |
Verb              | POST
URI               | /users(.:format)
Controller#Action | users#create
--[ Route 3 ]----------------------------------------------------
Prefix            | new_user
Verb              | GET
URI               | /users/new(.:format)
Controller#Action | users#new
--[ Route 4 ]----------------------------------------------------
Prefix            | edit_user
Verb              | GET
URI               | /users/:id/edit(.:format)
Controller#Action | users#edit

您可以使用grep选项搜索路由：-g。这将输出部分匹配URL辅助方法名称、HTTP动词或URL路径的任何路由。

$ bin/rails routes -g new_comment
$ bin/rails routes -g POST
$ bin/rails routes -g admin

如果只想看到映射到特定控制器的路由，可以使用-c选项。

$ bin/rails routes -c users
$ bin/rails routes -c admin/users
$ bin/rails routes -c Comments
$ bin/rails routes -c Articles::CommentsController

提示：如果将终端窗口扩大到输出行不换行，您会发现bin/rails routes的输出更易读。

6.2 测试路由

路由应该包含在您的测试策略中（就像应用程序的其余部分一样）。Rails提供了三个内置的断言，旨在使测试路由更简单：

• assert_generates
• assert_recognizes
• assert_routing

6.2.1 assert_generates断言

assert_generates断言特定的选项生成特定的路径，并且可以与默认路由或自定义路由一起使用。例如：

assert_generates '/photos/1', { controller: 'photos', action: 'show', id: '1' }
assert_generates '/about', controller: 'pages', action: 'about'

6.2.2 assert_recognizes断言

assert_recognizes是assert_generates的反向操作。它断言给定的路径被识别，并将其路由到应用程序中的特定位置。例如：

assert_recognizes({ controller: 'photos', action: 'show', id: '1' }, '/photos/1')

您可以提供:method参数来指定HTTP动词：

assert_recognizes({ controller: 'photos', action: 'create' }, { path: 'photos', method: :post })

6.2.3 assert_routing断言

assert_routing断言双向路由：它测试路径生成选项，并且选项生成路径。因此，它结合了assert_generates和assert_recognizes的功能：

assert_routing({ path: 'photos', method: :post }, { controller: 'photos', action: 'create' })

反馈

欢迎您帮助改进本指南的质量。

如果您发现任何拼写错误或事实错误，请贡献您的意见。 要开始，请阅读我们的 文档贡献 部分。

您还可能会发现不完整的内容或过时的内容。 请为主要内容添加任何缺失的文档。请先检查 Edge 指南，以验证问题是否已经修复或尚未修复。 请参阅 Ruby on Rails 指南准则 以了解样式和规范。

如果您发现需要修复但无法自行修复的问题，请 提交问题。

最后但同样重要的是，欢迎您在 官方 Ruby on Rails 论坛 上讨论有关 Ruby on Rails 文档的任何问题。