Tornado架構知識系列之五

RequestHandler

1，利用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”]。

6. 正則提取uri

tornado中對于路由映射也支援正則提取uri，提取出來的參數會作為RequestHandler中對應請求方式的成員方法參數。

若在正規表達式中定義了名字，則參數按名傳遞；

若未定義名字，則參數按順序傳遞。

提取出來的參數會作為對應請求方式的成員方法的參數。

7，write方法

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

想一想，如何利用write方法寫json資料？

import json

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

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

class IndexHandler(RequestHandler):
    def get(self):
        stu = {
            "name":"zhangsan",
            "age":,
            "gender":,
        }
        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":,
            "gender":,
        }
        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(, 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()  # 注意此出抛出了錯誤

    # 在請求處理結束後調用，即在調用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()