如何在 Rails 中重写 to_json？

Question

---

更新：

这个问题没有得到适当的探讨。真正的问题在于render :json。

原始问题中粘贴的第一个代码将产生预期的结果。然而，仍然有一个警告。请参阅此示例：

render :json => current_user

不同不

与render :json => current_user.to_json

也就是说，render :json 不会自动调用与 User 对象关联的 to_json 方法。 事实上，如果to_json在User模型上被覆盖，render :json =>; @user 将生成如下所述的 ArgumentError。

摘要

# works if User#to_json is not overridden
render :json => current_user

# If User#to_json is overridden, User requires explicit call
render :json => current_user.to_json

这对我来说似乎很愚蠢。这似乎告诉我，当指定类型 :json 时，render 实际上并未调用 Model#to_json 。有人能解释一下这里到底发生了什么吗？

任何可以帮助我解决这个问题的天才都可能回答我的其他问题： 如何通过在 Rails 中组合 @foo.to_json(options) 和 @bars.to_json(options) 来构建 JSON 响应

---

原始问题：

我见过一些关于SO的其他例子，但我没有做我正在寻找的事情。

我正在尝试：

class User < ActiveRecord::Base

  # this actually works! (see update summary above)
  def to_json
    super(:only => :username, :methods => [:foo, :bar])
  end

end

我在

/usr/lib/ruby/gems/1.9.1/gems/activesupport-2.3.5/lib/active_support/json/encoders/object.rb:4:in `to_json

“任何想法？”中收到 ArgumentError: 错误数量的参数（1 代表 0）

Answer 1

您将收到 ArgumentError：参数数量错误 (1 for 0)，因为 to_json 需要用一个参数（即 options 哈希）覆盖。

def to_json(options)
  ...
end

---

对 to_json、as_json 和渲染的详细说明：

在 ActiveSupport 2.3.3 中，添加了 as_json 来解决问题就像你遇到的那个人一样。 json 的创建应该与json的渲染分开。

现在，每当对对象调用 to_json 时，都会调用 as_json 来创建数据结构，然后使用 ActiveSupport: 将该哈希编码为 JSON 字符串： json.encode。所有类型都会发生这种情况：对象、数字、日期、字符串等（请参阅 ActiveSupport 代码）。

ActiveRecord 对象的行为方式相同。有一个默认的 as_json 实现，它创建一个包含所有模型属性的哈希。 您应该覆盖模型中的 as_json 以创建所需的 JSON 结构。 as_json 与旧的 to_json 一样，采用选项哈希，您可以在其中指定要以声明方式包含的属性和方法。

def as_json(options)
  # this example ignores the user's options
  super(:only => [:email, :handle])
end

在你的控制器中，render :json =>; o 可以接受字符串或对象。 如果它是一个字符串，它会作为响应正文传递，如果它是一个对象，则调用 to_json ，这会触发 as_json ，如上所述。

因此，只要您的模型正确地用 as_json 覆盖（或不覆盖）表示，显示一个模型的控制器代码应该如下所示：

format.json { render :json => @user }

这个故事的寓意是：避免调用 <直接使用 code>to_json ，允许 render 为您执行此操作。如果您需要调整 JSON 输出，请调用 as_json。

format.json { render :json => 
    @user.as_json(:only => [:username], :methods => [:avatar]) }

Answer 2

如果您在 Rails 3 中遇到此问题，请覆盖 serialized_hash 而不是 as_json。这也将免费获得您的 XML 格式:)

Answer 3

对于那些不想忽略用户选项但又添加他们的选项的人：

def as_json(options)
  # this example DOES NOT ignore the user's options
  super({:only => [:email, :handle]}.merge(options))
end

希望这对任何人都有帮助:)

Answer 4

不是覆盖 to_json，而是覆盖 as_json。
并从 as_json 调用你想要的：

试试这个：

def as_json 
 { :username => username, :foo => foo, :bar => bar }
end