1. 程式人生 > >Ruby中巢狀物件(Nested Object)的to_json方法,不使用Rails(Without Rails)

Ruby中巢狀物件(Nested Object)的to_json方法,不使用Rails(Without Rails)

JSON由於其資料結構簡單便利,已逐漸成為了網際網路上的主流資料交換的資料格式。
JSON也支援ruby語言,參考其專案主頁 JSON implementation for Ruby

在討論巢狀物件(Nested Object)的JSON轉換方法之前,我們先看簡單的ruby JSON轉換。
首先,ruby物件轉換為JSON字串:

class Obj1
def initialize(var1)
@var1 = var1
end

def to_json(*a)
{
"json_class" => self.class,
"data" => {"var1" => @var1}
}.to_json(*a)
end

def self.json_create(json_str)
new(json_str["data"]["var1"])
end
end

obj1 = Obj1.new("i am obj1")

#obj1 to JSON string
json_str = obj1.to_json
puts "JSON string of obj1 = #{json_str}"

#JSON string to obj1
obj11 = JSON.parse(json_str)
puts "ob1 from json string = #{obj11.var1}"


上面程式碼我們可以看到,ruby與JSON string之間的轉換,關鍵有三個點:

#引入json庫,才能有下面兩個方法,json是通過open class的方式,給Hash物件加上了to_json(*a)方法,關於ruby的open class參考支援Open Class特性的程式語言中的開閉原則(Open-Closed Principle)
1)require ‘json’

#定義物件轉為JSON string的to_json(*a)方法,其實現是使用Hash物件的to_json(*a)方法
2)def to_json(*a)

#定義從JSON string構造物件的json_create方法,此方法是類方法
3)def self.json_create(json_str)

上面三點是Ruby中實現JSON string互相轉換的基本要求。

程式碼執行結果為:

JSON string of obj1 = {"json_class":"Obj1","data":{"var1":"i am obj1"}}
ob1 from json string = i am obj1

現在我們來看巢狀物件的JSON string轉換:

#!/usr/local/ruby/bin/ruby

require 'json'

class Obj1
def initialize(var1)
@var1 = var1
end

def to_json(*a)
{
"json_class" => self.class,
"data" => {"var1" => @var1}
}.to_json(*a)
end

def self.json_create(json_str)
new(json_str["data"]["var1"])
end

attr_reader :var1
end

class Obj2
def initialize(var2)
@var2 = var2
end

def to_json(*a)
{
"json_class" => self.class,
"data" => {"var2" => @var2}
}.to_json(*a)
end

def self.json_create(json_str)
new(json_str["data"]["var2"])
end

attr_reader :var2
end

class Obj
def initialize(obj1, obj2)
@obj1 = obj1
@obj2 = obj2
end

def to_json(*a)
{
"json_class" => self.class,
"data" => {"obj1" => @obj1.to_json, "obj2" => @obj2.to_json}
}.to_json(*a)
end

def self.json_create(json_str)
new(json_str["data"]["obj1"], json_str["data"]["obj2"])
end

def to_s
"Hi, i am obj"
end

attr_reader :obj1, :obj2
end

obj1 = Obj1.new("i am obj1")
obj2 = Obj2.new("i am obj2")
obj = Obj.new(obj1,obj2)

obj_json_str = obj.to_json
puts "JSON string of obj = #{obj_json_str}"

obj_1 = JSON.parse(obj_json_str)
puts "obj_1 from json string , obj1.class = #{obj_1.obj1.class}, obj2.class = #{obj_1.obj2.class}"

上面程式碼中,巢狀物件我們慣性思維,是先將物件自己轉換為JSON string:

"data" => {"obj1" => @obj1.to_json, "obj2" => @obj2.to_json}

上面程式碼輸出:

JSON string of obj = {"json_class":"Obj","data":{"obj1":"{\"json_class\":\"Obj1\",\"data\":{\"var1\":\"i am obj1\"}}","obj2":"{\"json_class\":\"Obj2\",\"data\":{\"var2\":\"i am obj2\"}}"}}
obj_1 from json string , obj1.class = String, obj2.class = String

我們注意到,被巢狀的物件轉換為JSON string後,多了一個反斜槓 \ :

JSON string of obj = {"json_class":"Obj","data":{"obj1":"{\"json_class\":\"Obj1\",\"data\":{\"var1\":\"i am obj1\"}}","obj2":"{\"json_class\":\"Obj2\",\"data\":{\"var2\":\"i am obj2\"}}"}}

且,JSON string轉換後,obj物件中巢狀的物件obj1和obj2,其型別都為String,而不是期望的Obj1和Obj2型別

obj_1 from json string , obj1.class = String, obj2.class = String

實際上,這裡是慣性思維害人,被巢狀的物件,不需要呼叫其to_json方法。
因此將Obj類的to_json程式碼:

def to_json(*a)
{
"json_class" => self.class,
"data" => {"obj1" => @obj1.to_json, "obj2" => @obj2.to_json}
}.to_json(*a)
end

修正為:

def to_json(*a)
{
"json_class" => self.class,
"data" => {"obj1" => @obj1, "obj2" => @obj2}
}.to_json(*a)
end

然後,執行程式碼,可以看到預期的輸出:

JSON string of obj = {"json_class":"Obj","data":{"obj1":{"json_class":"Obj1","data":{"var1":"i am obj1"}},"obj2":{"json_class":"Obj2","data":{"var2":"i am obj2"}}}}
obj_1 from json string = {"json_class"=>"Obj", "data"=>{"obj1"=>#<0x007fe80402ea60 am obj1>, "obj2"=>#<0x007fe80402e088 am obj2>}}