如何为has_many创建对称，DRY，RESTful接口：通过关系？

Question

假设三个模型之间具有标准的has_many：through关系

class Person < ActiveRecord::Base
  has_many :memberships, :dependent => :destroy
  has_many :clubs, :through => :memberships
end
class Club < ActiveRecord::Base
  has_many :memberships, :dependent => :destroy
  has_many :persons, :through => :memberships
end
class Membership < ActiveRecord::Base
  belongs_to :person
  belongs_to :club
end

在API驱动的应用程序中，您可能希望公开以下URI：

• 列出x人所属的俱乐部
• 列出y俱乐部的成员
• （...以及通常的CRUD方法集合...）

我的第一个想法是实现一对映射到MembersController的嵌套路由，例如：

GET /clubs/:club_id/memberships     => members_controller#index
GET /persons/:person_id/memberships => members_controller#index

...但是这里有点奇怪。

两条路由都映射到相同的members_controller方法（索引）。 没问题-我可以在params哈希中查看是否给出了：club_id或：person_id，然后对members_controller表应用适当的作用域。

但是我不确定我们是否要向最终用户公开Member对象。 一对更直观的路线（至少从用户的角度来看）可能是：

GET /clubs/:club_id/persons   
GET /persons/:person_id/clubs 

...这将分别返回人员列表和俱乐部列表。

但是，如果以这种方式进行操作，这些路线将映射到哪个控制器和动作？ Rails中是否有提供指导的约定？ 还是这偏离了正常工作，我应该以我认为合适的任何方式实施它？

Answer 1

我最终实现了实现以下目标的路由和控制器：

• 它完全是RESTful的。
• 它是完全对称的：/ persons /：person_id / clubs /：club_id / memberships与/ clubs /：club_id / persons /：person_id / memberships相同
• 非常干。
• 普通用户永远不会看到Membership：id。 相反，：person_id和：club_id用作引用特定成员资格的复合键。
• 它确实允许通过：id直接访问Membership对象，但这是为管理员保留的。

以下是它可以识别的一些路线：

/persons/:person_id/clubs/:club_id/memberships - a specific membership association
/clubs/:club_id/persons/:person_id/memberships - equivalent
/persons/:person_id/clubs - all the clubs that a specific person belongs to
/clubs/:club_id/persons - all the persons that belong to a specific club
/memberships/:id - access to a specific membership (accessible only to admin)

请注意，在以下示例中，我没有包括用于身份验证和授权的Devise和CanCan构造。 它们很容易添加。

这是路由文件：

# file: /config/routes.rb
Clubbing::Application.routes.draw do

  resources :persons, :except => [:new, :edit] do
    resources :clubs, :only => :index
  end

  resources :clubs, :except => [:new, :edit] do
    resources :persons, :only => :index
  end

  resources :memberships, :except => [:new, :edit]

  # there may be clever ways to specify these routes using #resources and
  # #collections and #member, but this ultimately is more straightforward

  match "/persons/:person_id/clubs/:club_id/memberships" => "memberships#create", :via => :post
  match "/persons/:person_id/clubs/:club_id/memberships" => "memberships#show", :via => :get
  match "/persons/:person_id/clubs/:club_id/memberships" => "memberships#update", :via => :put
  match "/persons/:person_id/clubs/:club_id/memberships" => "memberships#destroy", :via => :delete

  match "/clubs/:club_id/persons/:person_id/memberships" => "memberships#create", :via => :post
  match "/clubs/:club_id/persons/:person_id/memberships" => "memberships#show", :via => :get
  match "/clubs/:club_id/persons/:person_id/memberships" => "memberships#update", :via => :put
  match "/clubs/:club_id/persons/:person_id/memberships" => "memberships#destroy", :via => :delete

控制器非常简单。 对于PersonsController和ClubsController来说，唯一的非标准内容是：index方法，在该方法中，我们在参数和范围内查找：club_id或：person_id的存在：

# file: /app/controllers/persons_controller.rb
class PersonsController < ApplicationController
  respond_to :json
  before_filter :locate_collection, :only => :index
  before_filter :locate_resource, :except => [:index, :create]

  def index
    respond_with @persons
  end

  def create
    @person = Person.create(params[:person])
    respond_with @person
  end

  def show
    respond_with @person
  end

  def update
    if @person.update_attributes(params[:person])
    end
    respond_with @person
  end

  def destroy
    @person.destroy
    respond_with @person
  end

  private

  def locate_collection
    if (params.has_key?("club_id"))
      @persons = Club.find(params[:club_id]).persons
    else
      @persons = Person.all
    end
  end

  def locate_resource
    @person = Person.find(params[:id])
  end

end

# file: /app/controllers/clubs_controller.rb
class ClubsController < ApplicationController
  respond_to :json
  before_filter :locate_collection, :only => :index
  before_filter :locate_resource, :except => [:index, :create]

  def index
    respond_with @clubs
  end

  def create
    @club = Club.create(params[:club])
    respond_with @club
  end

  def show
    respond_with @club
  end

  def update
    if @club.update_attributes(params[:club])
    end
    respond_with @club
  end

  def destroy
    @club.destroy
    respond_with @club
  end

  private

  def locate_collection
    if (params.has_key?("person_id"))
      @clubs = Person.find(params[:person_id]).clubs
    else
      @clubs = Club.all
    end
  end

  def locate_resource
    @club = Club.find(params[:id])
  end

end

MembershipsController只是稍微复杂一点：它在参数哈希中检测到：person_id和/或：club_id并相应地应用作用域。 如果：person_id和：club_id都存在，我们可以假定它引用了唯一的成员对象：

# file: /app/controllers/memberships_controller.rb
class MembershipsController < ApplicationController
  respond_to :json
  before_filter :scope_collection, :only => [:index]
  before_filter :scope_resource, :except => [:index, :create]

  def index
    respond_with @memberships
  end

  def create
    @membership = scope_collection.create(params[:membership])
    respond_with @membership
  end

  def show
    respond_with @membership
  end

  def update
    if @membership.update_attributes(params[:membership])
    end
    respond_with @membership
  end

  def destroy
    @membership.destroy
    respond_with @membership
  end

  private

  # apply :person_id and/or :club_id scoping if present in params hash

  def scope_collection
    @memberships = scope_by_parameters
  end

  def scope_resource
    @membership = scope_by_parameters.first
  end

  def scope_by_parameters
    scope_by_param_id(scope_by_param_id(Membership.scoped, :person_id), :club_id)
  end

  def scope_by_param_id(relation, scope_name)
    (id = params[scope_name]) ? relation.where(scope_name => id) : relation
  end

end

Answer 2

附录

（不是答案-只是观察）。 这个问题的大部分可以重新定义为“ REST如何处理复合键？”

当您具有单个ID来定位诸如/ customers / 2141之类的资源时，REST理念很明确。 还不清楚用复合键唯一地定义资源时该怎么做：在上面的示例中，/ clubs /：club_id和/ persons /：person_id形成了一个唯一标识成员身份的复合键。

我还没有阅读罗伊·菲尔丁对此事的想法 。 这就是下一步。

Answer 3

不用考虑在Rails中如何做到这一点，实现RESTful的关键是您可以拥有超链接。 从一个人的角度来看，会员列表是什么，但是他们所属的俱乐部的链接列表是什么？ （嗯，每个俱乐部都有一些额外的数据。）俱乐部会员资格列表是什么，而不是会员的链接列表（同样，可能还有一些额外的数据）？

鉴于此，从人的角度来看的成员资格实际上就是“成员资格”表的视图（类似地从俱乐部的角度来看； 在此抽象级别上没有区别）。 棘手的一点是，当您更改一个人的成员身份时，必须将更改通过视图推回到基础表中。 那仍然是RESTful的。 拥有RESTful资源并不意味着在未给出直接更改指示的情况下资源也不会更改。 （这将禁止各种有用的事情，例如共享资源！）确实，REST在这方面的真正含义是客户端不应假定它可以安全地缓存所有内容，除非托管服务明确表明可以这样做。 （通过适当的元数据/ HTTP标头）。