在嵌套对象中使用自定义to_json方法

Question

我有一个使用Ruby标准库中的Set类的数据结构.我希望能够将我的数据结构序列化为JSON字符串.

默认情况下,将序列化设置为数组:

>> s = Set.new [1,2,3]
>> s.to_json
=> "[1,2,3]"

在尝试反序列化之前哪个是好的.

所以我定义了一个自定义to_json方法:

class Set
  def to_json(*a)
    {
      "json_class" => self.class.name,
      "data" => {
        "elements" => self.to_a
      }
    }.to_json(*a)
  end

  def self.json_create(o)
    new o["data"]["elements"]
  end
end

哪个效果很好:

>> s = Set.new [1,2,3]
>> s.to_json
=> "{\"data\":{\"elements\":[1,2,3]},\"json_class\":\"Set\"}"

直到我把Set放入哈希或其他东西:

>> a = { 'set' => s }
>> a.to_json
=> "{\"set\":[1,2,3]}"

知道为什么to_json当Set嵌套在另一个对象中时我的自定义不被调用？

Answer 1

第一个块用于Rails 3.1(旧版本几乎相同); 第二个块用于标准的非Rails JSON.如果tl;博士,请跳到最后.

你的问题是Rails这样做:

[Object, Array, FalseClass, Float, Hash, Integer, NilClass, String, TrueClass].each do |klass|
  klass.class_eval <<-RUBY, __FILE__, __LINE__
    # Dumps object in JSON (JavaScript Object Notation). See www.json.org for more info.
    def to_json(options = nil)
      ActiveSupport::JSON.encode(self, options)
    end
  RUBY
end

在active_support/core_ext/object/to_json.rb.特别是,它将Hash的to_json方法改为只是一个ActiveSupport::JSON.encode调用.

然后,看着ActiveSupport::JSON::Encoding::Encoder,我们看到了这个:

def encode(value, use_options = true)
  check_for_circular_references(value) do
    jsonified = use_options ? value.as_json(options_for(value)) : value.as_json
    jsonified.encode_json(self)
  end   
end

因此所有Rails JSON编码都会通过as_json.但是,你没有as_json为Set 定义自己的to_json东西,当Rails忽略它不使用的东西时,你只是设置并感到困惑.

如果你自己设置Set#as_json:

class Set
    def as_json(options = { })
        {
            "json_class" => self.class.name,
            "data" => { "elements" => self.to_a }
        }
    end
end

然后你会得到你在Rails控制台和Rails中的所有内容:

> require 'set'
> s = Set.new([1,2,3])
> s.to_json
 => "{\"json_class\":\"Set\",\"data\":{\"elements\":[1,2,3]}}"
> h = { :set => s }
> h.to_json
 => "{\"set\":{\"json_class\":\"Set\",\"data\":{\"elements\":[1,2,3]}}}" 

请记住,as_json它用于为JSON序列化准备对象,然后to_json生成实际的JSON字符串.这些as_json方法通常返回简单的可序列化数据结构,例如Hash和Array,并且在JSON中具有直接类似物; 然后,一旦你有一些结构类似JSON的东西,to_json用于将它序列化为线性JSON字符串.

当我们查看标准的非Rails JSON库时,我们会看到如下内容:

def to_json(*a)
  as_json.to_json(*a)
end

猴子修补基本课程(符号,时间,日期,......).所以再一次,to_json通常是以实施的方式实施的as_json.在这种环境中,我们需要包括Set 的标准to_json以及以上内容as_json:

class Set
    def as_json(options = { })
        {
            "json_class" => self.class.name,
            "data" => { "elements" => self.to_a }
        }
    end
    def to_json(*a)
        as_json.to_json(*a)
    end
    def self.json_create(o)
        new o["data"]["elements"]
    end
end

我们json_create为解码器提供了类方法.一旦这一切都正确设置,我们得到这样的事情irb:

>> s = Set.new([1,2,3])
>> s.as_json
=> {"json_class"=>"Set", "data"=>{"elements"=>[1, 2, 3]}}
>> h = { :set => s }
>> h.to_json
=> "{"set":{"json_class":"Set","data":{"elements":[1,2,3]}}}"

执行摘要:如果你在Rails中,不要担心做任何事情to_json,as_json是你想要玩的.如果您不在Rails中,请实现大部分逻辑as_json(尽管文档中提到了)并添加标准to_json实现(def to_json(*a);as_json.to_json(*a);end).