as_json 没有在关联上调用 as_json

Question

我有一个模型，其数据在呈现为 json 时不应包含在内。所以我实现了类的 as_json 方法以使其行为适当。问题是当与此模型关联的其他模型渲染 json 时，我的自定义 as_json 没有被调用。

class Owner < ActiveRecord::Base
  has_one :dog

  def as_json(options={})
    puts "Owner::as_json"
    super(options)
  end  
end

class Dog < ActiveRecord::Base
  belongs_to :owner

  def as_json(options={})
    puts "Dog::as_json"
    options[:except] = :secret
    super(options)
  end  
end

加载开发环境（Rails 3.0.3）
ruby-1.9.2-p136 :001 > d = Dog.first
=> #<Dog id: 1, owner_id: 1, name: "Scooby", secret: "I enjoy crapping everwhere">
ruby-1.9.2-p136:002 > d.as_json
狗::as_json
=> {"dog"=>{"id"=>1, "name"=>"Scooby", "owner_id"=>1}}
ruby-1.9.2-p136 :004 > d.owner.as_json(:include => :dog)
所有者::as_json
=> {"owner"=>{"id"=>1, "name"=>"Shaggy", :dog=>{"id"=>1, "name"=>"Scooby", "owner_id"= >1, "secret"=>"我喜欢到处拉屎"}}}

感谢您的帮助

Answer 1

这被报告为一个错误：http://ternarylabs.com/2010/09/07/migrating-to-rails-3-0-gotchas-as_json-bug/

Answer 2

我遇到了同样的问题。我想让这个工作：

render :json => @favorites.as_json(:include => :location)

但事实并非如此，所以我最终添加了一个带有以下内容的 index.json.erb：

<% favs = @favorites.as_json.each do |fav| %>
    <% fav["location"] = Location.find(fav["location_id"]).as_json %>
<% end %>
<%= favs.to_json.html_safe %>

不是修复 - 只是一种解决方法。我想你也做了同样的事情。

Answer 3

这是 Rails 中的known bug。 （由于从以前的错误跟踪器迁移到 Github 问题，该问题被标记为已关闭，但在 Rails 3.1 中仍然存在问题。）

Answer 4

更新 @John 指出这是 Rails 中的一个已知错误。修复它的补丁似乎是：https://github.com/rails/rails/pull/2200。不过，你可以试试 RABL，因为它很甜。

我一直对传递一组复杂的选项感到沮丧来创建我想要的 JSON 视图。我在 Rails 3.0.9 中使用 Mongoid 遇到的问题促使我编写 JSON 模板。但实际上，如果您正在处理关系或自定义 api 属性，那么 模板会更好。

此外，处理不同的输出在我看来就像是 View 层，所以 我决定使用 API 模板语言 RABL。 它使构建有效 JSON 并包含任何关联或字段。

不是问题的解决方案，而是用例的更好解决方案。

Answer 5

如上所述，这是 Rails 基础的问题。 rails 补丁here 还没有应用，至少看起来有点争议，所以我很犹豫是否在本地应用它。即使作为猴子补丁应用，它也可能使未来的 Rails 升级复杂化。

我还在考虑上面建议的RABL，它看起来很有用。目前，我不想在我的应用程序中添加另一种视图模板语言。我目前的需求很小。

所以这里有一个解决方法，它不需要补丁并且适用于大多数简单的情况。这适用于您希望调用的关联 as_json 方法看起来像

def as_json(options={})
  super( <... custom options ...> )
end

就我而言，我有 Schedule 模型，其中有很多 Events

class Event < ActiveRecord::Base

  # define json options as constant, or you could return them from a method
  EVENT_JSON_OPTS = { :include => { :locations => { :only => [:id], :methods => [:name] } } }

  def as_json(options={})
    super(EVENT_JSON_OPTS)
  end
end

class Schedule < ActiveRecord::Base
  has_many :events

  def as_json(options={})
    super(:include => { :events => { Event::EVENT_JSON_OPTS } })
  end
end

如果您遵循以下准则，即无论何时在您的 as_json() 方法中 :include 关联，您将需要的任何选项定义为要引用的模型中的常量，这将适用于任意级别的关联。 注意我只需要上面示例中自定义的第一级关联。

Answer 6

我发现 serializable_hash 的工作方式与您期望的 as_json 一样，并且总是被调用：

  def serializable_hash(options = {})
    result = super(options)
    result[:url] = "http://.."
    result
  end