rails3中如何自定义to_json方法？

Question

我想将 Place 对象数组转换为 json，我一直在这样做：

var places = <%= @places.to_json.html_safe %>;

唯一的问题是@places 数组中的每个地方都有一个关联的标签列表，它没有被包含在内。我正在使用acts_as_taggable_on gem 来处理标签，所以要获取一个地方的标签列表，我需要说place.tag_list。

我必须做些什么才能让 javascript 数组中的每个位置都包含 tag_list？我想我需要编写自己的 to_json 方法，但我不知道如何。

编辑

事实证明，这比我意识到的要容易。我可以这么说：

var places = <%= @places.to_json(:include => :tags).html_safe %>

唯一的问题是它包含的每个标签的信息比我真正需要的要多。每个标签都有一个 id 和 name，我真正想要的只是一个包含标签名称的列表。

Answer 1

如果您正在处理更复杂的 JSON，我建议您查看这篇文章。

How to override to_json in Rails?

也请参阅这两个帖子：

http://www.tonyamoyal.com/2011/03/25/recursive-custom-to_json-in-ruby-for-arrays-of-objects-or-nested-objects/

http://jonathanjulian.com/2010/04/rails-to_json-or-as_json/

Answer 2

如果您打电话，Benson 的回答将不起作用

render :json => @places

在 PlacesController 中。您需要在 Place 模型中添加以下代码。

# this method is called on a single instance
def to_json(options={})
  options[:methods] ||= []
  options[:methods] << :tag_names
  super(options)
end

# this method is called for each instance in an Array to avoid circular references.
def as_json(options={})
  options[:methods] ||= []
  options[:methods] << :tag_names
  super(options)
end

希望对其他人有所帮助。我不得不查看源代码来弄清楚为什么Array.to_json与Array.each { |a| a.to_json }不一样

Answer 3

to_json 方法还接受一个名为 methods 的参数。此参数允许您指定应调用并包含在对象的 json 表示中的方法。既然你提到你有一个名为tag_list 的方法，你可以这样做：

var places = <%= @places.to_json(:methods => :tag_list).html_safe %>

如果由于某种原因，您没有生成标签名称的方法，但每个标签都有一个方法来给您命名，您可以在 Place 模型中添加一个方法来生成标签列表像这样的名字：

def tag_names
    tags.collect do |tag|
        tag.name
    end
end

然后您可以像这样使用tag_names 获取您的位置 json：

place_json = @places.to_json(:methods => :tag_names)

此技术适用于您想添加到模型的 json 表示中的任何计算属性。

Answer 4

在您的 Place 类中，您可以覆盖 to_json。在 Rails 3 中，您应该改写 as_json：

def as_json (options={})
  # add whatever fields you need here
end

然后将代码更改为：

var places = <%= @places.as_json.html_safe %>;