對(duì)編程語(yǔ)言比較熟悉的朋友，應(yīng)該知道“反射”這個(gè)機(jī)制。Python作為一門動(dòng)態(tài)語(yǔ)言，當(dāng)然不會(huì)缺少這一重要功能。然而，在網(wǎng)絡(luò)上卻很少見(jiàn)到有詳細(xì)或者深刻的剖析論文。下面結(jié)合一個(gè)web路由的實(shí)例來(lái)闡述python的反射機(jī)制的使用場(chǎng)景和核心本質(zhì)。

一、前言

def f1():
  print("f1是這個(gè)函數(shù)的名字！")
 
s = "f1"
print("%s是個(gè)字符串" % s)

　　在上面的代碼中，我們必須區(qū)分兩個(gè)概念，f1和“f1"。前者是函數(shù)f1的函數(shù)名，后者只是一個(gè)叫”f1“的字符串，兩者是不同的事物。我們可以用f1()的方式調(diào)用函數(shù)f1，但我們不能用"f1"()的方式調(diào)用函數(shù)。說(shuō)白了就是，不能通過(guò)字符串來(lái)調(diào)用名字看起來(lái)相同的函數(shù)！

二、web實(shí)例

　　考慮有這么一個(gè)場(chǎng)景，根據(jù)用戶輸入的url的不同，調(diào)用不同的函數(shù)，實(shí)現(xiàn)不同的操作，也就是一個(gè)url路由器的功能，這在web框架里是核心部件之一。下面有一個(gè)精簡(jiǎn)版的示例：

　　首先，有一個(gè)commons模塊，它里面有幾個(gè)函數(shù)，分別用于展示不同的頁(yè)面，代碼如下：

def login():
  print("這是一個(gè)登陸頁(yè)面！")

def logout():
  print("這是一個(gè)退出頁(yè)面！")

def home():
  print("這是網(wǎng)站主頁(yè)面！")

　　其次，有一個(gè)visit模塊，作為程序入口，接受用戶輸入，展示相應(yīng)的頁(yè)面，代碼如下：（這段代碼是比較初級(jí)的寫(xiě)法）

import commons

def run():
  inp = input("請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： ").strip()
  if inp == "login":
    commons.login()
  elif inp == "logout":
    commons.logout()
  elif inp == "home":
    commons.home()
  else:
    print("404")

if __name__ == '__main__':
  run()

　　我們運(yùn)行visit.py，輸入：home，頁(yè)面結(jié)果如下：

請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： home
這是網(wǎng)站主頁(yè)面！

　　這就實(shí)現(xiàn)了一個(gè)簡(jiǎn)單的WEB路由功能，根據(jù)不同的url，執(zhí)行不同的函數(shù)，獲得不同的頁(yè)面。

　　然而，讓我們考慮一個(gè)問(wèn)題，如果commons模塊里有成百上千個(gè)函數(shù)呢(這非常正常)?。難道你在visit模塊里寫(xiě)上成百上千個(gè)elif?顯然這是不可能的！那么怎么破？

三、反射機(jī)制

　　仔細(xì)觀察visit中的代碼，我們會(huì)發(fā)現(xiàn)用戶輸入的url字符串和相應(yīng)調(diào)用的函數(shù)名好像！如果能用這個(gè)字符串直接調(diào)用函數(shù)就好了！但是，前面我們已經(jīng)說(shuō)了字符串是不能用來(lái)調(diào)用函數(shù)的。為了解決這個(gè)問(wèn)題，python為我們提供一個(gè)強(qiáng)大的內(nèi)置函數(shù)：getattr!我們將前面的visit修改一下，代碼如下：

import commons

def run():
  inp = input("請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： ").strip()
  func = getattr(commons,inp)
  func()
 
if __name__ == '__main__':
  run()

　　首先說(shuō)明一下getattr函數(shù)的使用方法：它接收2個(gè)參數(shù)，前面的是一個(gè)對(duì)象或者模塊，后面的是一個(gè)字符串，注意了！是個(gè)字符串！

　　例子中，用戶輸入儲(chǔ)存在inp中，這個(gè)inp就是個(gè)字符串，getattr函數(shù)讓程序去commons這個(gè)模塊里，尋找一個(gè)叫inp的成員（是叫，不是等于），這個(gè)過(guò)程就相當(dāng)于我們把一個(gè)字符串變成一個(gè)函數(shù)名的過(guò)程。然后，把獲得的結(jié)果賦值給func這個(gè)變量，實(shí)際上func就指向了commons里的某個(gè)函數(shù)。最后通過(guò)調(diào)用func函數(shù)，實(shí)現(xiàn)對(duì)commons里函數(shù)的調(diào)用。這完全就是一個(gè)動(dòng)態(tài)訪問(wèn)的過(guò)程，一切都不寫(xiě)死，全部根據(jù)用戶輸入來(lái)變化。

　　執(zhí)行上面的代碼，結(jié)果和最開(kāi)始的是一樣的。

　　這就是python的反射，它的核心本質(zhì)其實(shí)就是利用字符串的形式去對(duì)象（模塊）中操作（查找/獲取/刪除/添加）成員，一種基于字符串的事件驅(qū)動(dòng)！

　　這段話，不一定準(zhǔn)確，但大概就是這么個(gè)意思。

四、進(jìn)一步完善

　　上面的代碼還有個(gè)小瑕疵，那就是如果用戶輸入一個(gè)非法的url，比如jpg，由于在commons里沒(méi)有同名的函數(shù)，肯定會(huì)產(chǎn)生運(yùn)行錯(cuò)誤，具體如下：

請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： jpg
Traceback (most recent call last):
 File "F:/Python/pycharm/s13/reflect/visit.py", line 16, in <module>
  run()
 File "F:/Python/pycharm/s13/reflect/visit.py", line 11, in run
  func = getattr(commons,inp)
AttributeError: module 'commons' has no attribute 'jpg'

　　那怎么辦呢？其實(shí)，python考慮的很全面了，它同樣提供了一個(gè)叫hasattr的內(nèi)置函數(shù)，用于判斷commons中是否具有某個(gè)成員。我們將代碼修改一下：

import commons
 
def run():
  inp = input("請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： ").strip()
  if hasattr(commons,inp):
    func = getattr(commons,inp)
    func()
  else:
    print("404")
 
if __name__ == '__main__':
  run()

　　通過(guò)hasattr的判斷，可以防止非法輸入錯(cuò)誤，并將其統(tǒng)一定位到錯(cuò)誤頁(yè)面。

　　其實(shí)，研究過(guò)python內(nèi)置函數(shù)的朋友，應(yīng)該注意到還有delattr和setattr兩個(gè)內(nèi)置函數(shù)。從字面上已經(jīng)很好理解他們的作用了。

　　python的四個(gè)重要內(nèi)置函數(shù)：getattr、hasattr、delattr和setattr較為全面的實(shí)現(xiàn)了基于字符串的反射機(jī)制。他們都是對(duì)內(nèi)存內(nèi)的模塊進(jìn)行操作，并不會(huì)對(duì)源文件進(jìn)行修改。

五、動(dòng)態(tài)導(dǎo)入模塊

　　上面的例子是在某個(gè)特定的目錄結(jié)構(gòu)下才能正常實(shí)現(xiàn)的，也就是commons和visit模塊在同一目錄下，并且所有的頁(yè)面處理函數(shù)都在commons模塊內(nèi)。如下圖：

　　但在現(xiàn)實(shí)使用環(huán)境中，頁(yè)面處理函數(shù)往往被分類放置在不同目錄的不同模塊中，也就是如下圖：

　　難道我們要在visit模塊里寫(xiě)上一大堆的import 語(yǔ)句逐個(gè)導(dǎo)入account、manage、commons模塊嗎？要是有1000個(gè)這種模塊呢？

　　剛才我們分析完了基于字符串的反射，實(shí)現(xiàn)了動(dòng)態(tài)的函數(shù)調(diào)用功能，我們不禁會(huì)想那么能不能動(dòng)態(tài)導(dǎo)入模塊呢？這完全是可以的！

　　python提供了一個(gè)特殊的方法：__import__(字符串參數(shù))。通過(guò)它，我們就可以實(shí)現(xiàn)類似的反射功能。__import__()方法會(huì)根據(jù)參數(shù)，動(dòng)態(tài)的導(dǎo)入同名的模塊。

我們?cè)傩薷囊幌律厦娴膙isit模塊的代碼。

def run():
  inp = input("請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： ").strip()
  modules, func = inp.split("/")
  obj = __import__(modules)
  if hasattr(obj, func):
    func = getattr(obj, func)
    func()
  else:
    print("404")
 
if __name__ == '__main__':
  run()

運(yùn)行一下：

請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： commons/home
這是網(wǎng)站主頁(yè)面！
請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： account/find
這是一個(gè)查找功能頁(yè)面！

　　我們來(lái)分析一下上面的代碼：

　　首先，我們并沒(méi)有定義任何一行import語(yǔ)句；

　　其次，用戶的輸入inp被要求為類似“commons/home”這種格式，其實(shí)也就是模擬web框架里的url地址，斜杠左邊指向模塊名，右邊指向模塊中的成員名。

　　然后，modules,func = inp.split("/")處理了用戶輸入，使我們獲得的2個(gè)字符串，并分別保存在modules和func變量里。

　　接下來(lái)，最關(guān)鍵的是obj = __import__(modules)這一行，它讓程序去導(dǎo)入了modules這個(gè)變量保存的字符串同名的模塊，并將它賦值給obj變量。

　　最后的調(diào)用中，getattr去modules模塊中調(diào)用func成員的含義和以前是一樣的。

　　總結(jié)：通過(guò)__import__函數(shù)，我們實(shí)現(xiàn)了基于字符串的動(dòng)態(tài)的模塊導(dǎo)入。

　　同樣的，這里也有個(gè)小瑕疵！

　　如果我們的目錄結(jié)構(gòu)是這樣的：

 　　那么在visit的模塊調(diào)用語(yǔ)句中，必須進(jìn)行修改，我們想當(dāng)然地會(huì)這么做：

def run():
  inp = input("請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： ").strip()
  modules, func = inp.split("/")
  obj = __import__("lib." + modules)   #注意字符串的拼接
  if hasattr(obj, func):
    func = getattr(obj, func)
    func()
  else:
    print("404")
 
if __name__ == '__main__':
  run()

　　改了這么一個(gè)地方:obj = __import__("lib." + modules)，看起來(lái)似乎沒(méi)什么問(wèn)題，和import lib.commons的傳統(tǒng)方法類似，但實(shí)際上運(yùn)行的時(shí)候會(huì)有錯(cuò)誤。

請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： commons/home
404
請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： account/find
404

　　為什么呢？因?yàn)閷?duì)于lib.xxx.xxx.xxx這一類的模塊導(dǎo)入路徑，__import__默認(rèn)只會(huì)導(dǎo)入最開(kāi)頭的圓點(diǎn)左邊的目錄，也就是“l(fā)ib”。我們可以做個(gè)測(cè)試，在visit同級(jí)目錄內(nèi)新建一個(gè)文件，代碼如下：

obj = __import__("lib.commons")
print(obj)

　　執(zhí)行結(jié)果：

<module 'lib' (namespace)>

　　這個(gè)問(wèn)題怎么解決呢？加上fromlist = True參數(shù)即可！

def run():
  inp = input("請(qǐng)輸入您想訪問(wèn)頁(yè)面的url： ").strip()
  modules, func = inp.split("/")
  obj = __import__("lib." + modules, fromlist=True) # 注意fromlist參數(shù)
  if hasattr(obj, func):
    func = getattr(obj, func)
    func()
  else:
    print("404")
 
if __name__ == '__main__':
  run()

　　至此，動(dòng)態(tài)導(dǎo)入模塊的問(wèn)題基本都解決了，只剩下最后一個(gè)，那就是萬(wàn)一用戶輸入錯(cuò)誤的模塊名呢？比如用戶輸入了somemodules/find，由于實(shí)際上不存在somemodules這個(gè)模塊，必然會(huì)報(bào)錯(cuò)！那有沒(méi)有類似上面hasattr內(nèi)置函數(shù)這么個(gè)功能呢？答案是沒(méi)有！碰到這種，你只能通過(guò)異常處理來(lái)解決。

六、最后的思考

　　可能有人會(huì)問(wèn)python不是有兩個(gè)內(nèi)置函數(shù)exec和eval嗎？他們同樣能夠執(zhí)行字符串。比如：

exec("print('haha')")

結(jié)果：

haha

　　那么直接使用它們不行嗎？非要那么費(fèi)勁地使用getattr， __import__干嘛？

　　其實(shí)，在上面的例子中，圍繞的核心主題是如何利用字符串驅(qū)動(dòng)不同的事件，比如導(dǎo)入模塊、調(diào)用函數(shù)等等，這些都是python的反射機(jī)制，是一種編程方法、設(shè)計(jì)模式的體現(xiàn)，凝聚了高內(nèi)聚、松耦合的編程思想，不能簡(jiǎn)單的用執(zhí)行字符串來(lái)代替。當(dāng)然，exec和eval也有它的舞臺(tái)，在web框架里也經(jīng)常被使用。

最新評(píng)論