當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

t3 深入Tornado

發布時間：2023/11/29 编程问答 32 豆豆

生活随笔收集整理的這篇文章主要介紹了 t3 深入Tornado 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

3.1 Application

settings

前面的學習中，在創建tornado.web.Application的對象時，傳入了第一個參數——路由映射列表。實際上Application類的構造函數還接收很多關于tornado web應用的配置參數。

參數：

debug，設置tornado是否工作在調試模式，默認為False即工作在生產模式。當設置debug=True 后，tornado會工作在調試/開發模式，在此種模式下，tornado為方便開發而提供了幾種特性：

自動重啟，tornado應用會監控的源代碼文件，當有改動保存后便會重啟程序，這可以減少手動重啟程序的次數。需要注意的是，一旦保存的更改有錯誤，自動重啟會導致程序報錯而退出，從而需要保存修正錯誤后手動啟動程序。這一特性也可單獨通過autoreload=True設置；
取消緩存編譯的模板，可以單獨通過compiled_template_cache=False來設置；
取消緩存靜態文件hash值，可以單獨通過static_hash_cache=False來設置；
提供追蹤信息，當RequestHandler或者其子類拋出一個異常而未被捕獲后，會生成一個包含追蹤信息的頁面，可以單獨通過serve_traceback=True來設置。

使用debug參數的方法：

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

路由映射

先前在構建路由映射列表的時候，使用的是二元元組，如：

?[(r"/", IndexHandler),]?

對于這個映射列表中的路由，實際上還可以傳入多個信息，如：

[(r"/", Indexhandler),(r"/cpp", lewenHandler, {"subject":"c++"}),url(r"/python", lewenHandler, {"subject":"python"}, name="python_url") ]

對于路由中的字典，會傳入到對應的RequestHandler的initialize()方法中：

from tornado.web import RequestHandler class lewenHandler(RequestHandler):def initialize(self, subject):self.subject = subjectdef get(self):self.write(self.subject)

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

3.2 輸入

下面幾節主要講解tornado.web.RequestHandler。

回想一下，利用HTTP協議向服務器傳參有幾種途徑？

查詢字符串（query string)，形如key1=value1&key2=value2；
請求體（body）中發送的數據，比如表單數據、json、xml；
提取uri的特定部分，如/blogs/2016/09/0001，可以在服務器端的路由中用正則表達式截取；
在http報文的頭（header）中增加自定義字段，如X-XSRFToken=lewen。

現在來看下tornado中為提供了哪些方法來獲取請求的信息。

1. 獲取查詢字符串參數

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

2. 獲取請求體參數

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

3. 前兩類方法的整合

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

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

default與strip同前，不再贅述。

get_arguments(name, strip=True)

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

strip同前，不再贅述。

說明

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

用代碼來看上述六中方法的使用：

# -*- coding: utf-8 -*- # __auther__ = 'lewen'import tornado.web import tornado.ioloop import tornado.httpserver import tornado.options from tornado.options import options, define from tornado.web import RequestHandler, MissingArgumentErrordefine("port", default=8000, type=int, help="run server on the given port.")class IndexHandler(RequestHandler):def post(self):query_arg = self.get_query_argument("a")query_args = self.get_query_arguments("a")body_arg = self.get_body_argument("a")body_args = self.get_body_arguments("a", strip=False)# 參數獲取范圍是請全體和查詢url中arg = self.get_argument("a")args = self.get_arguments("a")default_arg = self.get_argument("b", "tornado test")default_args = self.get_arguments("b")try:missing_arg = self.get_argument("c")except MissingArgumentError as e:missing_arg = "We catched the MissingArgumentError!"print(e)missing_args = self.get_arguments("c")rep = "query_arg:%s<br/>" % query_argrep += "query_args:%s<br/>" % query_argsrep += "body_arg:%s<br/>" % body_argrep += "body_args:%s<br/>" % body_argsrep += "arg:%s<br/>" % argrep += "args:%s<br/>" % argsrep += "default_arg:%s<br/>" % default_argrep += "default_args:%s<br/>" % default_argsrep += "missing_arg:%s<br/>" % missing_argrep += "missing_args:%s<br/>" % missing_argsself.write(rep)if __name__ == "__main__":tornado.options.parse_command_line()app = tornado.web.Application([(r"/", IndexHandler),],debug=True)http_server = tornado.httpserver.HTTPServer(app)http_server.listen(options.port)tornado.ioloop.IOLoop.current().start()

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

使用時注意思考

什么時候設置default，什么時候不設置default？

default的默認值_ARG_DEFAULT是什么？

什么時候使用strip，亦即什么時候要截斷空白字符，什么時候不需要？

4. 關于請求的其他信息

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

實現一個上傳文件并保存在服務器本地的小程序upload.py：

5. 正則提取uri

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

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

3.3 輸出

1. write(chunk)

將chunk數據寫到輸出緩沖區。如在之前的示例代碼中寫的：

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

想一想，可不可以在同一個處理方法中多次使用write方法？

下面的代碼會出現什么效果？

class IndexHandler(RequestHandler):def get(self):self.write("hello lewen 1!")self.write("hello lewen 2!")self.write("hello lewen 3!")

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

想一想，如何利用write方法寫json數據？

import jsonclass 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。

2. set_header(name, value)

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

用set_header方法來完成上面write所做的工作。

import jsonclass IndexHandler(RequestHandler):def get(self):stu = {"name":"zhangsan","age":24,"gender":1,}stu_json = json.dumps(stu)self.write(stu_json)self.set_header("Content-Type", "application/json; charset=UTF-8")

3. 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方式的默認響應體格式為jsonself.set_header("Content-Type", "application/json; charset=UTF-8")# 設置一個名為lewen、值為python的headerself.set_header("lewen", "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("lewen", "i love python") # 注意此處重寫了header中的lewen字段def post(self):print "執行了post()"stu = {"name":"zhangsan","age":24,"gender":1,}stu_json = json.dumps(stu)self.write(stu_json)

... ...

終端中打印出的執行順序：

get請求方式的響應header:

post請求方式的響應header:

4. set_status(status_code, reason=None)

為響應設置狀態碼。

參數說明：

status_code? ? ? ? ? ?int類型，狀態碼，若reason為None，則狀態碼必須為下表中的。
reason? ? ? ? ? ? ? ? ? ?string類型，描述狀態碼的詞組，若為None，則會被自動填充為下表中的內容。

CodeEnum NameDetails

100	CONTINUE	HTTP/1.1 RFC 7231, Section 6.2.1
101	SWITCHING_PROTOCOLS	HTTP/1.1 RFC 7231, Section 6.2.2
102	PROCESSING	WebDAV RFC 2518, Section 10.1
200	OK	HTTP/1.1 RFC 7231, Section 6.3.1
201	CREATED	HTTP/1.1 RFC 7231, Section 6.3.2
202	ACCEPTED	HTTP/1.1 RFC 7231, Section 6.3.3
203	NON_AUTHORITATIVE_INFORMATION	HTTP/1.1 RFC 7231, Section 6.3.4
204	NO_CONTENT	HTTP/1.1 RFC 7231, Section 6.3.5
205	RESET_CONTENT	HTTP/1.1 RFC 7231, Section 6.3.6
206	PARTIAL_CONTENT	HTTP/1.1 RFC 7233, Section 4.1
207	MULTI_STATUS	WebDAV RFC 4918, Section 11.1
208	ALREADY_REPORTED	WebDAV Binding Extensions RFC 5842, Section 7.1 (Experimental)
226	IM_USED	Delta Encoding in HTTP RFC 3229, Section 10.4.1
300	MULTIPLE_CHOICES	HTTP/1.1 RFC 7231, Section 6.4.1
301	MOVED_PERMANENTLY	HTTP/1.1 RFC 7231, Section 6.4.2
302	FOUND	HTTP/1.1 RFC 7231, Section 6.4.3
303	SEE_OTHER	HTTP/1.1 RFC 7231, Section 6.4.4
304	NOT_MODIFIED	HTTP/1.1 RFC 7232, Section 4.1
305	USE_PROXY	HTTP/1.1 RFC 7231, Section 6.4.5
307	TEMPORARY_REDIRECT	HTTP/1.1 RFC 7231, Section 6.4.7
308	PERMANENT_REDIRECT	Permanent Redirect RFC 7238, Section 3 (Experimental)
400	BAD_REQUEST	HTTP/1.1 RFC 7231, Section 6.5.1
401	UNAUTHORIZED	HTTP/1.1 Authentication RFC 7235, Section 3.1
402	PAYMENT_REQUIRED	HTTP/1.1 RFC 7231, Section 6.5.2
403	FORBIDDEN	HTTP/1.1 RFC 7231, Section 6.5.3
404	NOT_FOUND	HTTP/1.1 RFC 7231, Section 6.5.4
405	METHOD_NOT_ALLOWED	HTTP/1.1 RFC 7231, Section 6.5.5
406	NOT_ACCEPTABLE	HTTP/1.1 RFC 7231, Section 6.5.6
407	PROXY_AUTHENTICATION_REQUIRED	HTTP/1.1 Authentication RFC 7235, Section 3.2
408	REQUEST_TIMEOUT	HTTP/1.1 RFC 7231, Section 6.5.7
409	CONFLICT	HTTP/1.1 RFC 7231, Section 6.5.8
410	GONE	HTTP/1.1 RFC 7231, Section 6.5.9
411	LENGTH_REQUIRED	HTTP/1.1 RFC 7231, Section 6.5.10
412	PRECONDITION_FAILED	HTTP/1.1 RFC 7232, Section 4.2
413	REQUEST_ENTITY_TOO_LARGE	HTTP/1.1 RFC 7231, Section 6.5.11
414	REQUEST_URI_TOO_LONG	HTTP/1.1 RFC 7231, Section 6.5.12
415	UNSUPPORTED_MEDIA_TYPE	HTTP/1.1 RFC 7231, Section 6.5.13
416	REQUEST_RANGE_NOT_SATISFIABLE	HTTP/1.1 Range Requests RFC 7233, Section 4.4
417	EXPECTATION_FAILED	HTTP/1.1 RFC 7231, Section 6.5.14
422	UNPROCESSABLE_ENTITY	WebDAV RFC 4918, Section 11.2
423	LOCKED	WebDAV RFC 4918, Section 11.3
424	FAILED_DEPENDENCY	WebDAV RFC 4918, Section 11.4
426	UPGRADE_REQUIRED	HTTP/1.1 RFC 7231, Section 6.5.15
428	PRECONDITION_REQUIRED	Additional HTTP Status Codes RFC 6585
429	TOO_MANY_REQUESTS	Additional HTTP Status Codes RFC 6585
431	REQUEST_HEADER_FIELDS_TOO_LARGE Additional	HTTP Status Codes RFC 6585
500	INTERNAL_SERVER_ERROR	HTTP/1.1 RFC 7231, Section 6.6.1
501	NOT_IMPLEMENTED	HTTP/1.1 RFC 7231, Section 6.6.2
502	BAD_GATEWAY	HTTP/1.1 RFC 7231, Section 6.6.3
503	SERVICE_UNAVAILABLE	HTTP/1.1 RFC 7231, Section 6.6.4
504	GATEWAY_TIMEOUT	HTTP/1.1 RFC 7231, Section 6.6.5
505	HTTP_VERSION_NOT_SUPPORTED	HTTP/1.1 RFC 7231, Section 6.6.6
506	VARIANT_ALSO_NEGOTIATES	Transparent Content Negotiation in HTTP RFC 2295, Section 8.1 (Experimental)
507	INSUFFICIENT_STORAGE	WebDAV RFC 4918, Section 11.5
508	LOOP_DETECTED	WebDAV Binding Extensions RFC 5842, Section 7.2 (Experimental)
510	NOT_EXTENDED	An HTTP Extension Framework RFC 2774, Section 7 (Experimental)
511	NETWORK_AUTHENTICATION_REQUIRED	Additional HTTP Status Codes RFC 6585, Section 6

- class Err404Handler(RequestHandler):"""對應/err/404"""def get(self):self.write("hello lewen")self.set_status(404) # 標準狀態碼，不用設置reasonclass Err210Handler(RequestHandler):"""對應/err/210"""def get(self):self.write("hello lewen")self.set_status(210, "lewen error") # 非標準狀態碼，設置了reasonclass Err211Handler(RequestHandler):"""對應/err/211"""def get(self):self.write("hello lewen")self.set_status(211) # 非標準狀態碼，未設置reason，Unknow

5. redirect(url)

告知瀏覽器跳轉到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("/")

6. 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錯誤")

注意：默認的write_error()方法不會處理send_error拋出的kwargs參數，即上面的代碼中content="出現404錯誤"是沒有意義的。

嘗試下面的代碼會出現什么問題？

class IndexHandler(RequestHandler):def get(self):self.write("主頁")self.send_error(404, content="出現404錯誤")self.write("結束") # 在send_error再次向輸出緩沖區寫內容?

注意：使用send_error()方法后就不要再向輸出緩沖區寫內容了！

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

3.4 接口與調用順序

下面的接口方法是由tornado框架進行調用的，可以選擇性的重寫這些方法。

1. initialize()

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

class ProfileHandler(RequestHandler):def initialize(self, database):self.database = databasedef get(self):...app = Application([(r'/user/(.*)', ProfileHandler, dict(database=database)),])

此方法通常用來初始化參數（對象屬性），很少使用。

2. prepare()

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

以預處理請求體中的json數據為例：

import jsonclass IndexHandler(RequestHandler):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 = Nonedef post(self):if self.json_dict:for key, value in self.json_dict.items():self.write("<h3>%s</h3><p>%s</p>" % (key, value))def put(self):if self.json_dict:for key, value in self.json_dict.items():self.write("<h3>%s</h3><p>%s</p>" % (key, value))

用post方式發送json數據時：? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?用put方式發送json數據時：

? ? ? ? ? ? ? ? ? ? ??

3. HTTP方法

方法描述

get	請求指定的頁面信息，并返回實體主體。
head	類似于get請求，只不過返回的響應中沒有具體的內容，用于獲取報頭
post	向指定資源提交數據進行處理請求（例如提交表單或者上傳文件）。數據被包含在請求體中。POST請求可能會導致新的資源的建立和/或已有資源的修改。
delete	請求服務器刪除指定的內容。
patch	請求修改局部數據。
put	從客戶端向服務器傳送的數據取代指定的文檔的內容。
options	返回給定URL支持的所有HTTP方法。

4. on_finish()

在請求處理結束后調用，即在調用HTTP方法后調用。通常該方法用來進行資源清理釋放或處理日志等。注意：請盡量不要在此方法中進行響應輸出。

5. set_default_headers()

6. write_error()

7. 調用順序

通過一段程序來看上面這些接口的調用順序。

# -*- coding: utf-8 -*- # __auther__ = 'lewen' import json import tornado.web import tornado.ioloop import tornado.httpserver import tornado.options from tornado.options import options, define from tornado.web import RequestHandlerdefine("port", default=8000, type=int, help="run server on the given port.")class IndexHandler(RequestHandler):def set_default_headers(self):print("調用了set_default_headers()")def initialize(self):print("調用了initialize()")def prepare(self):print("調用了prepare()")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()")if __name__ == "__main__":tornado.options.parse_command_line()app = tornado.web.Application([(r"/", IndexHandler),], debug=True)http_server = tornado.httpserver.HTTPServer(app)http_server.listen(options.port)tornado.ioloop.IOLoop.current().start()

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

set_defautl_headers()

initialize()

prepare()

HTTP方法

on_finish()

在有錯誤拋出時，調用順序為：

set_default_headers()

initialize()

prepare()

HTTP方法

set_default_headers()

write_error()

on_finish()

3.5 練習

1.將Application的設置參數（目前只學習了debug）抽離為一個字典類型變量settings，并在構造Application對象時使用settings。 2.熟練使用RequestHandler的各種輸入輸出方法。 3.嘗試抽象出BaseHandler基類，繼承自RequestHandler，并在此基類中實現prepare（解析json數據）、write_error兩個接口。

轉載于:https://www.cnblogs.com/wenyule/articles/10353578.html

總結

以上是生活随笔為你收集整理的t3 深入Tornado的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

Tornado

上一篇：为什么会梦到自己结婚
下一篇：不提拔你，就是因为你只想把工作做好