05tornado知識點四

RequestHandler

一、利用HTTP協議向服務器傳參幾種途徑

1,查詢字符串(query string),形如key1=value1&key2=value2;

2,請求體(body)中發送的數據,比如表單數據、json、xml;

3,提取uri的特定部分,如/blogs/2016/09/0001,可以在服務器端的路由中用正則表達式截取;

4,在http報文的頭(header)中增加自定義字段,如X-XSRFToken=xiaoke

2,獲取查詢字符串參數

get_query_argument(name, default=_ARG_DEFAULT, strip=True)
從請求的查詢字符串中返回指定參數name的值,如果出現多個同名參數,則返回最后一個的值。

default為設值未傳name參數時返回的默認值,如若default也未設置,則會拋出tornado.web.MissingArgumentError異常。

strip表示是否過濾掉左右兩邊的空白字符,默認為過濾。

get_query_arguments(name, strip=True)
從請求的查詢字符串中返回指定參數name的值,注意返回的是list列表(即使對應name參數只有一個值)。若未找到name參數,則返回空列表[]。

strip同前,不再贅述。

3,獲取請求體參數

get_body_argument(name, default=_ARG_DEFAULT, strip=True)
從請求體中返回指定參數name的值,如果出現多個同名參數,則返回最后一個的值。

default與strip同前,不再贅述。

get_body_arguments(name, strip=True)
從請求體中返回指定參數name的值,注意返回的是list列表(即使對應name參數只有一個值)。若未找到name參數,則返回空列表[]。

strip同前,不再贅述。

說明

對于請求體中的數據要求為字符串,且格式為表單編碼格式(與url中的請求字符串格式相同),即key1=value1&key2=value2,HTTP報文頭Header中的"Content-Type"為application/x-www-form-urlencoded 或 multipart/form-data。

對于請求體數據為json或xml的,無法通過這兩個方法獲取。

4,前兩類方法的整合

get_argument(name, default=_ARG_DEFAULT, strip=True)
從請求體和查詢字符串中返回指定參數name的值,如果出現多個同名參數,則返回最后一個的值。

default與strip同前,不再贅述。

get_arguments(name, strip=True)
從請求體和查詢字符串中返回指定參數name的值,注意返回的是list列表(即使對應name參數只有一個值)。若未找到name參數,則返回空列表[]。

strip同前,不再贅述。

說明
對于請求體中數據的要求同前。 這兩個方法最常用。

注意:以上方法返回的都是unicode字符串

5,requestHandler.request請求信息

RequestHandler.request 對象存儲了關于請求的相關信息,具體屬性有:

method HTTP的請求方式,如GET或POST;
host 被請求的主機名;
uri 請求的完整資源標示,包括路徑和查詢字符串;
path 請求的路徑部分;
query 請求的查詢字符串部分;
version 使用的HTTP版本;
headers 請求的協議頭,是類字典型的對象,支持關鍵字索引的方式獲取特定協議頭信息,例如:request.headers["Content-Type"]
body 請求體數據;
remote_ip 客戶端的IP地址;
files 用戶上傳的文件,為字典類型,型如:

{
  "form_filename1":[<tornado.httputil.HTTPFile>, <tornado.httputil.HTTPFile>],
  
  "form_filename2":[<tornado.httputil.HTTPFile>,],
  ...
}

tornado.httputil.HTTPFile是接收到的文件對象,它有三個屬性:

filename 文件的實際名字,與form_filename1不同,字典中的鍵名代表的是表單對應項的名字;
body 文件的數據實體;
content_type 文件的類型。
這三個對象屬性可以像字典一樣支持關鍵字索引,如request.files["form_filename1"][0]["body"]。

  1. 正則提取uri

tornado中對于路由映射也支持正則提取uri,提取出來的參數會作為RequestHandler中對應請求方式的成員方法參數。
若在正則表達式中定義了名字,則參數按名傳遞;
若未定義名字,則參數按順序傳遞。
提取出來的參數會作為對應請求方式的成員方法的參數。

7,write方法

write方法是寫到緩沖區的,我們可以像寫文件一樣多次使用write方法不斷追加響應內容,最終所有寫到緩沖區的內容一起作為本次請求的響應輸出。

想一想,如何利用write方法寫json數據?

import json

class IndexHandler(RequestHandler):
    def get(self):
        stu = {
            "name":"zhangsan",
            "age":24,
            "gender":1,
        }
        stu_json = json.dumps(stu)
        self.write(stu_json)

實際上,我們可以不用自己手動去做json序列化,當write方法檢測到我們傳入的chunk參數是字典類型后,會自動幫我們轉換為json字符串。

class IndexHandler(RequestHandler):
    def get(self):
        stu = {
            "name":"zhangsan",
            "age":24,
            "gender":1,
        }
        self.write(stu)

兩種方式有什么差異?

對比一下兩種方式的響應頭header中Content-Type字段,自己手動序列化時為Content-Type:text/html; charset=UTF-8,

而采用write方法時為Content-Type:application/json; charset=UTF-8。

write方法除了幫我們將字典轉換為json字符串之外
還幫我們將Content-Type設置為application/json; charset=UTF-8。

8,set_header(name, value)屬性

利用set_header(name, value)方法,可以手動設置一個名為name、值為value的響應頭header字段。
例如:

  self.set_header("Content-Type", "application/json; charset=UTF-8")

9, set_default_headers()方法

該方法會在進入HTTP處理方法前先被調用,可以重寫此方法來預先設置默認的headers。
注意:在HTTP處理方法中使用set_header()方法會覆蓋掉在set_default_headers()方法中設置的同名header。

class IndexHandler(RequestHandler):

    def set_default_headers(self):
        print "執行了set_default_headers()"
        # 設置get與post方式的默認響應體格式為json
        self.set_header("Content-Type", "application/json; charset=UTF-8")
        # 設置一個名為name、值為python的header
        self.set_header("name", "python")

    def get(self):
        print "執行了get()"
        stu = {
            "name":"zhangsan",
            "age":24,
            "gender":1,
        }
        stu_json = json.dumps(stu)
        self.write(stu_json)
        self.set_header("name", "i love python") # 注意此處重寫了header中的name字段,會覆蓋掉在set_default_headers()方法中設置的同名header。

10,set_status(status_code, reason=None)

為響應設置狀態碼。

status_code int類型,狀態碼

reason string類型,描述狀態碼的詞組,若為None,則會被自動填充為標準的狀態碼。

非標準狀態碼
self.set_status(210, "python error") # 非標準狀態碼,必須設置了reason。否則報錯

11,redirect(url)

告知瀏覽器重定向到url。

12, send_error(status_code=500, **kwargs)

拋出HTTP錯誤狀態碼status_code,默認為500,kwargs為可變命名參數。使用send_error拋出錯誤后tornado會調用write_error()方法進行處理,并返回給瀏覽器處理后的錯誤頁面。

class IndexHandler(RequestHandler):
    def get(self):
        self.write("主頁")
        self.send_error(404, content="出現404錯誤")

注意:
1,默認的write_error()方法不會處理send_error拋出的kwargs參數,即上面的代碼中content="出現404錯誤"是沒有意義的。要想處理這個錯誤信息,必須重寫write_error()方法

2,使用send_error()方法后就不要再使用self.write(),再向輸出緩沖區寫內容了!

13,write_error(status_code, **kwargs)

用來處理send_error拋出的錯誤信息并返回給瀏覽器錯誤信息頁面。可以重寫此方法來定制自己的錯誤顯示頁面。

class IndexHandler(RequestHandler):
    def get(self):
        err_code = self.get_argument("code", None) # 注意返回的是unicode字符串,下同
        err_title = self.get_argument("title", "")
        err_content = self.get_argument("content", "")
        
        if err_code:
            self.send_error(err_code, title=err_title, content=err_content)
        else:
            self.write("主頁")

    def write_error(self, status_code, **kwargs):
        self.write(u"<h1>出錯了,程序員GG正在趕過來!</h1>")
        self.write(u"<p>錯誤名:%s</p>" % kwargs["title"])
        self.write(u"<p>錯誤詳情:%s</p>" % kwargs["content"])

14,接口與調用順序

class IndexHandler(RequestHandler):

    # 對應每個請求的處理類Handler在構造一個實例后首先執行initialize()方法。
    #路由映射中的第三個字典型參數會作為該方法的命名參數傳遞,
    #作用:初始化參數(對象屬性)
    def initialize(self):
        print "調用了initialize()"
        
    # 預處理,即在執行對應請求方式的HTTP方法(如get、post等)前先執行,
    #注意:不論以何種HTTP方式請求,都會執行prepare()方法。
    def prepare(self):
        print "調用了prepare()"

    def set_default_headers(self):
        print "調用了set_default_headers()"

    def write_error(self, status_code, **kwargs):
        print "調用了write_error()"

    def get(self):
        print "調用了get()"

    def post(self):
        print "調用了post()"
        self.send_error(200)  # 注意此出拋出了錯誤
        
    # 在請求處理結束后調用,即在調用HTTP方法后調用。
    #通常該方法用來進行資源清理釋放或處理日志等。
    #注意:請盡量不要在此方法中進行響應輸出。
    def on_finish(self):
        print "調用了on_finish()"

在正常情況未拋出錯誤時,調用順序為:

set_defautl_headers()
initialize()
prepare()
HTTP方法(get或post方法)
on_finish()

在有錯誤拋出時,調用順序為:

set_default_headers()
initialize()
prepare()

HTTP方法
set_default_headers()
write_error()
on_finish()

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,533評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,055評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,365評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,561評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,346評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,889評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,978評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,118評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,637評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,558評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,739評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,246評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,980評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,619評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,347評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,702評論 2 370

推薦閱讀更多精彩內容