модуль ActiveModel::Serializers::JSON
Сериализатор Active Model JSON
Открытые методы экземпляра
# File activemodel/lib/active_model/serializers/json.rb, line 96
def as_json(options = nil)
root = if options && options.key?(:root)
options[:root]
else
include_root_in_json
end
hash = serializable_hash(options).as_json
if root
root = model_name.element if root == true
{ root => hash }
else
hash
end
end Возвращает хеш, представляющий модель. Некоторые настройки могут быть переданы через options.
Опция include_root_in_json управляет поведением верхнего уровня as_json. Если true, as_json будет генерировать единственный корневой узел, названный по типу объекта. Значение по умолчанию для опции include_root_in_json равно false.
user = User.find(1)
user.as_json
# => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:133.000Z", "awesome" => true}
ActiveRecord::Base.include_root_in_json = true
user.as_json
# => { "user" => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true } }
Это поведение также можно достичь, установив опцию :root в true следующим образом:
user = User.find(1)
user.as_json(root: true)
# => { "user" => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true } }
Если нужно, :root также можно установить на пользовательский строковый ключ, как показано ниже:
user = User.find(1)
user.as_json(root: "author")
# => { "author" => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true } }
Без каких-либо options, возвращаемый Hash будет включать все атрибуты модели.
user = User.find(1)
user.as_json
# => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true}
Опции :only и :except могут использоваться для ограничения включаемых атрибутов и работают аналогично методу attributes.
user.as_json(only: [:id, :name])
# => { "id" => 1, "name" => "Konata Izumi" }
user.as_json(except: [:id, :created_at, :age])
# => { "name" => "Konata Izumi", "awesome" => true }
Для включения результата вызова некоторых методов модели используйте :methods:
user.as_json(methods: :permalink)
# => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true,
# "permalink" => "1-konata-izumi" }
Для включения ассоциаций используйте :include:
user.as_json(include: :posts)
# => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true,
# "posts" => [ { "id" => 1, "author_id" => 1, "title" => "Welcome to the weblog" },
# { "id" => 2, "author_id" => 1, "title" => "So I was thinking" } ] }
Ассоциации второго и более высоких уровней также работают:
user.as_json(include: { posts: {
include: { comments: {
only: :body } },
only: :title } })
# => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
# "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true,
# "posts" => [ { "comments" => [ { "body" => "1st post!" }, { "body" => "Second!" } ],
# "title" => "Welcome to the weblog" },
# { "comments" => [ { "body" => "Don't think too hard" } ],
# "title" => "So I was thinking" } ] }
# File activemodel/lib/active_model/serializers/json.rb, line 146 def from_json(json, include_root = include_root_in_json) hash = ActiveSupport::JSON.decode(json) hash = hash.values.first if include_root self.attributes = hash self end
Устанавливает модель attributes из строки JSON. Возвращает self.
class Person
include ActiveModel::Serializers::JSON
attr_accessor :name, :age, :awesome
def attributes=(hash)
hash.each do |key, value|
send("#{key}=", value)
end
end
def attributes
instance_values
end
end
json = { name: 'bob', age: 22, awesome:true }.to_json
person = Person.new
person.from_json(json) # => #<Person:0x007fec5e7a0088 @age=22, @awesome=true, @name="bob">
person.name # => "bob"
person.age # => 22
person.awesome # => true
Значение по умолчанию для include_root равно false. Можно изменить его на true если заданная строка JSON содержит один корневой узел.
json = { person: { name: 'bob', age: 22, awesome:true } }.to_json
person = Person.new
person.from_json(json, true) # => #<Person:0x007fec5e7a0088 @age=22, @awesome=true, @name="bob">
person.name # => "bob"
person.age # => 22
person.awesome # => true
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.