Flask正則路由,異常捕獲和請求鈎子

正則匹配路由

在 web 開發中，可能會出現限制用戶訪問規則的場景，那么這個時候就需要用到正則匹配，根據自己的規則去限定請求參數再進行訪問

具體實現步驟為：

• 導入轉換器基類：在 Flask 中，所有的路由的匹配規則都是使用轉換器對象進行記錄
• 自定義轉換器：自定義類繼承於轉換器基類
• 添加轉換器到默認的轉換器字典中
• 使用自定義轉換器實現自定義匹配規則

代碼實現

• 導入轉換器基類

from werkzeug.routing import BaseConverter 

• 自定義轉換器

# 自定義正則轉換器 class RegexConverter(BaseConverter): def __init__(self, url_map, *args): super(RegexConverter, self).__init__(url_map) # 將接受的第1個參數當作匹配規則進行保存 self.regex = args[0] 

• 添加轉換器到默認的轉換器字典中，並指定轉換器使用時名字為: re

app = Flask(__name__)

# 將自定義轉換器添加到轉換器字典中，並指定轉換器使用時名字為: re app.url_map.converters['re'] = RegexConverter 

• 使用轉換器去實現自定義匹配規則
  • 當前此處定義的規則是：3位數字

@app.route('/user/<re("[0-9]{3}"):user_id>') def user_info(user_id): return "user_id 為 %s" % user_id 

運行測試：http://127.0.0.1:5000/user/123 ，如果訪問的url不符合規則，會提示找不到頁面

自定義轉換器其他兩個函數實現

繼承於自定義轉換器之后，還可以實現 to_python 和 to_url 這兩個函數去對匹配參數做進一步處理：

• to_python：
  • 該函數參數中的 value 值代表匹配到的值，可輸出進行查看
  • 匹配完成之后，對匹配到的參數作最后一步處理再返回，比如：轉成 int 類型的值再返回：

class RegexConverter(BaseConverter): def __init__(self, url_map, *args): super(RegexConverter, self).__init__(url_map) # 將接受的第1個參數當作匹配規則進行保存 self.regex = args[0] def to_python(self, value): return int(value) 

運行測試，在視圖函數中可以查看參數的類型，由之前默認的 str 已變成 int 類型的值

• to_url:
  • 在使用 url_for 去獲取視圖函數所對應的 url 的時候，會調用此方法對 url_for 后面傳入的視圖函數參數做進一步處理
  • 具體可參見 Flask 的 app.py 中寫的示例代碼：ListConverter

系統自帶轉換器

DEFAULT_CONVERTERS = {
    'default': UnicodeConverter, 'string': UnicodeConverter, 'any': AnyConverter, 'path': PathConverter, 'int': IntegerConverter, 'float': FloatConverter, 'uuid': UUIDConverter, }
系統自帶的轉換器具體使用方式在每種轉換器的注釋代碼中有寫，請留意每種轉換器初始化的參數。 

異常捕獲

HTTP 異常主動拋出

• abort 方法
  • 拋出一個給定狀態代碼的 HTTPException 或者 指定響應，例如想要用一個頁面未找到異常來終止請求，你可以調用 abort(404)。
• 參數：
  • code – HTTP的錯誤狀態碼

# abort(404) abort(500) 

拋出狀態碼的話，只能拋出 HTTP 協議的錯誤狀態碼

 

捕獲錯誤

• errorhandler 裝飾器
  • 注冊一個錯誤處理程序，當程序拋出指定錯誤狀態碼的時候，就會調用該裝飾器所裝飾的方法
• 參數：
  • code_or_exception – HTTP的錯誤狀態碼或指定異常
• 例如統一處理狀態碼為500的錯誤給用戶友好的提示：

@app.errorhandler(500) def internal_server_error(e): return '服務器搬家了' 

• 捕獲指定異常

@app.errorhandler(ZeroDivisionError) def zero_division_error(e): return '除數不能為0'

可以全局捕獲404錯誤,返回渲染的404頁面.

請求勾子(相當於Django中的中間件)

在客戶端和服務器交互的過程中，有些准備工作或掃尾工作需要處理，比如：

• 在請求開始時，建立數據庫連接；
• 在請求開始時，根據需求進行權限校驗；
• 在請求結束時，指定數據的交互格式；

為了讓每個視圖函數避免編寫重復功能的代碼，Flask提供了通用設施的功能，即請求鈎子。

請求鈎子是通過裝飾器的形式實現，Flask支持如下四種請求鈎子：

• before_first_request
  • 在處理第一個請求前執行
• before_request
  • 在每次請求前執行
  • 如果在某修飾的函數中返回了一個響應，視圖函數將不再被調用
• after_request
  • 如果沒有拋出錯誤，在每次請求后執行
  • 接受一個參數：視圖函數作出的響應
  • 在此函數中可以對響應值在返回之前做最后一步修改處理
  • 需要將參數中的響應在此參數中進行返回
• teardown_request：
  • 在每次請求后執行
  • 接受一個參數：錯誤信息，如果有相關錯誤拋出

代碼測試

from flask import Flask from flask import abort app = Flask(__name__) # 在第一次請求之前調用，可以在此方法內部做一些初始化操作 @app.before_first_request def before_first_request(): print("before_first_request") # 在每一次請求之前調用，這時候已經有請求了，可能在這個方法里面做請求的校驗 # 如果請求的校驗不成功，可以直接在此方法中進行響應，直接return之后那么就不會執行視圖函數 @app.before_request def before_request(): print("before_request") # if 請求不符合條件: # return "laowang" # 在執行完視圖函數之后會調用，並且會把視圖函數所生成的響應傳入,可以在此方法中對響應做最后一步統一的處理 @app.after_request def after_request(response): print("after_request") response.headers["Content-Type"] = "application/json" return response # 請每一次請求之后都會調用，會接受一個參數，參數是服務器出現的錯誤信息 @app.teardown_request def teardown_request(e): print("teardown_request") @app.route('/') def index(): return 'index' if __name__ == '__main__': app.run(debug=True) 

• 在第1次請求時的打印：

before_first_request
before_request
after_request
teardown_request

• 在第2次請求時的打印：

before_request
after_request
teardown_request