Tornado

Tornado
文档:https://tornado-zh-cn.readthedocs.io/zh_CN/latest/
github:https://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 webclass 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("hello! oldboyEdu") 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中, 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("hello! oldboyEdu") 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_linesettings = { '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_linesettings = { '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()

浏览器:http://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_linesettings = { '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[0-9]+)-(?P[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_linesettings = { '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("hello world") # 响应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("完蛋啦...") self.write("错误信息:%s
" % kwargs["msg"]) self.write("错误描述:%s
" % kwargs["info"])def put(self): # 页面响应 self.redirect("http://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,代码:
Title - 锐客网 tornado默认内置了一套非常强大的模板引擎
这套模板引擎是基于jinja2模板引擎的基础上进行了改造而成的。
当然jinja2是基于django的DTL模板引擎基础上改造而成的。
所以flask和tornado进行比较的时候,从来不提tornado抄袭模板引擎这个事,反而会和django去比较模板引擎的问题。

    推荐阅读