Tornado框架05-輸入和輸出,接口調用順序

01-利用HTTP協議向服務器傳參幾種途徑

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

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

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

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

02-獲取查詢字符串參數

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同前,不再贅述。

03-獲取請求體參數

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的,無法通過這兩個方法獲取。

04-前兩類方法的整合

get_argument(name, default=_ARG_DEFAULT, strip=True)

從請求體和查詢字符串中返回指定參數name的值,如果出現多個同名參數,則返回最後一個的值。

default與strip同前,不再贅述。

get_arguments(name, strip=True)

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

strip同前,不再贅述。

說明

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

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

05-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”]。

06-正則提取uri

tornado中對於路由映射也支持正則提取uri,提取出來的參數會作爲RequestHandler中對應請求方式的成員方法參數。

若在正則表達式中定義了名字,則參數按名傳遞;

若未定義名字,則參數按順序傳遞。
提取出來的參數會作爲對應請求方式的成員方法的參數。

define("port", default=8000, type=int, help="run server on the given port.")

class IndexHandler(RequestHandler):
    def get(self):
        self.write("hello qianfeng.")

class SubjectCityHandler(RequestHandler):
    def get(self, subject, city):
        self.write(("Subject: %s<br/>City: %s" % (subject, city)))

class SubjectDateHandler(RequestHandler):
    def get(self, date, subject):
        self.write(("Date: %s<br/>Subject: %s" % (date, subject)))

if __name__ == "__main__":
    tornado.options.parse_command_line()
    app = tornado.web.Application([
        (r"/", IndexHandler),
        (r"/sub-city/(.+)/([a-z]+)", SubjectCityHandler), # 無名方式
        (r"/sub-date/(?P<subject>.+)/(?P<date>\d+)", SubjectDateHandler), # 命名方式
    ])
    http_server = tornado.httpserver.HTTPServer(app)
    http_server.listen(options.port)
    tornado.ioloop.IOLoop.current().start()

建議:提取多個值時最好用命名方式。

07-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。

08-set_header(name, value)屬性

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

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

09-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。

class LoginHandler(RequestHandler):
    """對應/login"""
    def get(self):
        self.write('<form method="post"><input type="submit" value="登陸"></form>')

    def post(self):
        self.redirect("/")

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()
發佈了48 篇原創文章 · 獲贊 4 · 訪問量 3萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章