05tornado知識點(diǎn)四

RequestHandler

一、利用HTTP協(xié)議向服務(wù)器傳參幾種途徑

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

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

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

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

2,獲取查詢字符串參數(shù)

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

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

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

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

strip同前,不再贅述。

3,獲取請求體參數(shù)

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

default與strip同前,不再贅述。

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

strip同前,不再贅述。

說明

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

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

4,前兩類方法的整合

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

default與strip同前,不再贅述。

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

strip同前,不再贅述。

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

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

5,requestHandler.request請求信息

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

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

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

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

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

  1. 正則提取uri

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

7,write方法

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

想一想,如何利用write方法寫json數(shù)據(jù)?

import json

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

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

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

兩種方式有什么差異?

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

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

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

8,set_header(name, value)屬性

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

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

9, set_default_headers()方法

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

class IndexHandler(RequestHandler):

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

    def get(self):
        print "執(zhí)行了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()方法中設(shè)置的同名header。

10,set_status(status_code, reason=None)

為響應(yīng)設(shè)置狀態(tài)碼。

status_code int類型,狀態(tài)碼

reason string類型,描述狀態(tài)碼的詞組,若為None,則會被自動填充為標(biāo)準(zhǔn)的狀態(tài)碼。

非標(biāo)準(zhǔn)狀態(tài)碼
self.set_status(210, "python error") # 非標(biāo)準(zhǔn)狀態(tài)碼,必須設(shè)置了reason。否則報(bào)錯

11,redirect(url)

告知瀏覽器重定向到url。

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

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

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

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

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

13,write_error(status_code, **kwargs)

用來處理send_error拋出的錯誤信息并返回給瀏覽器錯誤信息頁面??梢灾貙懘朔椒▉矶ㄖ谱约旱腻e誤顯示頁面。

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,接口與調(diào)用順序

class IndexHandler(RequestHandler):

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

    def set_default_headers(self):
        print "調(diào)用了set_default_headers()"

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

    def get(self):
        print "調(diào)用了get()"

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

在正常情況未拋出錯誤時,調(diào)用順序?yàn)椋?/p>

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

在有錯誤拋出時,調(diào)用順序?yàn)椋?/p>

set_default_headers()
initialize()
prepare()

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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容