如何通过重写像 respond_with 这样的方法来干燥 Rails 3 控制器？

Question

我正在尝试为我的 Rails 3 应用程序创建 JSONP API。现在在我的控制器中，我有很多遵循此模式的操作：

# This is from my users_controller.rb, as an example

def index
  @users = User.all
  respond_with(@users, :callback => params[:callback])
end

虽然这按原样工作，但我想通过不必重复 :callback => 来干燥它。 params[:callback] 在每个操作的 respond_with 调用中。我该怎么做？

更新：我意识到上面的代码丑陋的一件事是 :callback => params[:callback] 选项将为任何响应格式传递，而不仅仅是 JSON。下面的代码可能更正确：

def index
  @users = User.all
  respond_with(@users) do |format|
    format.json { render :json => @users, :callback => params[:callback]}
  end
end

我考虑过几种方法来解决这个问题，但我不知道如何让它们工作：

• 覆盖render（也许在应用程序控制器中） ），以便它接受自动包含 :callback => 的 :jsonp 选项。 params[:callback] 参数。这样我可以将上面的代码更改为以下代码，该代码稍微短一些：

def index
  @users = User.all
  respond_with(@users) do |format|
    format.json { render :jsonp => @users}
  end
end

• 创建一个覆盖 to_json 的响应程序以解决我的问题。这样我就可以省略该块，只需调用 respond_with(@users, :responder => 'MyResponder') 来解决问题。或者，也许我可以使用 plataformatec 的响应程序 gem 将此代码包含在应用程序响应程序中，以便 respond_with(@用户） 本身就足够了。

Answer 1

请注意，从技术上讲，使用回调参数渲染 JSON 是不正确的，因为您得到的是 JavaScript 响应（对 JSON-P 回调的函数调用）而不是 JSON 结果。
因此，如果您收到

render :json => my_object, :callback => params[:callback]

/users?callback=func 的请求，Rails 会

func({…})

使用内容类型 application/json 进行响应，这是不正确的，因为上面的响应是显然不是 JSON，而是 JavaScript。

我使用的解决方案是

def respond_with_json(item)
  respond_with do |format|
    format.json { render :json => item }
    format.js   { render :json => item, :callback => params[:callback] }
  end
end

在有或没有回调的情况下都能正确响应。将其应用于上述解决方案，我们得到：

def custom_respond_with(*resources, &block)
  options = resources.extract_options!

  if params[:callback]
    old_block = block
    block = lambda do |format|
      old_block.call(format) if block_given?
      format.js { render :json => resources[0], :callback => params[:callback] }
    end
  end

  respond_with(*(resources << options), &block)
end

另请注意对 resources[0] 的更正，否则由于 splat，您最终会将 resources 包装在额外的数组中操作员。

Answer 2

有一个 gem 可以做到这一点：rack-jsonp-middleware。

网站上的设置说明非常少，但我确实创建了一个使用它的小 Rails 项目 - 您可以查看提交并了解我为启动和运行中间件所做的工作。

https://github.com/rwilcox/rack_jsonp_example

Answer 3

与响应器解决方案相比，这有点“低科技”，但是在您的 appliation_controller.rb 中创建一个私有方法来处理这个问题怎么样？ params 变量将可供它使用，并且您可以将 @users 对象传递给它。

#application_controller.rb
private
  def jsonp(my_object)
    render :json => my_object, :callback => params[:callback]
  end

#controller
def index
  @users = User.all
  respond_with(@users) do |format|
    format.json { jsonp(@users)}
  end
end

Answer 4

感谢 samuelkadolph 今天在 #rubyonrails IRC 频道中为我提供的帮助。他在 this gist 中提供了一个解决方案，为了方便起见，复制如下：

def custom_respond_with(*resources, &block)
  options = resources.extract_options!

  if options[:callback]
    old_block = block
    block = lambda do |format|
      old_block.call(format) if block_given?
      format.json { render :json => [] }
    end
  end

  respond_with(*(resources << options), &block)
end

我还没有在我的应用程序中尝试过这个，但我可以看到它应该有效。他还确认，我可以通过更改此方法的名称并将定义的最后一行更改为 super(*(resources << options) 来类似地覆盖 respond_with 方法本身，&块）。

我认为这对我有用。但是，我仍然有兴趣了解如何编写自定义响应程序来完成这项工作。 （恕我直言，这将是一个更优雅的解决方案。）

更新：我在我的应用程序中尝试了这个，它可以进行一些小的更改。这是我现在在 ApplicationController 的 private 部分中使用的版本，旨在自动提供 :callback => JSON 请求的 params[:callback] 选项：

def custom_respond_with(*resources, &block)
  options = resources.extract_options!

  if params[:callback]
    old_block = block
    block = lambda do |format|
      old_block.call(format) if block_given?
      format.json { render :json => resources, :callback => params[:callback] }
    end
  end

  respond_with(*(resources << options), &block)
end

请注意，我必须将 if options[:callback] 更改为 if params[:callback] 才能让它发挥作用。

Answer 5

您还可以查看此答案。基本上，您可以为控制器创建一个“默认”respond_to，这样您就可以将所有操作默认为响应 json。

这就是你问的吗？