модуль ActionDispatch::Routing::Mapper::Resources
Маршрутизация ресурсов позволяет быстро объявить все распространённые маршруты для контроллера, работающего с ресурсами. Вместо объявления отдельных маршрутов для действий index, show, new, edit, create, update и destroy маршрут ресурса объявляет их одной строкой кода:
resources :photos
Иногда у вас есть ресурс, который клиенты всегда запрашивают без указания идентификатора. Типичный пример: /profile всегда отображает профиль текущего вошедшего в систему пользователя. В этом случае можно использовать одиночный ресурс, чтобы сопоставить /profile (а не /profile/:id) с действием show.
resource :profile
Часто ресурсы логически являются дочерними по отношению к другим ресурсам:
resources :magazines do resources :ads end
Возможно, вы захотите организовать группы контроллеров в пространстве имён. Чаще всего несколько административных контроллеров группируют в пространстве имён admin. Эти контроллеры размещаются в каталоге app/controllers/admin, а затем их можно объединить в маршрутизаторе:
namespace "admin" do resources :posts, :comments end
По умолчанию параметр :id не принимает точки. Если вам нужно использовать точки в параметре :id, добавьте ограничение, переопределяющее это правило, например:
resources :articles, id: /[^\/]+/
Это позволяет использовать в :id любые символы, кроме косой черты.
Константы
- CANONICAL_ACTIONS
- RESOURCE_OPTIONS
- VALID_ON_OPTIONS
-
CANONICAL_ACTIONSсодержит все действия, которым не требуется добавлять префикс или путь, поскольку они подходят для своего уровня области видимости.
Открытые методы экземпляра
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1707
def collection(&block)
unless resource_scope?
raise ArgumentError, "can't use collection outside resource(s) scope"
end
with_scope_level(:collection) do
path_scope(parent_resource.collection_scope, &block)
end
end Чтобы добавить маршрут к коллекции:
resources :photos do
collection do
get 'search'
end
end
Это позволит Rails распознавать пути, например /photos/search, для GET-запросов и направлять их к действию search контроллера PhotosController. Также будут созданы вспомогательные методы маршрутизации search_photos_url и search_photos_path.
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1816
def draw(name)
path = @draw_paths.find do |_path|
File.exist? "#{_path}/#{name}.rb"
end
unless path
msg = "Your router tried to #draw the external file #{name}.rb,\n" \
"but the file was not found in:\n\n"
msg += @draw_paths.map { |_path| " * #{_path}" }.join("\n")
raise ArgumentError, msg
end
route_path = "#{path}/#{name}.rb"
instance_eval(File.read(route_path), route_path.to_s)
end Загружает другой файл маршрутов с указанным name из каталога config/routes. В этом файле можно использовать обычный DSL маршрутизации, но не заключайте его в блок Rails.application.routes.draw.
# config/routes.rb Rails.application.routes.draw do draw :admin # Loads `config/routes/admin.rb` draw "third_party/some_gem" # Loads `config/routes/third_party/some_gem.rb` end # config/routes/admin.rb namespace :admin do resources :accounts end # config/routes/third_party/some_gem.rb mount SomeGem::Engine, at: "/some_gem"
ВНИМАНИЕ: Используйте эту возможность с осторожностью. Несколько файлов маршрутов могут затруднить поиск и понимание кода. В большинстве приложений — даже с несколькими сотнями маршрутов — разработчикам проще работать с одним файлом маршрутов.
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1837
def match(*path_or_actions, as: DEFAULT, via: nil, to: nil, controller: nil, action: nil, on: nil, defaults: nil, constraints: nil, anchor: nil, format: nil, path: nil, internal: nil, **mapping, &block)
if path_or_actions.grep(Hash).any? && (deprecated_options = path_or_actions.extract_options!)
as = assign_deprecated_option(deprecated_options, :as, :match) if deprecated_options.key?(:as)
via ||= assign_deprecated_option(deprecated_options, :via, :match)
to ||= assign_deprecated_option(deprecated_options, :to, :match)
controller ||= assign_deprecated_option(deprecated_options, :controller, :match)
action ||= assign_deprecated_option(deprecated_options, :action, :match)
on ||= assign_deprecated_option(deprecated_options, :on, :match)
defaults ||= assign_deprecated_option(deprecated_options, :defaults, :match)
constraints ||= assign_deprecated_option(deprecated_options, :constraints, :match)
anchor = assign_deprecated_option(deprecated_options, :anchor, :match) if deprecated_options.key?(:anchor)
format = assign_deprecated_option(deprecated_options, :format, :match) if deprecated_options.key?(:format)
path ||= assign_deprecated_option(deprecated_options, :path, :match)
internal ||= assign_deprecated_option(deprecated_options, :internal, :match)
assign_deprecated_options(deprecated_options, mapping, :match)
end
raise ArgumentError, "Wrong number of arguments (expect 1, got #{path_or_actions.count})" if path_or_actions.count > 1
if path_or_actions.none? && mapping.any?
hash_path, hash_to = mapping.find { |key, _| key.is_a?(String) }
if hash_path.nil?
raise ArgumentError, "Route path not specified"
else
mapping.delete(hash_path)
end
if hash_path
path_or_actions.push hash_path
case hash_to
when Symbol
action ||= hash_to
when String
if hash_to.include?("#")
to ||= hash_to
else
controller ||= hash_to
end
else
to ||= hash_to
end
end
end
path_or_actions.each do |path_or_action|
if defaults
defaults(defaults) { map_match(path_or_action, as:, via:, to:, controller:, action:, on:, constraints:, anchor:, format:, path:, internal:, mapping:, &block) }
else
map_match(path_or_action, as:, via:, to:, controller:, action:, on:, constraints:, anchor:, format:, path:, internal:, mapping:, &block)
end
end
end Сопоставляет шаблон URL с одним или несколькими маршрутами. Дополнительную информацию см. в разделе match.
match 'path', to: 'controller#action', via: :post match 'otherpath', on: :member, via: :get
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1728
def member(&block)
unless resource_scope?
raise ArgumentError, "can't use member outside resource(s) scope"
end
with_scope_level(:member) do
if shallow?
shallow_scope {
path_scope(parent_resource.member_scope, &block)
}
else
path_scope(parent_resource.member_scope, &block)
end
end
end Чтобы добавить маршрут элемента, добавьте блок member в блок ресурса:
resources :photos do
member do
get 'preview'
end
end
Это позволит распознавать /photos/1/preview для GET-запросов и направлять их к действию preview контроллера PhotosController. Также будут созданы вспомогательные методы preview_photo_url и preview_photo_path.
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1775
def namespace(name, deprecated_options = nil, as: DEFAULT, path: DEFAULT, shallow_path: DEFAULT, shallow_prefix: DEFAULT, **options, &block)
if resource_scope?
nested { super }
else
super
end
end См. ActionDispatch::Routing::Mapper::Scoping#namespace.
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1754
def nested(&block)
unless resource_scope?
raise ArgumentError, "can't use nested outside resource(s) scope"
end
with_scope_level(:nested) do
if shallow? && shallow_nesting_depth >= 1
shallow_scope do
path_scope(parent_resource.nested_scope) do
scope(**nested_options, &block)
end
end
else
path_scope(parent_resource.nested_scope) do
scope(**nested_options, &block)
end
end
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1744
def new(&block)
unless resource_scope?
raise ArgumentError, "can't use new outside resource(s) scope"
end
with_scope_level(:new) do
path_scope(parent_resource.new_scope(action_path(:new)), &block)
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1490
def resource(*resources, concerns: nil, **options, &block)
if resources.grep(Hash).any? && (deprecated_options = resources.extract_options!)
concerns = assign_deprecated_option(deprecated_options, :concerns, :resource) if deprecated_options.key?(:concerns)
assign_deprecated_options(deprecated_options, options, :resource)
end
if apply_common_behavior_for(:resource, resources, concerns:, **options, &block)
return self
end
with_scope_level(:resource) do
options = apply_action_options :resource, options
resource_scope(SingletonResource.new(resources.pop, api_only?, @scope[:shallow], **options)) do
yield if block_given?
concerns(*concerns) if concerns
new do
get :new
end if parent_resource.actions.include?(:new)
set_member_mappings_for_resource
collection do
post :create
end if parent_resource.actions.include?(:create)
end
end
self
end Иногда у вас есть ресурс, который клиенты всегда запрашивают без указания идентификатора. Типичный пример: /profile всегда отображает профиль текущего вошедшего в систему пользователя. В этом случае можно использовать одиночный ресурс, чтобы сопоставить /profile (а не /profile/:id) с действием show:
resource :profile
Это создаёт шесть разных маршрутов в приложении, каждый из которых сопоставлен с контроллером Profiles (обратите внимание, что имя контроллера указано во множественном числе):
GET /profile/new GET /profile GET /profile/edit PATCH/PUT /profile DELETE /profile POST /profile
Если вы хотите, чтобы экземпляры модели работали с этим ресурсом посредством идентификации записи (например, в form_with или redirect_to), необходимо вызвать resolve:
resource :profile
resolve('Profile') { [:profile] }
# Enables this to work with singular routes:
form_with(model: @profile) {}
Параметры
Принимает те же параметры, что и resources
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1663
def resources(*resources, concerns: nil, **options, &block)
if resources.grep(Hash).any? && (deprecated_options = resources.extract_options!)
concerns = assign_deprecated_option(deprecated_options, :concerns, :resources) if deprecated_options.key?(:concerns)
assign_deprecated_options(deprecated_options, options, :resources)
end
if apply_common_behavior_for(:resources, resources, concerns:, **options, &block)
return self
end
with_scope_level(:resources) do
options = apply_action_options :resources, options
resource_scope(Resource.new(resources.pop, api_only?, @scope[:shallow], **options)) do
yield if block_given?
concerns(*concerns) if concerns
collection do
get :index if parent_resource.actions.include?(:index)
post :create if parent_resource.actions.include?(:create)
end
new do
get :new
end if parent_resource.actions.include?(:new)
set_member_mappings_for_resource
end
end
self
end В Rails маршрут ресурса задаёт соответствие между HTTP-методами, URL-адресами и действиями контроллера. По соглашению каждое действие также соответствует определённым операциям CRUD в базе данных. Одна запись в файле маршрутизации, например
resources :photos
создаёт семь разных маршрутов в приложении, каждый из которых сопоставлен с контроллером Photos:
GET /photos GET /photos/new POST /photos GET /photos/:id GET /photos/:id/edit PATCH/PUT /photos/:id DELETE /photos/:id
Resources также можно вкладывать на неограниченную глубину, используя такой синтаксис блока:
resources :photos do resources :comments end
Это создаёт следующие маршруты для комментариев:
GET /photos/:photo_id/comments GET /photos/:photo_id/comments/new POST /photos/:photo_id/comments GET /photos/:photo_id/comments/:id GET /photos/:photo_id/comments/:id/edit PATCH/PUT /photos/:photo_id/comments/:id DELETE /photos/:photo_id/comments/:id
Параметры
Принимает те же параметры, что и match, а также следующие:
- :path_names
-
Позволяет изменить сегмент пути для действий
editиnew. Действия, не указанные в параметрах, не изменяются.
resources :posts, path_names: { new: "brand_new" }
The above example will now change /posts/new to /posts/brand_new. - :path
-
Позволяет изменить префикс пути для ресурса.
resources :posts, path: 'postings' The resource and all segments will now route to /postings instead of /posts.
- :only
-
Создаёт маршруты только для указанных действий.
resources :cows, only: :show
resources :cows, only: [:show, :index]
- :except
-
Создаёт все маршруты, кроме маршрутов для указанных действий.
resources :cows, except: :show
resources :cows, except: [:show, :index]
- :shallow
-
Создаёт неглубокие маршруты для вложенных ресурсов. Если указать этот параметр для родительского ресурса, неглубокие маршруты будут созданы для всех вложенных ресурсов.
resources :posts, shallow: true do
resources :comments
end
Is the same as:
resources :posts do
resources :comments, except: [:show, :edit, :update, :destroy]
end
resources :comments, only: [:show, :edit, :update, :destroy]
This allows URLs for resources that otherwise would be deeply nested such
as a comment on a blog post like `/posts/a-long-permalink/comments/1234`
to be shortened to just `/comments/1234`.
Set `shallow: false` on a child resource to ignore a parent's shallow
parameter. - :shallow_path
-
Добавляет указанный путь в качестве префикса к неглубоким вложенным маршрутам.
scope shallow_path: "sekret" do
resources :posts do
resources :comments, shallow: true
end
end
The `comments` resource here will have the following routes generated for
it:
post_comments GET /posts/:post_id/comments(.:format)
post_comments POST /posts/:post_id/comments(.:format)
new_post_comment GET /posts/:post_id/comments/new(.:format)
edit_comment GET /sekret/comments/:id/edit(.:format)
comment GET /sekret/comments/:id(.:format)
comment PATCH/PUT /sekret/comments/:id(.:format)
comment DELETE /sekret/comments/:id(.:format) - :shallow_prefix
-
Добавляет указанный префикс к именам неглубоких вложенных маршрутов.
scope shallow_prefix: "sekret" do
resources :posts do
resources :comments, shallow: true
end
end
The `comments` resource here will have the following routes generated for
it:
post_comments GET /posts/:post_id/comments(.:format)
post_comments POST /posts/:post_id/comments(.:format)
new_post_comment GET /posts/:post_id/comments/new(.:format)
edit_sekret_comment GET /comments/:id/edit(.:format)
sekret_comment GET /comments/:id(.:format)
sekret_comment PATCH/PUT /comments/:id(.:format)
sekret_comment DELETE /comments/:id(.:format) - :format
-
Позволяет указать значение по умолчанию для необязательного сегмента
formatили отключить его, передавfalse. - :param
-
Позволяет переопределить имя параметра
:id, используемое по умолчанию в URL.
Примеры
# routes call Admin::PostsController resources :posts, module: "admin" # resource actions are at /admin/posts. resources :posts, path: "admin/posts"
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1457 def resources_path_names(options) @scope[:path_names].merge!(options) end
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1903
def root(path, options = {})
if path.is_a?(String)
options[:to] = path
elsif path.is_a?(Hash) && options.empty?
options = path
else
raise ArgumentError, "must be called with a path and/or options"
end
if @scope.resources?
with_scope_level(:root) do
path_scope(parent_resource.path) do
match_root_route(options)
end
end
else
match_root_route(options)
end
end С помощью метода root можно указать, на какой маршрут Rails должен перенаправлять путь «/»:
root to: 'pages#main'
Список параметров см. в разделе match, поскольку метод root использует его внутри себя.
Можно также передать строку, которая будет развёрнута
root 'pages#main'
Маршрут root следует поместить в начало config/routes.rb, чтобы он проверялся первым. Это полезно, поскольку в большинстве приложений Rails этот маршрут используется чаще всего.
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1783 def shallow @scope = @scope.new(shallow: true) yield ensure @scope = @scope.parent end
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1790 def shallow? !parent_resource.singleton? && @scope[:shallow] end
Закрытые методы экземпляра
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 2120 def api_only? # :doc: @set.api_only? end
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 2108
def set_member_mappings_for_resource # :doc:
member do
get :edit if parent_resource.actions.include?(:edit)
get :show if parent_resource.actions.include?(:show)
if parent_resource.actions.include?(:update)
patch :update
put :update
end
delete :destroy if parent_resource.actions.include?(:destroy)
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 2003 def with_scope_level(kind) # :doc: @scope = @scope.new_level(kind) yield ensure @scope = @scope.parent end
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.