Python裝飾器是一個消除冗餘的強大工具。隨著將功能模組化為大小合適的方法，即使是最複雜的工作流，裝飾器也能使它變成簡潔的功能。
例如讓我們看看Django web框架，該框架處理請求的方法接收一個方法物件，返回一個響應物件：
|
1 2 |
def handle_request(request): return HttpResponse("Hello, World") |
我最近遇到一個案例，需要編寫幾個滿足下述條件的api方法：
- 返回json響應
- 如果是GET請求，那麼返回錯誤碼
做為一個註冊api端點例子，我將會像這樣編寫：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
def register(request): result = None # check for post only if request.method != 'POST': result = {"error": "this method only accepts posts!"} else: try: user = User.objects.create_user(request.POST['username'], request.POST['email'], request.POST['password']) # optional fields for field in ['first_name', 'last_name']: if field in request.POST: setattr(user, field, request.POST[field]) user.save() result = {"success": True} except KeyError as e: result = {"error": str(e) } response = HttpResponse(json.dumps(result)) if "error" in result: response.status_code = 500 return response |
然而這樣我將會在每個api方法中編寫json響應和錯誤返回的程式碼。這將會導致大量的邏輯重複。所以讓我們嘗試用裝飾器實現DRY原則吧。
裝飾器簡介
如果你不熟悉裝飾器，我可以簡單解釋一下，實際上裝飾器就是有效的函式包裝器，python直譯器載入函式的時候就會執行包裝器，包裝器可以修改函式的接收引數和返回值。舉例來說，如果我想要總是返回比實際返回值大一的整數結果，我可以這樣寫裝飾器：
|
1 2 3 4 5 6 7 8 9 |
# a decorator receives the method it's wrapping as a variable 'f' def increment(f): # we use arbitrary args and keywords to # ensure we grab all the input arguments. def wrapped_f(*args, **kw): # note we call f against the variables passed into the wrapper, # and cast the result to an int and increment . return int(f(*args, **kw)) + 1 return wrapped_f # the wrapped function gets returned. |
現在我們就可以用@符號和這個裝飾器去裝飾另外一個函式了：
|
1 2 3 4 5 6 |
@increment def plus(a, b): return a + b result = plus(4, 6) assert(result == 11, "We wrote our decorator wrong!") |
裝飾器修改了存在的函式，將裝飾器返回的結果賦值給了變數。在這個例子中，’plus’的結果實際指向increment(plus)的結果。
對於非post請求返回錯誤
現在讓我們在一些更有用的場景下應用裝飾器。如果在django中接收的不是POST請求，我們用裝飾器返回一個錯誤響應。
|
1 2 3 4 5 6 7 8 9 10 |
def post_only(f): """ Ensures a method is post only """ def wrapped_f(request): if request.method != "POST": response = HttpResponse(json.dumps( {"error": "this method only accepts posts!"})) response.status_code = 500 return response return f(request) return wrapped_f |
現在我們可以在上述註冊api中應用這個裝飾器：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
@post_only def register(request): result = None try: user = User.objects.create_user(request.POST['username'], request.POST['email'], request.POST['password']) # optional fields for field in ['first_name', 'last_name']: if field in request.POST: setattr(user, field, request.POST[field]) user.save() result = {"success": True} except KeyError as e: result = {"error": str(e) } response = HttpResponse(json.dumps(result)) if "error" in result: response.status_code = 500 return response |
現在我們就有了一個可以在每個api方法中重用的裝飾器。
傳送json響應
為了傳送json響應（同時處理500狀態碼），我們可以新建另外一個裝飾器：
|
1 2 3 4 5 6 7 8 |
def json_response(f): """ Return the response as json, and return a 500 error code if an error exists """ def wrapped(*args, **kwargs): result = f(*args, **kwargs) response = HttpResponse(json.dumps(result)) if type(result) == dict and 'error' in result: response.status_code = 500 return response |
現在我們就可以在原方法中去除json相關的程式碼，新增一個裝飾器做為代替：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
@post_only @json_response def register(request): try: user = User.objects.create_user(request.POST['username'], request.POST['email'], request.POST['password']) # optional fields for field in ['first_name', 'last_name']: if field in request.POST: setattr(user, field, request.POST[field]) user.save() return {"success": True} except KeyError as e: return {"error": str(e) } |
現在，如果我需要編寫新的方法，那麼我就可以使用裝飾器做冗餘的工作。如果我要寫登入方法，我只需要寫真正相關的程式碼：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
@post_only @json_response def login(request): if request.user is not None: return {"error": "User is already authenticated!"} user = auth.authenticate(request.POST['username'], request.POST['password']) if user is not None: if not user.is_active: return {"error": "User is inactive"} auth.login(request, user) return {"success": True, "id": user.pk} else: return {"error": "User does not exist with those credentials"} |
BONUS: 引數化你的請求方法
我曾經使用過Tubogears框架，其中請求引數直接解釋轉遞給方法這一點我很喜歡。所以要怎樣在Django中模仿這一特性呢？嗯，裝飾器就是一種解決方案！
例如:
|
1 2 3 4 5 6 |
def parameterize_request(types=("POST",)): """ Parameterize the request instead of parsing the request directly. Only the types specified will be added to the query parameters. e.g. convert a=test |
注意這是一個引數化裝飾器的例子。在這個例子中，函式的結果是實際的裝飾器。
現在我就可以用引數化裝飾器編寫方法了！我甚至可以選擇是否允許GET和POST，或者僅僅一種請求引數型別。
|
1 2 3 4 5 6 7 8 9 10 |
@post_only @json_response @parameterize_request(["POST"]) def register(request, username, email, password, first_name=None, last_name=None): user = User.objects.create_user(username, email, password) user.first_name=first_name user.last_name=last_name user.save() return {"success": True} |
現在我們有了一個簡潔的、易於理解的api。
BONUS #2: 使用functools.wraps儲存docstrings和函式名
很不幸，使用裝飾器的一個副作用是沒有儲存方法名(__name__)和docstring(__doc__)值：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
def increment(f): """ Increment a function result """ wrapped_f(a, b): return f(a, b) + 1 return wrapped_f @increment def plus(a, b) """ Add two things together """ return a + b plus.__name__ # this is now 'wrapped_f' instead of 'plus' plus.__doc__ # this now returns 'Increment a function result' instead of 'Add two things together' |
這將對使用反射的應用造成麻煩，比如Sphinx，一個 自動生成文件的應用。
為了解決這個問題，我們可以使用’wraps’裝飾器附加上名字和docstring：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
from functools import wraps def increment(f): """ Increment a function result """ @wraps(f) wrapped_f(a, b): return f(a, b) + 1 return wrapped_f @increment def plus(a, b) """ Add two things together """ return a + b plus.__name__ # this returns 'plus' plus.__doc__ # this returns 'Add two things together' |
BONUS #3: 使用’decorator’裝飾器
如果仔細看看上述使用裝飾器的方式，在包裝器宣告和返回的地方也有不少重複。
你可以安裝python egg ‘decorator’，其中包含一個提供裝飾器模板的’decorator’裝飾器！
使用easy_install:
|
1 |
$ sudo easy_install decorator |
或者Pip:
|
1 |
$ pip install decorator |
然後你可以簡單的編寫：
|
1 2 3 4 5 6 7 8 9 10 11 |
from decorator import decorator @decorator def post_only(f, request): """ Ensures a method is post only """ if request.method != "POST": response = HttpResponse(json.dumps( {"error": "this method only accepts posts!"})) response.status_code = 500 return response return f(request) |
這個裝飾器更牛逼的一點是儲存了__name__和__doc__的返回值，也就是它封裝了
functools.wraps的功能！