Ruby中的反射（Reflection）應用實例

在Java語言中，提供了發射機制，通過發射機制可以通過字元串構造出這個對象，可以獲取對象的所有方法（包括私有方法），可以調用私有方法，可以更改成員變數的值（包括私有的成員變數）。

Ruby也是面向對象的高級語言，當然也提供了反射機制，今天我們討論通過類名稱構造類對象的功能。

一、通過類名稱構造類對象

我們先看普通的構造：

module ModuleA
#the class name, later we will use it to create the corresponding object
CLASS_NAME_OF_WOOD = "ModuleA::Wood"
CLASS_NAME_OF_WOODDESK = "ModuleA::WoodDesk"
CLASS_NAME_OF_WOODCHAIR = "ModuleA::WoodChair"

class Wood
def initialize
@desc = "I am a primal wood"
end

def say
puts @desc
end
end

class WoodDesk < Wood
def initialize
@desc = "I am a desk made of wood"
end

def say_private
puts "actually, i have some bug but no public"
end

public :say
private :say_private

end

class WoodChair < Wood
def initialize
@desc = "I am a chair made of wood"
end

def say_private
puts "I Want get married with a WoodDesk..."
end

def smile
puts "ha hah hah haha ...."
end

public :say
private :say_private, :smile
end
end

定義了一個基礎類Wood，有兩個子類：WoodDesk, WoodChair，子類有分別有一個私有方法 say_private。

我們new出對象來執行：

#the normal initailze
wood = ModuleA::Wood.new
wood.say
desk = ModuleA::WoodDesk.new
desk.say
chair = ModuleA::WoodChair.new
chair.say

#try call the private method
puts "desk respond to say_private? #{desk.respond_to? :say_private}"
desk.say_private if desk.respond_to? :say_private

上面代碼，執行public方法say，然後嘗試執行private方法 say_private，執行先check是否能夠執行，返回結果是不能執行，desk.respond_to? :say_private返回false：

I am a primal wood
I am a desk made of wood
I am a chair made of wood
desk respond to say_private? false

好，現在我們通過反射機制來構造對象，並嘗試執行其私有方法。

我們注意到模塊的定義中有三個常量，定義的是類名稱，

#the class name, later we will use it to create the corresponding object
CLASS_NAME_OF_WOOD = "ModuleA::Wood"
CLASS_NAME_OF_WOODDESK = "ModuleA::WoodDesk"
CLASS_NAME_OF_WOODCHAIR = "ModuleA::WoodChair"

下面會通過這三個變數來理解Module.constants方法。

下面代碼片段，基於上面的類定義：

#get all module constants
obj_list = Array.new
tmp_const_sym_list = ModuleA.constants
tmp_const_sym_list.each do | sym |
obj_list << ModuleA.const_get(sym)
puts "calss = #{sym.class}, value = #{sym}"
end

我們注意到 ModuleA.constants，這個方法是Module模塊中的，其作用是返回模塊中所有常量的Symbol對象。我們看結果輸出：

calss = Symbol, value = CLASS_NAME_OF_WOOD
calss = Symbol, value = CLASS_NAME_OF_WOODDESK
calss = Symbol, value = CLASS_NAME_OF_WOODCHAIR
calss = Symbol, value = Wood
calss = Symbol, value = WoodDesk
calss = Symbol, value = WoodChair

從結果中看到，定義的三個常量和類名稱都被返回了。所以注意：Ruby中的常量是包含定義的常量（變數）和類名稱，注意他們都是Symbol對象。。

不過我們是需要根據類名稱構造類對象，那麼那三個常量就是沒用的，需要刪除。我們通過正則表達式匹配名字，來過濾。上面的代碼修改一下：

#get all module constants
sym_list = Array.new
tmp_const_sym_list = ModuleA.constants
tmp_const_sym_list.each do | sym |
puts "calss = #{sym.class}, value = #{sym}"
sym_list << ModuleA.const_get(sym) if /^Wood\w*/ =~ sym.to_s
end

sym_list << ModuleA.const_get(sym) if /^Wood\w*/ =~ sym.to_s，僅保存以Wood開頭的symbol，這樣我們就過濾掉了那三個常量。

找都類名稱之後，開始構造對象：

#create object from symbol
obj_list = Array.new
sym_list.each do | sym |
obj = sym.new
obj_list << obj
puts "create the object: #{obj}"
end

begin
obj_list.each do | wood |
wood.say
end

調用Symbol的new方法構造出次對象（sym.new），然後我們調用對象的say方法：

create the object: #
create the object: #
create the object: #
I am a primal wood
I am a desk made of wood
I am a chair made of wood

達到了我們預期的結果。

二、操作成員變數和私有方法

使用過Java反射的同學們都知道，有了對象之後，操作成員變數和私有方法也就不在話下了。

Ruby中也是一樣。

先看操作成員變數的例子。我們嘗試更改一個成員變數的值。（接著上一片文章的代碼）

#manpulate instance variables
first_wood = obj_list.first
first_wood.instance_variables.each do | var |
#get the instance variable
puts "class of var = #{var.class}, value of var = #{var}"
var_value = first_wood.instance_variable_get(var)
puts "class of var_value = #{var_value.class}, value of var_value = #{var_value}"

#set the new value of instance varialbe
first_wood.instance_variable_set(var, var_value + "...and i was changed.")
first_wood.say
end

1、first_wood.instance_variables.each，我們得到一個Wood對象，然後調用其instance_variables方法得到所有成員變數的名稱（Symbol對象）。

2、然後，調用對象的first_wood.instance_variable_get方法，傳遞成員變數名稱，得到成員變數對象。

3、最後，我們通過first_wood.instance_variable_set，改變這個成員變數的值。

代碼運行結果：

class of var = Symbol, value of var = @desc
class of var_value = String, value of var_value = I am a primal wood
I am a primal wood...and i was changed.

再看調用私有方法：

#call private method
last_wood = obj_list.last
last_wood.method(:say_private).call

很簡單，如果你知道方法名稱，調用last_wood.method傳入方法名，就可以得到一個Method對象，然後調用Method對象的call方法，結果是私有方法輸出的內容：

I Want get married with a WoodDesk...

普通場景下用不到修改成員變數和調用私有方法，因為這是違反了面向對象的封裝原則的，那麼反射在什麼場景下有用呢？從我個人經驗來說我覺得兩個地方有用：

1）單元測試。

2）面向方面編程。

這兩種場景都需要調用私有方法或替換成員變數的值。

你覺得呢？