Tornado

• 2022 年 3 月 1 日
• 筆記
• Tornado

Tornado

文檔：//tornado-zh-cn.readthedocs.io/zh_CN/latest/

github：//github.com/tornadoweb/tornado

介紹

Tornado是使用Python開發的全棧式（full-stack）Web框架和非同步網路庫，最早由4名Google前軟體工程師（布雷特·泰勒）2007創辦的Friendfeed(一個社交聚合網站)開發而來的。通過使用非阻塞IO，Tornado可以處理數以萬計的開放連接，是long polling、WebSockets和其他需要為用戶維護長連接應用的理想選擇。

目前最新版本6.1, 我們實際項目開發是使用的不可能是最新版本，所以在此我們在tornado基礎階段所學所用的版本為6.0.

特點

• 開源的輕量級全棧式Web框架，提供了一整套完善的非同步編碼方案。
• 高性能
  基於協程，底層就是基於asyio來實現的完整的協程調度
  採用非同步非阻塞IO處理方式，不依賴多進程或多執行緒
  採用單進程單執行緒非同步IO的網路模式，其高性能源於Tornado基於Linux的Epoll（UNIX為kqueue）的非同步網路IO，具有出色的抗負載能力
  Tornado為了實現高並發和高性能，使用了一個IOLoop事件循環來處理socket的讀寫事件
• WSGI全棧替代產品，Tornado把應用（Application）和伺服器（Server）結合起來，既是WSGI應用也可以是WSGI服務，通俗來講就是說，Tornado既是web伺服器也是web框架，甚至可以通過Tornado替代uwsgi/gunicorn來運行Flask或者django框架

django,flask和tornado對比

內置功能模組來說: django > flask > tornado
使用入門門檻: django < flask < tornado

Tornado 可以被分為以下四個主要部分:

• Web 框架 (包括用來創建 Web 應用程式的 RequestHandler 類, 還有很多其它支援的類).
• HTTP 客戶端和伺服器的實現 (HTTPServer 和 AsyncHTTPClient).
• 非同步網路庫 (IOLoop 和 IOStream), 對 HTTP 的實現提供構建模組, 還可以用來實現其他協議.
• 協程庫 (tornado.gen) 讓用戶通過更直接的方法來實現非同步編程, 而不是通過回調的方式.

安裝

mkvirtualenv tornado_demo
pip install tornado==6.0.4
cd ~/Desktop
mkdir tdemo
cd tdemo

入門

項目基本運行

server.py

from tornado import ioloop
from tornado import web

class Home(web.RequestHandler):
    def get(self):
		# self.write 響應數據
        self.write("hello!")

def make_app():
    # Application是tornado web框架的核心應用類，是與伺服器對應的介面，裡面保存了路由映射表
    # handlers 設置路由列表
    return web.Application(handlers=[
        (r"/", Home),
    ])

if __name__ == "__main__":
    # 創建應用實例對象
    app = make_app()
    # 設置監聽的埠和地址
    app.listen(8888)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環,等待客戶端連接
    ioloop.IOLoop.current().start()

終端運行項目

server.py，程式碼：

from tornado import ioloop
from tornado import web
from tornado.options import define,options,parse_command_line
define("port", default=8888, type=int,help="設置監聽埠號，默認為8888")
class Home(web.RequestHandler):
    def get(self):
		# self.write 響應數據
        self.write("hello!")

def make_app():
    # handlers 設置路由列表
    return web.Application(handlers=[
        (r"/", Home),
    ])

if __name__ == "__main__":
    # 解析終端啟動命令，格式：python server.py --port=埠號
    parse_command_line()
    # 創建應用實例對象
    app = make_app()
    # 設置監聽的埠和地址
    app.listen(options.port) # options.port 接收參數
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環
    ioloop.IOLoop.current().start()

開啟調試模式

開啟自動載入和調試模式，開啟了debug模式以後, 項目在編輯python文件的時候自動重啟項目並且在出現異常時顯示錯誤跟蹤資訊

server.py, 程式碼：

from tornado import ioloop
from tornado import web
from tornado import autoreload
from tornado.options import define,options,parse_command_line

# 配置資訊
settings = {
    'debug' : True,
}

define("port", default=8888, type=int,help="設置監聽埠號，默認為8888")

# 類視圖
class Home(web.RequestHandler):
    # 視圖方法
    def get(self):
		# self.write 響應數據
        self.write("hello!")

def make_app():
    # handlers 設置路由列表
    return web.Application(handlers=[
        (r"/", Home),
    ],**settings) # 載入配置

if __name__ == "__main__":
    # 創建應用實例對象
    parse_command_line()
    app = make_app()
    # 設置監聽的埠和地址
    app.listen(options.port)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環
    ioloop.IOLoop.current().start()

路由拆分

程式碼：

from tornado import ioloop
from tornado import web
from tornado.options import define,options,parse_command_line
# 項目配置
settings = {
    "debug": True, # 開啟debug模式
}

# 視圖類必須要直接或者間接繼承於 web.RequestHandler
class Home(web.RequestHandler):
    def get(self): # http請求
        # 響應數據
        self.write("<h1>hello! oldboyEdu</h1>")
        self.write("hello tornado!") # 這裡也是可以被執行的

        return
        self.write("hello world") # 只有在return以後，才不會被執行

# 路由列表
urls = [
    # (r"uri路徑", 視圖類),
    (r"/", Home),
]

if __name__ == "__main__":

    # 定義終端命令行參數
    define(name="port",default=8888,type=int) # python 主程式.py --port=8888
    define(name="host", default="127.0.0.1", type=str)  # python 主程式.py --port=8888 --host=127.0.0.1
    define(name="debug", default=False, type=bool) # # python 主程式.py --debug=True
    # 啟動終端命令行參數解析方法
    parse_command_line()
    # 創建web應用實例對象

    # Application是tornado web框架的核心應用類，是與伺服器對應的介面，裡面保存了路由映射表
    settings["debug"] = options.debug
    app = web.Application(
        urls,
        **settings,
    )
    # 設置監聽的埠和地址
    app.listen(port=options.port,address=options.host)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環,等待客戶端連接
    ioloop.IOLoop.current().start()

視圖編寫

在tornado中, tornado.web框架本身就默認提供了rest風格的API介面模式. 可以直接通過CBV(類視圖)對外提供基本的http 視圖介面.

from tornado import ioloop
from tornado import web
from tornado.options import define,options,parse_command_line
# 項目配置
settings = {
    "debug": True, # 開啟debug模式
}

# 視圖類必須要直接或者間接繼承於 web.RequestHandler
class Home(web.RequestHandler):
    def get(self): # http請求
        # 響應數據
        self.write("<h1>hello! oldboyEdu</h1>")
        self.write("hello tornado!") # 這裡也是可以被執行的

        return
        self.write("hello world") # 只有在return以後，才不會被執行

    def post(self):
        self.write("hello!post")

    def put(self):
        self.write("hello!put")

    def patch(self):
        self.write("hello!patch")

    def delete(self):
        self.write("hello!delete")

# 路由列表
urls = [
    # (r"uri路徑", 視圖類),
    (r"/", Home),
]

if __name__ == "__main__":

    # 定義終端命令行參數
    define(name="port",default=8888,type=int) # python 主程式.py --port=8888
    define(name="host", default="127.0.0.1", type=str)  # python 主程式.py --port=8888 --host=127.0.0.1
    define(name="debug", default=False, type=bool) # # python 主程式.py --debug=True
    # 啟動終端命令行參數解析方法
    parse_command_line()
    # 創建web應用實例對象

    # Application是tornado web框架的核心應用類，是與伺服器對應的介面，裡面保存了路由映射表
    settings["debug"] = options.debug
    app = web.Application(
        urls,
        **settings,
    )
    # 設置監聽的埠和地址
    app.listen(port=options.port,address=options.host)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環,等待客戶端連接
    ioloop.IOLoop.current().start()

多進程模式

from tornado import ioloop
from tornado import web,httpserver
from tornado import autoreload
from tornado.options import define,options,parse_command_line

settings = {
    'debug' : False,
}

define("port", default=8888, type=int,help="設置監聽埠號，默認為8888")

class Home(web.RequestHandler):
    def get(self):
        # self.write 響應數據
        self.write("hello!get")

    def post(self):
        self.write("hello!post")

    def put(self):
        self.write("hello!put")

    def patch(self):
        self.write("hello!patch")

    def delete(self):
        self.write("hello!delete")

# 路由列表
urls = [
    (r"/", Home),
]

if __name__ == "__main__":
    app = web.Application(urls,**settings)
    # 創建應用實例對象
    parse_command_line()
    server = httpserver.HTTPServer(app)
    # 設置監聽的埠和地址
    server.bind(options.port)
    server.start(0) # 0表示進程=CPU核數
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環
    ioloop.IOLoop.current().start()

請求與響應

請求

tornado.httputil.HTTPServerRequest

server.py，程式碼：

from tornado import ioloop
from tornado import web

# 項目配置
settings = {
    "debug": True, # 開啟debug模式
}

# 視圖類必須要直接或者間接繼承於 web.RequestHandler
class Home(web.RequestHandler):
    def get(self): # http請求方法
        # 響應數據
        # print(self.settings) # 配置資訊
        # print(self.request)  # 獲取http請求處理的實例對象
        # # HTTPServerRequest(protocol='http', host='127.0.0.1:8000', method='GET', uri='/', version='HTTP/1.1', remote_ip='127.0.0.1')

        print("通訊協議: ",self.request.protocol) # 協議
        print("請求方法: ",self.request.method) # Http請求方法
        print("uri地址: ",self.request.uri)    # uri地址
        print("url地址: ",self.request.full_url())    # 完整url地址
        print("協議版本: ",self.request.version) # 協議版本
        print("請求頭: ")
        print(self.request.headers) # 請求頭 HTTPHeaders
        print("地址埠: ", self.request.host)  # 地址埠

        self.write("hello!get") # 這裡也是可以被執行的
    def post(self):
        # print("請求體: ", self.request.body) # 請求體[原始數據]
        # import json
        # body = json.loads(self.request.body.decode())
        # print(body) # {'jsonrpc': '2.0', 'id': 1, 'method': 'Live.stream.list', 'params': {}}

        # print("上傳文件: ",self.request.files)# 上傳文件
        # print("cookie資訊: ")
        # print(self.request.cookies) # cookie資訊
        # print("當前客戶端的IP地址: ", self.request.remote_ip) # 客戶端IP地址
        print(self.request.request_time())  # 請求處理的花費時間

        self.write("hello!post")

    def put(self):
        # 開發中很少使用
        print("查詢字元串參數列表: ",self.request.query_arguments) # 查詢字元串參數列表
        print("請求體參數列表: ",self.request.body_arguments) # 請求體參數列表
        self.write("hello!put")

# 路由列表
urls = [
    # (r"uri路徑", 視圖類),
    (r"/", Home),
]

if __name__ == "__main__":
    # Application是tornado web框架的核心應用類，是與伺服器對應的介面，裡面保存了路由映射表
    app = web.Application(
        urls,
        **settings,
    )
    # 設置監聽的埠和地址
    # 啟動http多進程服務
    app.listen(port=8000,address="0.0.0.0")
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環,等待客戶端連接
    ioloop.IOLoop.current().start()

接收查詢字元串

server.py，程式碼：

from tornado import ioloop
from tornado import web
from tornado import autoreload
from tornado.options import define,options,parse_command_line

settings = {
    'debug' : True,
}

define("port", default=8888, type=int,help="設置監聽埠號，默認為8888")
class Home(web.RequestHandler):
    def get(self):
        # print(self.request.arguments["name"][0].decode())
        # name = self.get_argument("name") # self.get_query_argument("name")
        # print(name) # xiaoming
        names = self.get_arguments("name") # # self.get_query_arguments("name")
        print(names) # ['xiaoming', '123']
        self.write("hello world")

# 設置路由列表
urls = [
    (r"/", Home),
]

if __name__ == "__main__":
    # 創建應用實例對象
    parse_command_line()
    app = web.Application(urls,**settings)
    # 設置監聽的埠和地址
    app.listen(options.port)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環
    ioloop.IOLoop.current().start()

瀏覽器：//127.0.0.1:8888/?name=xiaoming&name=xiaohong

接收請求體

from tornado import ioloop
from tornado import web
from tornado import autoreload
from tornado.options import define,options,parse_command_line

settings = {
    'debug' : True,
}

define("port", default=8888, type=int,help="設置監聽埠號，默認為8888")
class Home(web.RequestHandler):
    def get(self):
        # print(self.request.arguments["name"][0].decode())
        # name = self.get_argument("name") # self.get_query_argument("name")
        # print(name) # xiaoming
        names = self.get_arguments("name") # # self.get_query_arguments("name")
        print(names) # ['xiaoming', '123']
        self.write("hello!get")

    def post(self):
        print(self.request.arguments) # {'name': [b'xiaoming', b'xiaohong']}
        print(self.request.body_arguments) # {'name': [b'xiaohong']}
        print(self.get_argument("name")) # xiaohong
        print(self.get_body_argument("name")) # xiaohong
        print(self.get_arguments("name")) # ['xiaoming', 'xiaohong']
        print(self.get_body_arguments("name")) # ['xiaohong']
        self.write("hello!post")
        
# 設置路由列表
urls = [
    (r"/", Home),
]

if __name__ == "__main__":
    # 創建應用實例對象
    parse_command_line()
    app = web.Application(urls,**settings)
    # 設置監聽的埠和地址
    app.listen(options.port)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環
    ioloop.IOLoop.current().start()

接收路由參數

from tornado import ioloop
from tornado import web

# 項目配置
settings = {
    "debug": True, # 開啟debug模式
}

# 視圖類必須要直接或者間接繼承於 web.RequestHandler
class Home(web.RequestHandler):
    def get(self,cat,id): # 路由參數的形參，分別匹配路由中對應小括弧中的url地址內容
        self.write("hello!cat=%s,id=%s" % (cat,id))

class Index(web.RequestHandler):
    def get(self,cat,id):
        self.write("hello!cat=%s,id=%s" % (cat, id))

# 路由列表
urls = [
    # (r"uri路徑", 視圖類),
    # (r"/(參數1的正則)/(參數2的正則).html", Home), # 位置參數
    (r"/([0-9]+)-([0-9]+).html", Home), # 位置參數
    # (r"/index/(?P<參數名>正則).html", Index), # 命名參數
    (r"/index/(?P<id>[0-9]+)-(?P<cat>[0-9]+).html", Index), # 命名參數
]

if __name__ == "__main__":
    # Application是tornado web框架的核心應用類，是與伺服器對應的介面，裡面保存了路由映射表
    app = web.Application(
        urls,
        **settings,
    )
    # 設置監聽的埠和地址
    # 啟動http多進程服務
    app.listen(port=8000,address="0.0.0.0")
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環,等待客戶端連接
    ioloop.IOLoop.current().start()

響應

from tornado import ioloop
from tornado import web
from tornado import autoreload
from tornado.options import define, options, parse_command_line

settings = {
    'debug': True,
}

define("port", default=8888, type=int, help="設置監聽埠號，默認為8888")

from datetime import datetime
class Home(web.RequestHandler):
    def set_default_headers(self):
        self.set_header("time", int(datetime.now().timestamp()))
    def get(self):
    def get(self):
        # write 會自動識別
        # self.write("<h1>hello world</h1>") # 響應html文檔
        # self.write({"msg":"ok"}) # 響應json數據

        # 注意，json的數據格式也可以是列表,tornado中默認不支援返回list，所以如果返回list，則需要重寫write
        # self.write([1,2,3])
        
        # 重新設置響應頭的內容 set_header[修改]
        self.set_header("Content-Type","text/json; charset=gbk")
        # 自定義響應頭 add_header[添加]
        self.add_header("Company","OldBoyEdu")
        self.add_header("Server","OldBoyEduServer/1.0")
        # self.clear_header("Server")  # 從響應頭中刪除指定名稱的響應頭資訊

    def post(self):
        # self.set_status(404,"No User") # 第二個參數表示響應描述，如果不設置，則顯示原來對應的
        # self.send_error(500,reason="伺服器炸了！")
        self.send_error(404, msg="伺服器炸了！", info="快報警") # 要使用send_error必須先聲明send_error方法

    def write_error(self, status_code, **kwargs):
        self.write("<h1>完蛋啦...</h1>")
        self.write("<p>錯誤資訊:%s</p>" % kwargs["msg"])
        self.write("<p>錯誤描述:%s</p>" % kwargs["info"])

    def put(self):
        # 頁面響應
        self.redirect("//www.oldboyedu.com")

# 設置路由列表
urls = [
    (r"/", Home),
]

if __name__ == "__main__":
    # 創建應用實例對象
    parse_command_line()
    app = web.Application(urls, **settings)
    # 設置監聽的埠和地址
    app.listen(options.port)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環
    ioloop.IOLoop.current().start()

cookie

# 獲取和設置cookie
self.set_cookie(name, value)
self.get_cookie(name)


# 獲取和設置cookie[加密]
settings = {cookie_secret:"u3h7AQnM2WdTL1o"}

self.set_secure_cookie(name, value)
self.get_secure_cookie(name)

# 刪除cookie
self.clear_cookie(name)

# 清空cookie
self.clear_all_cookie()

tornado沒有提供session操作，如果需要使用到session可以自己實現或者引入第三方模組。

靜態文件

import os
settings = {
    'debug': True,
    # 靜態文件保存路徑
    "static_path": os.path.join(os.path.dirname(__file__), 'static'),
    # 靜態文件url地址前綴
    "static_url_prefix":"/static/", # 必須前後有斜杠
}

頁面響應

from tornado import ioloop
from tornado import web
from tornado.options import define, options, parse_command_line
import os
settings = {
    'debug': True,
    # 靜態文件保存路徑
    "static_path": os.path.join(os.path.dirname(__file__), 'static'),
    # 靜態文件url地址前綴
    "static_url_prefix":"/static/", # 必須前後有斜杠
    "template_path": os.path.join(os.path.dirname(__file__), 'templates'),
}

define("port", default=8888, type=int, help="設置監聽埠號，默認為8888")

class Home(web.RequestHandler):
    def get(self):
        self.render("index.html")

# 設置路由列表
urls = [
    (r"/", Home),
]

if __name__ == "__main__":
    # 創建應用實例對象
    parse_command_line()
    app = web.Application(urls, **settings)

    # 設置監聽的埠和地址
    app.listen(options.port)
    # ioloop，全局的tornado事件循環，是伺服器的引擎核心，start表示創建IO事件循環
    ioloop.IOLoop.current().start()

templates/index.html，程式碼：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    tornado默認內置了一套非常強大的模板引擎<br>
    這套模板引擎是基於jinja2模板引擎的基礎上進行了改造而成的。<br>
    當然jinja2是基於django的DTL模板引擎基礎上改造而成的。<br>
    所以flask和tornado進行比較的時候，從來不提tornado抄襲模板引擎這個事，反而會和django去比較模板引擎的問題。
</body>
</html>