Ruby 对象和 JSON 序列化（无 Rails）

Question

我正在尝试了解 Ruby 中的 JSON 序列化环境。我是红宝石新手。

如果您不使用 Rails，是否有任何好的 JSON 序列化选项？

这似乎就是这个答案的去处（Rails） 如何将 Ruby 对象转换为 JSON

json gem 似乎为了让它看起来像你必须编写自己的 to_json 方法。 我无法让 to_json 处理数组和哈希（文档说它可以处理这些） json gem 不只反映对象并使用默认序列化策略是否有原因？这不是 to_yaml 的工作原理吗（这里猜测）

Answer 1

为了使 JSON 库可用，您可能必须从包管理器安装 libjson-ruby。

使用 'json' 库：

require 'json'

将对象转换为 JSON（这 3 种方法是等效的）：

JSON.dump object #returns a JSON string
JSON.generate object #returns a JSON string
object.to_json #returns a JSON string

将 JSON 文本转换为对象（这 2 种方法是等效的）：

JSON.load string #returns an object
JSON.parse string #returns an object

对于您自己的类中的对象来说，这会有点困难。对于以下类，to_json 将生成类似 "\"#\"" 的内容。

class A
    def initialize a=[1,2,3], b='hello'
        @a = a
        @b = b
    end
end

这可能是不可取的。为了有效地将对象序列化为 JSON，您应该创建自己的 to_json 方法。为此， from_json 类方法会很有用。您可以像这样扩展您的类：

class A
    def to_json
        {'a' => @a, 'b' => @b}.to_json
    end
    def self.from_json string
        data = JSON.load string
        self.new data['a'], data['b']
    end
end

您可以通过继承“JSONable”类来自动执行此操作：

class JSONable
    def to_json
        hash = {}
        self.instance_variables.each do |var|
            hash[var] = self.instance_variable_get var
        end
        hash.to_json
    end
    def from_json! string
        JSON.load(string).each do |var, val|
            self.instance_variable_set var, val
        end
    end
end

然后您可以使用 object.to_json 序列化为 JSON 和 object.from_json！ string 将保存为 JSON 字符串的保存状态复制到对象中。

Answer 2

查看 Oj。将任何旧对象转换为 JSON 时会遇到一些问题，但 Oj 可以做到。

require 'oj'

class A
    def initialize a=[1,2,3], b='hello'
        @a = a
        @b = b
    end
end

a = A.new
puts Oj::dump a, :indent => 2

输出：

{
  "^o":"A",
  "a":[
    1,
    2,
    3
  ],
 "b":"hello"
}

请注意，^o 用于指定对象的类，并用于帮助反序列化。要省略 ^o，请使用 :compat 模式：

puts Oj::dump a, :indent => 2, :mode => :compat

输出：

{
  "a":[
    1,
    2,
    3
  ],
  "b":"hello"
}

Answer 3

如果渲染性能至关重要，您可能还需要查看 yajl-ruby，它是一个绑定到 C yajl 库。该序列化 API 如下所示：

require 'yajl'
Yajl::Encoder.encode({"foo" => "bar"}) #=> "{\"foo\":\"bar\"}"

Answer 4

您使用什么版本的 Ruby？ ruby -v 会告诉你。

如果是 1.9.2，JSON 包含在标准库中。

如果您使用的是 1.8.something，则执行 gem install json 即可安装。然后，在您的代码中执行以下操作：

require 'rubygems'
require 'json'

然后将 to_json 附加到一个对象，您就可以开始了：

asdf = {'a' => 'b'} #=> {"a"=>"b"}
asdf.to_json #=> "{"a":"b"}"

Answer 5

因为我自己搜索了很多将 Ruby 对象序列化为 json 的方法：

require 'json'

class User
  attr_accessor :name, :age

  def initialize(name, age)
    @name = name
    @age = age
  end

  def as_json(options={})
    {
      name: @name,
      age: @age
    }
  end

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

user = User.new("Foo Bar", 42)
puts user.to_json #=> {"name":"Foo Bar","age":42}

Answer 6

require 'json'
{"foo" => "bar"}.to_json
# => "{\"foo\":\"bar\"}"

Answer 7

要让内置类（例如 Array 和 Hash）支持 as_json 和 to_json，您需要 require 'json/add/core' （有关详细信息，请参阅自述文件）

Answer 8

Jbuilder 是 Rails 社区构建的一个 gem。但它在非轨道环境中运行良好，并且具有一组很酷的功能。

# suppose we have a sample object as below
sampleObj.name #=> foo
sampleObj.last_name #=> bar

# using jbuilder we can convert it to json:
Jbuilder.encode do |json|
  json.name sampleObj.name
  json.last_name sampleObj.last_name
end #=> "{:\"name\" => \"foo\", :\"last_name\" => \"bar\"}"

Answer 9

老线程，但仍然是一个合理的问题。我个人对 ruby​​ 中的序列化选项感到失望，尤其是知道由于 gems 不考虑内存分配而导致它有多慢。多年来我一直在使用它们。

我构建了 undraper-serializer 并在商业环境中使用了它，具有大量公共 API，具有潜在的潜力返回 10 MB 的 JSON。这个 gem 的主要优点：

• 非常快
• 允许选择字段返回（类似于 GraphQL 的可选择性）
• 半自以为是地控制大型代码库中的自然发生，添加和修改太多，以致于输出变得贪婪
• HATEOAS 很容易做到（和可选）

Answer 10

如果您使用的是 1.9.2 或更高版本，则只需使用 to_json 将哈希值和数组转换为嵌套 JSON 对象。

{a: [1,2,3], b: 4}.to_json

在 Rails 中，您可以对 Active Record 对象调用 to_json。您可以传递 :include 和 :only 参数来控制输出：

@user.to_json only: [:name, :email]

您还可以在 AR 关系上调用 to_json，如下所示：

User.order("id DESC").limit(10).to_json

您不需要导入任何内容，一切都按照您希望的方式工作。

Answer 11

实际上，有一个名为 Jsonable 的 gem，https://github.com/treeder/jsonable。非常甜蜜。

Answer 12

我曾经使用virtus。真正强大的工具，允许根据您指定的类创建动态 Ruby 结构。 Easy DSL，可以从 ruby​​ 哈希创建对象，有严格模式。检查它。