一、請求鉤子 在客戶端和伺服器交互的過程中,有些準備工作或稍微工作是需要處理的,比如:在請求開始時,建立資料庫連接;在請求開始時,根據需求進行許可權校驗;在請求結束時,指定數據的交互格式等。為了讓每個視圖函數避免編寫重覆功能的代碼,flask提供了通用設施的功能,即請求鉤子。 例子: 運行結果: 第1 ...
一、請求鉤子
在客戶端和伺服器交互的過程中,有些準備工作或稍微工作是需要處理的,比如:在請求開始時,建立資料庫連接;在請求開始時,根據需求進行許可權校驗;在請求結束時,指定數據的交互格式等。為了讓每個視圖函數避免編寫重覆功能的代碼,flask提供了通用設施的功能,即請求鉤子。
請求鉤子是通過裝飾器的形式實現,Flask支持如下四種請求鉤子: - before_first_request - 在處理第一個請求前執行 - before_request - 在每次請求前執行 - 如果在某修飾的函數中返回了一個響應,視圖函數將不再被調用 - after_request - 如果沒有拋出錯誤,在每次請求後執行 - 接受一個參數:視圖函數作出的響應 - 在此函數中可以對響應值在返回之前做最後一步修改處理 - 需要將參數中的響應在此參數中進行返回 - teardown_request: - 在每次請求後執行 - 接受一個參數:錯誤信息,如果有相關錯誤拋出
例子:
from flask import Flask from settings.dev import DevConfig app = Flask(__name__) # 項目配置 app.config.from_object(DevConfig) @app.before_first_request def before_first_request(): print("----before_first_request----") print("系統初始化的時候,執行這個鉤子方法") print("會在接收到第一個客戶端請求時,執行這裡的代碼") @app.before_request def before_request(): print("----before_request----") print("每一次接收到客戶端請求時,執行這個鉤子方法") print("一般可以用來判斷許可權,或者轉換路由參數或者預處理客戶端請求的數據") @app.after_request def after_request(response): print("----after_request----") print("在處理請求以後,執行這個鉤子方法") print("一般可以用於記錄會員/管理員的操作歷史,瀏覽歷史,清理收尾的工作") response.headers["Content-Type"] = "application/json" # 必須返回response參數 return response @app.teardown_request def teardown_request(exc): print("----teardown_request----") print("在每一次請求以後,執行這個鉤子方法,如果有異常錯誤,則會傳遞錯誤異常對象到當前方法的參數中") print(exc) @app.route("/") def index(): print("----視圖函數----") print("視圖函數被運行了") return "視圖函數被運行了<br>" if __name__ == '__main__': app.run(host="0.0.0.0", port=80)
運行結果:
第1次請求時結果:
----before_first_request---- 系統初始化的時候,執行這個鉤子方法 會在接收到第一個客戶端請求時,執行這裡的代碼 ----before_request---- 每一次接收到客戶端請求時,執行這個鉤子方法 一般可以用來判斷許可權,或者轉換路由參數或者預處理客戶端請求的數據 ----視圖函數---- 視圖函數被運行了 ----after_request---- 在處理請求以後,執行這個鉤子方法 一般可以用於記錄會員/管理員的操作歷史,瀏覽歷史,清理收尾的工作 ----teardown_request---- 在每一次請求以後,執行這個鉤子方法,如果有異常錯誤,則會傳遞錯誤異常對象到當前方法的參數中 None
第2次請求時的結果:
----before_request---- 127.0.0.1 - - [08/Apr/2019 09:23:53] "GET / HTTP/1.1" 200 - 每一次接收到客戶端請求時,執行這個鉤子方法 一般可以用來判斷許可權,或者轉換路由參數或者預處理客戶端請求的數據 ----視圖函數---- 視圖函數被運行了 ----after_request---- 在處理請求以後,執行這個鉤子方法 一般可以用於記錄會員/管理員的操作歷史,瀏覽歷史,清理收尾的工作 ----teardown_request---- 在每一次請求以後,執行這個鉤子方法,如果有異常錯誤,則會傳遞錯誤異常對象到當前方法的參數中 None
二、異常捕獲
1,拋http異常
abort方法:拋出一個給定狀態代碼的HTTPException或者指定響應
abort(500)
2,捕獲錯誤
errorhandler 裝飾器:註冊一個錯誤處理程式,當程式拋出指定錯誤狀態碼的時候,就會調用該裝飾器所裝飾的方法 參數:錯誤狀態碼和指定異常 處理錯誤狀態碼為500的,自定義返回內容,如果不做這步,就返回自帶的異常模板 @app.errorhandler(500) def internal_server_error(e): return '伺服器出問題了' 處理指定異常,如ZeroDivisionError,除數為0的異常 @app.errorhandler(ZeroDivisionError) def zero_division_error(e): return '除數不能為0'
三、上下文
上下文:即語境,語意,在程式中可以理解為在代碼執行到某一時刻時,根據之前代碼所做的操作以及下文即將要執行的邏輯,可以決定在當前時刻下可以使用到的變數,或者可以完成的事情。 Flask中有兩種上下文,請求上下文(request context)和應用上下文(application context)。 Flask中上下文對象:相當於一個容器,保存了 Flask 程式運行過程中的一些信息。 1. *application* 指的就是當你調用`app = Flask(__name__)`創建的這個對象`app`; 2. *request* 指的是每次`http`請求發生時,`WSGI server`(比如gunicorn)調用`Flask.__call__()`之後,在`Flask`對象內部創建的`Request`對象; 3. *application* 表示用於響應WSGI請求的應用本身,*request* 表示每次http請求; 4. *application*的生命周期大於*request*,一個*application*存活期間,可能發生多次http請求,所以,也就會有多個*request*
1,請求上下文(request context)
在 flask 中,可以直接在視圖函數中使用 **request** 這個對象進行獲取相關數據,而 **request** 就是請求上下文的對象,保存了當前本次請求的相關數據,請求上下文對象有:request、session - request: 封裝了HTTP請求的內容,針對的是http請求。舉例:user = request.args.get('user'),獲取的是get請求的參數。 - session:用來記錄請求會話中的信息,針對的是用戶信息。舉例:session['name'] = user.id,可以記錄用戶信息。還可以通過session.get('name')獲取用戶信息
2,應用上下文(application context)
它的字面意思是 應用上下文,但它不是一直存在的,它只是request context 中的一個對 app 的代理(人),所謂local proxy。它的作用主要是幫助 request 獲取當前的應用,它是伴 request 而生,隨 request 而滅的。
應用上下文對象有:current_app,g
2.1 current_app
應用程式上下文,用於存儲應用程式中的變數,可以通過current_app.name列印當前app的名稱,也可以在current_app中存儲一些變數,例如: - 應用的啟動腳本是哪個文件,啟動時指定了哪些參數 - 載入了哪些配置文件,導入了哪些配置 - 連接了哪個資料庫 - 有哪些可以調用的工具類、常量 - 當前flask應用在哪個機器上,哪個IP上運行,記憶體多大 current_app.name current_app.test_value='value'
2.2 g變數
g 作為 flask 程式全局的一個臨時變數,充當者中間媒介的作用,我們可以通過它傳遞一些數據,
g 保存的是當前請求的全局變數,不同的請求會有不同的全局變數,通過不同的thread id區別 g.name='abc'
3,兩者的區別
- 請求上下文:保存了客戶端和伺服器交互的數據
- 應用上下文:flask 應用程式運行過程中,保存的一些配置信息,比如程式名、資料庫連接、應用信息等
四、Flask-Script擴展
1,安裝
在flask_demo的虛擬環境中輸入:pip install flask-script
2,集成Flask-Script到flask應用中
from flask import Flask from flask_script import Manager app = Flask(__name__) # 把 Manager 類和應用程式實例進行關聯 manager = Manager(app) @app.route('/') def index(): return 'hello world' if __name__ == "__main__": manager.run()
3,flask-Script可以為當前應用程式添加腳本命令
class hello(Command): "prints hello world" def run(self): print("hello world") manager.add_command('hello', hello())
五、Jinja2模板引擎
Flask內置的模板語言,它的設計思想來源於Django的模板引擎,並擴展了其語法和一系列強大的功能。
渲染模板函數:
flask提供的render_template函數封裝了該模板引擎
render_tempalte函數的第一個參數是模板的文件名,後面的參數都是鍵值對,表示模板中變數對應的真實值。
1,模板的基本使用
from flask import Flask, render_template,g from settings.dev import DevConfig app = Flask(__name__,template_folder="templates",static_folder='static') app.config.from_object(DevConfig) def func(): return "hello, func" @app.route("/") def index(): g.name="首頁" dict1 = { "username":"xiaohui", "age":22, "sex":2, } list1 = ["張三","李四","王五"] return render_template("index.html",title = "我的flask網頁",dict1=dict1,list1=list1,func=func) if __name__ == '__main__': app.run(host="0.0.0.0", port=80)
index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> 我的模板html內容 {{list1}} #這是變數代碼塊,裡面放視圖傳遞的變數 {% if %} #這是控制代碼塊,裡面放if,for等邏輯語句。這兩種模板語法使用和django中一模一樣 </body> </html>
2,特有的變數和函數
可以在模板中使用flask預設的內置函數和對象
2.1 config
可以直接訪問flask當前的config對象
{{config.SQLALCHEMY_DATABASE_URI}}
2.2 request
flask中當前請求的request對象
{{request.url}}
2.3 session對象
flask的session對象
{{session.new}}
2.4 g變數
在視圖函數中設置g變數的 name 屬性的值,然後在模板中直接可以取出
{{ g.name }}
2.5 url_for()
url_for會根據傳入的路由器函數名,返回該路由對應的URL,在模板中始終使用url_for()就可以安全的修改路由綁定的URL,則不比擔心模板中渲染出錯的鏈接:
{{url_for('home')}}
當url帶參數時:
{{ url_for('post', post_id=1)}}
3,流程式控制制
3.1 if語句
{%if user.is_logged_in() %} <a href='/logout'>Logout</a> {% else %} <a href='/login'>Login</a> {% endif %}
3.2 for語句
{% for post in posts %} <div> <h1>{{ post.title }}</h1> <p>{{ post.text | safe }}</p> </div> {% endfor %}
for迴圈中可以使用特殊的變數
loop.index當前迴圈迭代的次數(從 1 開始)
loop.index0當前迴圈迭代的次數(從 0 開始)
loop.revindex到迴圈結束需要迭代的次數(從 1 開始)
loop.revindex0到迴圈結束需要迭代的次數(從 0 開始)
loop.first如果是第一次迭代,為 True 。
loop.last如果是最後一次迭代,為 True 。
loop.length序列中的項目數。
loop.cycle在一串序列間期取值的輔助函數。見下麵示常式序。
{% for post in posts%}
{{loop.index}}, {{post.title}}
{% endfor %}
for迴圈和if語句嵌套
{% for post in posts if post.text %} <div> <h1>{{ post.title }}</h1> <p>{{ post.text | safe }}</p> </div> {% endfor %}
4,過濾器
過濾器的本質就是函數。有時候我們不僅僅只是需要輸出變數的值,我們還需要修改變數的顯示,甚至格式化、運算等等,
而在模板中是不能直接調用 Python 中的某些方法,那麼這就用到了過濾器。
過濾器的使用方式為:變數名 | 過濾器
{{variable | filter_name(*args)}}
如果沒有任何參數傳給過濾器,則可以把括弧省略掉
{{variable | filter_name }}
在 jinja2 中,過濾器是可以支持鏈式調用的,示例如下:
{{ "hello world" | reverse | upper }}
4.1字元串操作
safe:禁用轉義 <p>{{ '<em>hello</em>' | safe }}</p> capitalize:把變數值的首字母轉成大寫,其餘字母轉小寫 <p>{{ 'hello' | capitalize }}</p> lower:把值轉成小寫 <p>{{ 'HELLO' | lower }}</p> upper:把值轉成大寫 <p>{{ 'hello' | upper }}</p> title:把值中的每個單詞的首字母都轉成大寫 <p>{{ 'hello' | title }}</p> reverse:字元串反轉 <p>{{ 'olleh' | reverse }}</p> format:格式化輸出 <p>{{ '%s is %d' | format('name',17) }}</p> striptags:渲染之前把值中所有的HTML標簽都刪掉 <p>{{ '<em>hello</em>' | striptags }}</p> truncate: 字元串截斷 <p>{{ 'hello every one' | truncate(9)}}</p>
4.2 列表操作
first:取第一個元素 <p>{{ [1,2,3,4,5,6] | first }}</p> last:取最後一個元素 <p>{{ [1,2,3,4,5,6] | last }}</p> length:獲取列表長度 <p>{{ [1,2,3,4,5,6] | length }}</p> sum:列表求和 <p>{{ [1,2,3,4,5,6] | sum }}</p> sort:列表排序 <p>{{ [6,2,3,1,5,4] | sort }}</p>
4.3 自定義過濾器
過濾器的本質是函數。當模板內置的過濾器不能滿足需求,可以自定義過濾器。自定義過濾器有兩種實現方式:
- 一種是通過Flask應用對象的 **add_template_filter** 方法
- 通過裝飾器來實現自定義過濾器
**重要:自定義的過濾器名稱如果和內置的過濾器重名,會覆蓋內置的過濾器。**
添加列表反轉的過濾器:方法一
通過調用應用程式實例的 add_template_filter 方法實現自定義過濾器。該方法第一個參數是函數名,第二個參數是自定義的過濾器名稱:
def do_listreverse(li):
# 通過原列表創建一個新列表
temp_li = list(li)
# 將新列表進行返轉
temp_li.reverse()
return temp_li
app.add_template_filter(do_listreverse,'lireverse')
方法二:
用裝飾器來實現自定義過濾器。裝飾器傳入的參數是自定義的過濾器名稱。
@app.template_filter('lireverse')
def do_listreverse(li):
# 通過原列表創建一個新列表
temp_li = list(li)
# 將新列表進行返轉
temp_li.reverse()
return temp_li
5,模板繼承
和django中使用方法一樣,用extends
{% extends 'base.html' %}
{% block content %}
需要填充的內容
{% endblock content %}
六、Flask中加CSRF
設置應用程式的 secret_key,用於加密生成的 csrf_token 的值 app.secret_key = "#此處可以寫隨機字元串#" 導入 flask_wtf.csrf 中的 CSRFProtect 類,進行初始化,併在初始化的時候關聯 app from flask.ext.wtf import CSRFProtect CSRFProtect(app) 在表單中使用 CSRF 令牌: <form method="post" action="/"> <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" /> </form>