元編程與eval

所謂元編程就是"生成代碼的代碼".

對(duì)于"解釋型"的編程語(yǔ)言,由于程序整個(gè)運(yùn)行時(shí)期都依賴于解釋器,最簡(jiǎn)單的方式就是讓語(yǔ)言提供一個(gè)eval方法,將字符串當(dāng)作該語(yǔ)言喂給解釋器執(zhí)行, Ruby,Python,JavaScript都提供了eval方法;

對(duì)于區(qū)分"編譯時(shí)"和"運(yùn)行時(shí)"的"編譯型"編程語(yǔ)言,可以給這種語(yǔ)言添加一種非常特殊的機(jī)制,讓它可以在"編譯時(shí)"生成代碼,典型的例子就是C/C++的宏和C++的模板.這種宏或者是模板實(shí)際上和語(yǔ)言本身差別很大,C++的模板本身甚至是一門圖靈完備的編程語(yǔ)言.

eval的缺點(diǎn)

eval很強(qiáng)大,但是也有很多缺點(diǎn):
1.將代碼作為字符串不能使用IDE/編輯器的語(yǔ)法檢查功能,提高了出錯(cuò)的幾率,當(dāng)然這個(gè)問(wèn)題容易解決,只要語(yǔ)法檢查工具將eval內(nèi)的字符串特殊處理即可;
2.字符串由程序拼接而來(lái),有被注入的風(fēng)險(xiǎn),這就和SQL注入一樣;
3.eval內(nèi)的字符串可能會(huì)污染上下文環(huán)境或者被上下文環(huán)境污染,引發(fā)意想不到的bug
因此Ruby提供了幾個(gè)弱化版的eval來(lái)消除這些缺點(diǎn),它們分別是instance_eval, class_eval, instance_exec

block

講解instance_eval之前先說(shuō)一下Ruby的代碼塊(block)和proc,block作為Ruby的一種基本語(yǔ)言要素,本身不能被當(dāng)做數(shù)據(jù)使用,不能動(dòng)態(tài)定義,只能事先寫好,但是block可以和proc互相轉(zhuǎn)換,而proc是ruby中的一等公民, 因此block仍然相當(dāng)于一等公民.
block擁有閉包的性質(zhì),在形成的時(shí)候會(huì)包裹當(dāng)前詞法作用域內(nèi)的綁定,這和其他正確實(shí)現(xiàn)閉包的語(yǔ)言沒(méi)有區(qū)別,但是block中有兩類變量會(huì)被特殊處理: 當(dāng)前實(shí)例(self和instance variable)和當(dāng)前類
block有兩種使用方式(就我目前了解到的):

1.作為普通的閉包

@a = 1
b = 1
puts_self = Proc.new do
  puts self, @a, b
end

puts_self.call # main 1 1

class A
  def call_proc(proc)
      @a = 2
      b = 2
      proc.call
  end
end

A.new.call_proc(puts_self) # main 1 1

這種用法會(huì)捕獲詞法作用域內(nèi)的綁定(包括self和@a).當(dāng)使用proc.call或者yield(args)這種方法去調(diào)用proc,都是將block當(dāng)作了普通的閉包.

2.作為可改變上下文的閉包

@a = 1
b = 1
puts_self = Proc.new do
  puts self, @a, b
end

puts_self.call # main 1 1

class B
  def call_proc(proc)
      @a = 2
      b = 2
      instance_eval(&proc)
  end
end
B.new.call_proc(puts_self) #  #<B:0x00000001338410> 2 1

如果block用instance_eval去執(zhí)行,block里的@a和self都被改變了,它們的上下文變成了instance_eval的調(diào)用者----B的一個(gè)實(shí)例 #<B:0x00000001338410>;而b仍然被當(dāng)作普通的變量----它來(lái)自于定義閉包時(shí)的詞法作用域.

可見,block的當(dāng)前實(shí)例是可以被改變的
此外,block的當(dāng)前類也能被改變,如果block里有取決于當(dāng)前類的語(yǔ)句/表達(dá)式(如def),那么改變了執(zhí)行結(jié)果也會(huì)隨著上下文的改變而改變

instance_eval

instance_eval方法如其名,將它的調(diào)用者作為當(dāng)前實(shí)例(instance)去eval一個(gè)block,block里和instance有關(guān)的上下文變量self和instance variable都被相應(yīng)改變了.

instance_eval在改變了當(dāng)前實(shí)例的同時(shí),還改變了當(dāng)前類

def_method = Proc.new do
 def test_method
 end
end

class C
 def call_proc(proc)
   instance_eval(&proc)
 end  
end

c = C.new
c.call_proc(def_method)

m = c.method(:test_method)
m.owner # #<Class:#<C:0x00000001fb93b0>>,這是m的eigen class

def是作用于當(dāng)前類上的,它會(huì)把它定義的方法放在當(dāng)前類里面,test_method位于m的eigen class,說(shuō)明instance_eval將當(dāng)前類修改為當(dāng)前實(shí)例的eigen class了.

class_eval

和instance_eval類似,class_eval是將它的調(diào)用者作為當(dāng)前類(class)去eval一個(gè)block,block里和class有關(guān)的上下文變量都會(huì)被改變

p = Proc.new do
  def test_method
  end
  puts self
end

class D
end

D.class_eval(&p) # D
d = D.new
m = d.method(:test_method)
m.owner # D

因?yàn)橹挥蠧lass的實(shí)例才具有class_eval方法,所以我們直接用D去調(diào)用class_eval,很容易看出class_eval將當(dāng)前類和當(dāng)前實(shí)例都修改成了class_eval的調(diào)用者.

instance_exec

前面的instance_eval已經(jīng)很強(qiáng)大了,但是總感覺(jué)少了些什么,加入哪天我們閑得蛋疼了想實(shí)現(xiàn)一個(gè)可以自定義二元運(yùn)算的類宏def_calc_method, 它接受一個(gè)方法名和一個(gè)怎么去計(jì)算的代碼塊,效果就是給它的調(diào)用者添加一個(gè)可以做這種計(jì)算的實(shí)例方法
具體來(lái)說(shuō)就是要這樣的效果

class LeftValue
  extend BinaryCalcDefiner

  def_calc_method :add do |y|
     @x + y
  end

  def_calc_method :times do |y|
    @x * y
  end

 def initialize(x)
      @x = x
  end
end

five = LeftValue.new(5)
five.add(1) # 6
five.times(4) # 20

看起來(lái)還是有一絲酷炫,雖然并沒(méi)有什么卵用.

怎樣實(shí)現(xiàn)呢?
def_calc_method的架子大概是這樣的

module BinaryCalcDefiner
  def def_calc_method(method_name, &calc_proc)
     define_method method_name do |y|
        ______(y, &proc)
     end
  end
end

空白處要填入哪個(gè)方法呢?
因?yàn)橐壎▽?shí)例的@x,所以必須要用instance_eval這種能改變上下文的方法去eval傳入的塊,然而這個(gè)塊還需要接受一個(gè)參數(shù),instance_eval和class_eval肯定是不行的,所以就理所當(dāng)然地引入了instance_exec來(lái)解決這種問(wèn)題,它eval一個(gè)塊的時(shí)候可以將一個(gè)參數(shù)作為塊的參數(shù)

module BinaryCalcDefiner
  def def_calc_method(method_name, &calc_proc)
     define_method method_name do |y|
        instance_exec(y, &proc)
     end
  end
end

大功告成.

總結(jié)

eval大大加強(qiáng)了Ruby的元編程能力,而eval本身問(wèn)題較多.instance_eval, class_eval, instance_exec作為eval方法的弱化版,實(shí)際上和SQL的預(yù)編譯技術(shù)差不多,都是將代碼中的可變部分控制在很小的范圍,以免引入注入風(fēng)險(xiǎn).此外由于三者都是接受的Ruby的代碼塊而不是字符串,所以加強(qiáng)了可讀性,上下文環(huán)境也得以清晰明了(相當(dāng)于普通的閉包).
三個(gè)方法的本質(zhì)都是通過(guò)改變代碼塊的上下文而使得代碼塊擁有更強(qiáng)的表達(dá)能力,都可以改變當(dāng)前類和當(dāng)前實(shí)例,特別的,instance_eval可以給帶參數(shù)的block注入?yún)?shù).