Ruby on Rails 5.2 - ActiveModel::Serializers::JSON

मॉड्यूल ActiveModel :: सीरियल :: JSON




ruby

मॉड्यूल ActiveModel :: सीरियल :: JSON

शामिल मॉड्यूल:
ActiveModel::Serialization

सक्रिय मॉडल JSON सीरियल

सार्वजनिक प्रवृत्ति के तरीके

as_json (विकल्प = nil) स्रोत दिखाएं
# File activemodel/lib/active_model/serializers/json.rb, line 89
def as_json(options = nil)
  root = if options && options.key?(:root)
    options[:root]
  else
    include_root_in_json
  end

  if root
    root = model_name.element if root == true
    { root => serializable_hash(options) }
  else
    serializable_hash(options)
  end
end

मॉडल का प्रतिनिधित्व करने वाला हैश लौटाता है। कुछ विन्यास options माध्यम से पारित किया जा सकता है।

विकल्प as_json जो as_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/01", "awesome" => true}

ActiveRecord::Base.include_root_in_json = true

user.as_json
# => { "user" => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
#                  "created_at" => "2006/08/01", "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/01", "awesome" => true } }

किसी भी options बिना, लौटे Hash में सभी मॉडल की विशेषताएं शामिल होंगी।

user = User.find(1)
user.as_json
# => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
#      "created_at" => "2006/08/01", "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/01", "awesome" => true,
#      "permalink" => "1-konata-izumi" }

संघों का उपयोग शामिल करने के लिए :include :

user.as_json(include: :posts)
# => { "id" => 1, "name" => "Konata Izumi", "age" => 16,
#      "created_at" => "2006/08/01", "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/01", "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" } ] }
from_json (json, समावेश_root = शामिल_root_in_json ) स्रोत दिखाएँ
# File activemodel/lib/active_model/serializers/json.rb, line 138
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 । यदि JSON स्ट्रिंग में एकल रूट नोड शामिल true तो आप इसे true बदल सकते हैं।

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