利用Python的裝飾器解決Bottle架構中使用者驗證問題

首先來分析下需求,web程式後台需要認證,後台頁麵包含多個頁面,最普通的方法就是為每個url添加認證,但是這樣就需要每個每個綁定url的後台函數都需要添加類似或者相同的代碼,但是這樣做代碼就過度冗餘,而且不利於擴充.

接下來我們先不談及裝飾器,我們都知道Python是個很強大的語言,她可以將函數當做參數傳遞給函數,最簡單的:

def p():  print 'Hello,world'def funcfactor(func):  print 'calling function named', func.__name__  func()  print 'end'funcfactor(p)# 輸出為:# calling function named p# Hello,world# end

一目瞭然的程式,定義一個函數p(),將函數p當做參數傳遞給喊出funcfactor,在執行p函數前後加上一些動作.

我們還可以這麼做:

def p():  print 'Hello,world'def funcfactor(func):  print 'calling function named', func.__name__  return funcfunc = funcfactor(p)func()# 輸出為:# calling function named pHello,world

正如你看到的,我們可以將函數返回然後賦予一個變數,留待稍後調用.但是這種情況下我們要想在函數執行後做點什麼就不可能,但是我們的Python是強大的,Python可以在函數中再嵌套一個函數,我們可以像下面這麼做:

def p():  print 'Hello, world'def funcfactor(func):  def wrapper():    print 'do something at start'    func()    print 'do something at end'  return wrapperfunc = funcfactor(p)func()#輸出為:# do something at start# Hello, world# do something at end

下面我們來看看裝飾器,上面的代碼雖然實現的一個很困難的任務,但是還不夠優雅,而且代碼不符合Python的哲學思想,所以裝飾器就應聲而出,裝飾器沒有和上面的原理相同,同樣用於封裝函數,只是代碼實現上更加優雅和便於閱讀.裝飾器以@開頭後面跟上裝飾器的名稱,緊接著下一行就是要封裝的函數體,上面的例子用裝飾器可用如下方式實現:

def decorator(func):  def wrapper():    print 'do something at start'    func()    print 'do something at end'  return wrapper@decoratordef p():  print 'Hello, world'p()#輸出為:# do something at start# Hello, world# do something at end

實際上裝飾器並沒有效能方面或其他方面的提升,僅僅是一種文法糖,就是上面一個例子的改寫,這樣更加優雅和便與閱讀. 如果我們的p()函數不想僅僅只輸Hello,world,我們想向某些我們指定的人打招呼:

def decorator(func):  def wrapper(*args, **kargs):    print 'do something at start'    func(**kargs)    print 'do something at end'  return wrapper@decoratordef p(name):  print 'Hello', namep(name="Jim")#輸出為:# do something at start# Hello Jim# do something at end

裝飾器在裝飾不需要參數的裝飾器嵌套函數不是必須得,如果被裝飾的函數需要參數,必須嵌套一個函數來處理參數. 寫到這裡想必大家也知道裝飾器的用法和作用.現在回到正題,如何優雅的給後台url加上驗證功能?毫無疑問我們使用裝飾器來處理:

def blog_auth(func):  '''  定義一個裝飾器用於裝飾需要驗證的頁面  裝飾器必須放在route裝飾器下面  '''  # 定義封裝函數  def wrapper(*args, **kargs):    try:      # 讀取cookie      user = request.COOKIES['user']      shell = request.COOKIES['shell']    except:      # 出現異常則重新導向到登入頁面      redirect('/login')    # 驗證使用者資料    if checkShell(user, shell):      # 校正成功則返回函數      return func(**kargs)    else:      # 否則則重新導向到登入頁面      redirect('/login')  return wrapper

可以再需要驗證的地方添加blog_auth裝飾器:

@route('/admin:#/?#')@blog_authdef admin():  '''  用於顯示後台管理首頁  '''  TEMPLATE['title'] = '儀錶盤 | ' + TEMPLATE['BLOG_NAME']  TEMPLATE['user'] = request.COOKIES['user']  articles = []  for article in db.posts.find().sort("date",DESCENDING).limit(10):    articles.append(article)  # 將文章列表交給前台模版  TEMPLATE['articles'] = articles  return template('admin.html',TEMPLATE)

至此bottle驗證的問題就很優雅的用裝飾器解決了.

