Tornado框架簡介（二）

--------------------Application--------------------

一、settings

    一、debug=True：，設置tornado是否工做在調試模式，默認爲False即工做在生產模式。當設置debug=True 後，tornado會工做在調試/開發模式，在此種模式下，能夠根據設置修改tornado提供的其餘幾種特性

 

    二、autoreload=True：自動重啓，tornado應用會監控咱們的源代碼文件，當有改動保存後便會重啓程序，這能夠減小咱們手動重啓程序的次數。須要注意的是，一旦咱們保存的更改有錯誤，自動重啓會致使程序報錯而退出，從而須要咱們保存修正錯誤後手動啓動程序。

 

    三、compiled_templite_carch = False：取消緩存編譯的模板

 

    四、static_hash_cache = False：取消緩存靜態文件hash值

 

    五、server_traceback = True：提供追蹤信息，當RequestHandler或者其子類拋出一個異常而未被捕獲後，會生成一個包含追蹤信息的頁面

 

    六、

        import tornado.web

        app = tornado.web.Application([],debug=True)

 

二、路由映射

    一、Application中列表中的信息

        app = tornado.web.Application([

            (r"/", Indexhandler),

            (r"/cpp", SubjectHandler, {"subject":"c++"}),

            url(r"/python", StaticFileHandler, {"subject":"python"}, name="static_url")

        ],

        debug = True

        )

 

    二、對於路由中的字典，會傳入到對應的RequestHandler的initialize()方法中。

        from tornado.web import RequestHandler

 

        class StaticFileHandler(RequestHandler):

            def initialize(self):

                self.subject = subject

 

            def get(self):

                self.write(self.subject)

 

 

    三、對於路由中的name字段，注意此時不能再使用元組，而應使用tornado.web.url來構建。name是給該路由起一個名字，能夠經過調用RequestHandler.reverse_url(name)來獲取該名子對應的url。

        def get(self):

            self.write("<a href="+RequestHandler.reverse_url('static_url')+"></a>")

 

 

--------------------輸入--------------------

一、獲取查詢字符串參數

    一、get_query_argument(name,default=_ARG_DEFAULT,strip=True)

        一、name：從請求的查詢字符串中返回指定參數name的值，若是出現多個同名參數，則返回最後一個的值。

 

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

 

        三、strip：表示是否過濾掉左右兩邊的空白字符，默認爲過濾。

 

    二、get_query_arguments(name,strip=True)

        一、從請求的查詢字符串中返回指定參數name的值，注意返回的是list列表（即便對應name參數只有一個值）。若未找到name參數，則返回空列表[]。

 

二、獲取請求體參數

    一、get_body_argument(name,default=_ARG_DEFAULT,strip=True)

        從請求體中返回指定參數name的值，若是出現多個同名參數，則返回最後一個的值。

 

    二、get_body_argument(name,strip=True)

        從請求體中返回指定參數name的值，注意返回的是list列表（即便對應name參數只有一個值）。若未找到name參數，則返回空列表[]。

 

三、前兩類方法的整合

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

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

 

    二、get_argument(name,strip=True)

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

 

四、關於請求的其餘信息

    RequestHandler.request 對象存儲了關於請求的相關信息，具體屬性有：

        一、method HTTP的請求方式，如GET或POST;

 

        二、host 被請求的主機名；

 

        三、uri 請求的完整資源標示，包括路徑和查詢字符串；

 

        四、path 請求的路徑部分；

 

        五、query 請求的查詢字符串部分；

 

        六、version 使用的HTTP版本；

 

        七、headers 請求的協議頭，是類字典型的對象，支持關鍵字索引的方式獲取特定協議頭信息

            一、request.headers["Content-Type"]

 

        八、body 請求體數據；

 

        九、remote_ip 客戶端的IP地址；

 

        十、files 用戶上傳的文件，爲字典類型

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

            一、filename 文件的實際名字，與form_filename1不一樣，字典中的鍵名錶明的是表單對應項的名字；

 

            二、body 文件的數據實體；

 

            三、content_type 文件的類型。 這三個對象屬性能夠像字典同樣支持關鍵字索引，

                request.files["form_filename1"][0]["body"]。

 

五、正則提取uri

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

 

        (r"/sub-city/(.+)/([a-z]+)", SubjectCityHandler), # 無名方式

        (r"/sub-date/(?P<subject>.+)/(?P<date>\d+)", SubjectDateHandler), #　命名方式

 

        class SubjectCityHandler(RequestHandler):

            def get(self, subject, city):

                self.write(("Subject: %s<br/>City: %s" % (subject, city)))

 

 

--------------------輸出--------------------

一、write(chunk)

    class IndexHandler(RequestHandler):

        def get(self):

            self.write("hello itcast!")

 

二、set_header(name, value)

    利用set_header(name, value)方法，能夠手動設置一個名爲name、值爲value的響應頭header字段

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

 

三、set_default_headers()

    該方法會在進入HTTP處理方法前先被調用，能夠重寫此方法來預先設置默認的headers

    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")

            # 設置一個名爲webServer、值爲Hello的header

            self.set_header("webServer", "Hello")

 

四、set_status(status_code, reason=None)

    一、status_code int類型，狀態碼，若reason爲None，則狀態碼必須爲下表中的。

 

    二、reason string類型，描述狀態碼的詞組，若爲None，則會被自動填充爲下表中的內容。

 

五、redirect(url)

    class IndexHandler(RequestHandler):

        """對應/"""

        def get(self):

            self.write("主頁")

 

    class LoginHandler(RequestHandler):

        """對應/login"""

        def get(self):

            self.write('<form method="post"><input type="submit" value="登錄"></form>')

 

        def post(self):

            self.redirect("/")

 

六、send_error(status_code=500, **kwargs)

    拋出HTTP錯誤狀態碼status_code，默認爲500，kwargs爲可變命名參數。使用send_error拋出錯誤後tornado會調用write_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("主頁")

 

七、write_error(status_code, **kwargs)

    用來處理send_error拋出的錯誤信息並返回給瀏覽器錯誤信息頁面。能夠重寫此方法來定製本身的錯誤顯示頁面

    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"])

 

 

--------------------Tornado接口與調用順序--------------------

一、initialize()

    對應每一個請求的處理類Handler在構造一個實例後首先執行initialize()方法。在講輸入時提到，路由映射中的第三個字典型參數會做爲該方法的命名參數傳遞

 

    class ProfileHandler(RequestHandler):

        def initialize(self, database):

            self.database = database

 

        def get(self):

            ...

 

    app = Application([

        (r'/user/(.*)', ProfileHandler, dict(database=database)),

        ])

 

 

二、perpare()

    預處理，即在執行對應請求方式的HTTP方法（如get、post等）前先執行，注意：不論以何種HTTP方式請求，都會執行prepare()方法。

 

    def prepare(self):

        if self.request.headers.get("Content-Type").startswith("application/json"):

            self.json_dict = json.loads(self.request.body)

        else:

            self.json_dict = None

 

 

三、HTTP方法

    一、get：請求指定的頁面信息，並返回實體主體。

 

    二、head：相似get請求，只不過返回的響應中沒有具體的內容，用於獲取報頭。

 

    三、post：向指定資源提交數據進行處理請求（例如提交表單或上傳文件）。數據被包含在請求體中。POST請求可能會致使新的資源的創建和/或已有資源的修改。

 

    四、delete：請求服務器刪除指定的內容。

 

    五、patch：請求修改局部數據。

 

    六、put：從客戶端向服務器傳送的數據取代指定的文檔的內容。

 

    七、options：返回給定URL支持的全部HTTP方法

 

 

四、on_finish()

    在請求處理結束後調用，即在調用HTTP方法後調用。一般該方法用來進行資源清理釋放或處理日誌等。注意：請儘可能不要在此方法中進行響應輸出。

 

五、set_default_headers()

 

 

六、write_error()

 

 

七、調用順序

    一、測試

    class IndexHandler(RequestHandler):

 

        def initialize(self):

            print "調用了initialize()"

 

        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)  # 注意此出拋出了錯誤

 

        def on_finish(self):

            print "調用了on_finish()"

 

    二、在正常狀況未拋出錯誤時，調用順序爲：

        一、set_defautl_headers()

 

        二、initialize()

 

        三、prepare()

 

        四、HTTP方法

 

        五、on_finish()

 

    三、在有錯誤拋出時，調用順序爲：

        一、set_default_headers()

 

        二、initialize()

 

        三、prepare()

 

        四、HTTP方法

 

        五、set_default_headers()

 

        六、write_error()

 

        七、on_finish()