介绍
Tornado 是由 Facebook 开源的一个服务器“套装”,适合于做 python 的 web 或者使用其本身提供的可扩展的功能,完成了不完整的 wsgi 协议,可用于做快速的 web 开发,封装了 epoll 性能较好。文章主要以分析 tornado 的网络部分即异步事件处理与上层的 IOstream 类提供的异步IO,其他的模块如 web 的 tornado.web 以后慢慢留作分析。
在深入到模块进行分析之前,首先来看看Tornado的设计模型
从上面的图可以看出,Tornado 不仅仅是一个WEB框架,它还完整地实现了HTTP服务器和客户端,在此基础上提供WEB服务。它可以分为四层:
- 最底层的EVENT层处理IO事件;
- TCP层实现了TCP服务器,负责数据传输;
- HTTP/HTTPS层基于HTTP协议实现了HTTP服务器和客户端;
- 最上层为WEB框架,包含了处理器、模板、数据库连接、认证、本地化等等WEB框架需要具备的功能。
理解Tornado的核心框架之后,就能便于我们后续的理解。
先来一段官方示例代码
import tornado.httpserver
import tornado.ioloop
import tornado.options
import tornado.web
from tornado.options import define, options
define("port", default=8888, help="run on the given port", type=int)
class MainHandler(tornado.web.RequestHandler):
def get(self):
self.write("Hello, world")
if __name__ == "__main__":
tornado.options.parse_command_line()
application = tornado.web.Application([
(r"/", MainHandler),
],)
http_server = tornado.httpserver.HTTPServer(application)
http_server.listen(options.port)
tornado.ioloop.IOLoop.current().start()
- 从代码里可以看到的是:应用里定义了 URI 路由和对应的处理类,并以此构建了application对象,然后让这个对象监听在8888端口,最后由 ioloop 单例进入循环,不断分发事件。
- 这里的URI路由就是r"/",对应处理类就是 MainHandler,它们被放在同一个 tuple 里形成了关联。可以看到,application 是接受一个列表的,因此可以定义多个全局路由对应不同处理,往列表里 append 就是了。
tornado.web 里的 RequestHandler 和 Application 类
Tornado 使用 web 模块的 Application 做URI转发,然后通过 RequestHandler处理请求。 Application 提供了一个 listen 方法作为 HTTPServer 中的 listen 的封装。
初始化 Application 时,一般将处理器直接传入,它会调用 add_handlers 添加这些处理器,初始化还包括 transforms (分块、压缩等)、UI模块、静态文件处理器的初始化。 add_handlers 方法负责添加URI和处理器的映射。
def __init__(self, handlers=None, default_host=None, transforms=None,
**settings):
self.default_host = default_host
self.settings = settings
...代码缩减后
self.wildcard_router = _ApplicationRouter(self, handlers)
self.default_router = _ApplicationRouter(self, [
Rule(AnyMatches(), self.wildcard_router)
])#全局路由初始化
# Automatically reload modified modules
if self.settings.get('autoreload'):
from tornado import autoreload
autoreload.start()
Application接收了list类型的handlers后用_ApplicationRouter 类进行封装,父类(_ApplicationRouter>ReversibleRuleRouter>RuleRouter)会自动调用self.add_rules方法遍历所有Rule的实例添加到list类型的self.rules中
Application 实现 URI 转发时使用了一个技巧,它实现了_call_ 方法,并将 Application 的实例传递给 HTTPServer ,当监听到请求时,它通过调用 Application 实例触发 _call_ 。 _call_ 方法中完成具体的URI转发工作,并调用已注册的处理器的 execute 方法,处理请求。
def __call__(self, request):
# Legacy HTTPServer interface
dispatcher = self.find_handler(request)
return dispatcher.execute()
def find_handler(self, request, **kwargs):
#self.default_router全局路由的实例,这里调用find_handler方法查找url对应的视图函数
route = self.default_router.find_handler(request)
if route is not None:
return route
if self.settings.get('default_handler_class'):
return self.get_handler_delegate(
request,
self.settings['default_handler_class'],
self.settings.get('default_handler_args', {}))
#设置处理器类 暂时还不太清楚,估计是为了扩展
return self.get_handler_delegate(
request, ErrorHandler, {'status_code': 404})
#如果全局路由中没有找到URI就返回404错误
execute这个方法很核心,也很重要。
(1) 判断application是否对complied_template_cache是否设置成True.如果没有,则将模板加载器重置。相当于不对编译后模板缓存的话,就重置模板加载器。
(2) 判断applacation是否对static_hash_cache是否设置成True. 如果没有,则调用StaticFileHandler的reset方法。相当于不对网站的静态文件进行缓存的话,就调用重置的方法。
(3) 根据_find_handler方法设置的handler_class属性初始化自定义的RequestHanlder
(4) 调用requestHandler的_exucute方法,就是调用相应的方法,要门是get方法,要么是post,要么是其他支持的http方法,具体实现详情请查看RequestHandler类。