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

Question

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

默认情况下，Set 序列化为数组:

>> 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\"}"

直到我将集合放入哈希或其他东西中:

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

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

Answer 1

第一个 block 用于 Rails 3.1(旧版本几乎相同)；第二个 block 用于标准的非 Rails JSON。如果 tl;dr. 跳到最后

---

您的问题是 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。但是，您并没有为 Set 定义自己的 as_json，您只是在设置 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来实现的。在这个环境中，我们需要包括标准的 to_json 以及上面的 as_json for Set:

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) 也是。