Tornado 源码分析 - 基础篇

简述

源码分析基于 Tornado 2.0 版本,2.0 版本时候 Tornado 的介绍还是:

Tornado is an open source version of the scalable, non-blocking web server and and tools that power FriendFeed.

这个时候介绍中还未加入 asynchronous networking library,关于 Tornado 在以后版本中对 asynchronous 的支持,在下篇文章会进行介绍。

这篇文章主要介绍 Tornado 基本执行流程,对 HTTP Request 的解析和处理,和 No-blocking I/O 在 Tornado 的具体应用。

执行流程

我们用一个简单的 Hello World 示例分析其基本的执行流程。

#!/usr/bin/env python

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


def 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.instance().start()


if __name__ == "__main__":
    main()

代码测试无误后,添加 pdb.set_trace() 开始获取 "调用堆栈"。

class TestHandler(RequestHandler):
    def get(self):
        import pdb
        pdb.set_trace()
        self.write("Hello, World!\n")

使用 curl 请求 curl http://localhost:8888 触发断点。
pdb 中输入 w 获取详细堆栈信息,输入 u d 可在上下堆栈之间切换,查看函数的调用情况。
以上测试方法来自于 参考资料 2

IOLoop

先来看一下 IOLoop 的基本功能:

IOLoop 的基本功能

可以看到 IOLoop 是典型的 Reactor 模型 的实现。

再来看一下 Hello World 那个代码的详细执行流程,以及 IOLoop 是如何发挥总调度作用的:


IOLoop 调度流程

比较重要的是绿色部分把 listening socket fd 和 connecting socket fd 添加到 ioloop 中的过程。然后 ioloop 在监听到这些 fd 可用之后,开始调用对应的处理函数开始处理。

HTTP Request 的解析和处理

HTTP Request 的解析和处理

数据的读写都是通过 IOStream 实现,绿色部分表示对 HTTP Request Header 和 HTTP Request Body 的处理。

为加深对 IOLoop 的理解,我们来实现一个简单的 EchoServer。

def handle_accept(fd, events):
    connection, address = fd_sockets[fd].accept()
    fd_sockets[connection.fileno()] = connection

    io_loop = tornado.ioloop.IOLoop.instance()
    io_loop.add_handler(connection.fileno(), handle_read, io_loop.READ)


def handle_read(fd, events):
    data = fd_sockets[fd].recv(1024)
    if data:
        fd_sockets[fd].sendall(data)
    else:
        io_loop = tornado.ioloop.IOLoop.instance()
        io_loop.remove_handler(fd)
        fd_sockets[fd].close()


def main():
    s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    s.bind((HOST, PORT))
    s.listen(5)
    fd_sockets[s.fileno()] = s

    io_loop = tornado.ioloop.IOLoop.instance()
    io_loop.add_handler(s.fileno(), handle_accept, io_loop.READ)
    io_loop.start()

各 Class 的主要作用

Tornado 各个类的分工还是很清晰的,实现也比较容易看懂。

  • HTTPServer

    处理套接字的 listen/bind/accept。

  • IOStream

    处理套接字的 read/write。

  • HTTPConnection

    处理与 HTTP client 建立的连接,解析 HTTP Request 的 header 和 body。

  • IOLoop

    I/O loop,循环取出可用的 fd,并调用对应的事件处理函数。

  • RequestHandler

    处理请求,支持 GET/POST 等操作。

No-bloking I/O

先看两个事件处理函数:

def handle_read():
    socket.setblocking(False)
    while True:
        try:
            data = socket.recv(1024)
        except socket.error, e:
            if e.args[0] in (errno.EWOULDBLOCK, errno.EAGAIN):
                return
            raise


def handle_accept():
    socket.setblocking(False)
    while True:
        try:
            connection, address = sockets.accept()
        except socket.error, e:
            if e.args[0] in (errno.EWOULDBLOCK, errno.EAGAIN):
                return
            raise

考虑一下这里为什么要采用非阻塞方式来 read/accept 数据?
我们发现 IOLoop 已经通过多路复用帮我们监听了所有 fds,等 fd 可用之后才开始调用对应的事件处理函数。换句话说在调用 handle_read/handle_accept 我们已经知道 fd 可用了,那为什么不采用阻塞 I/O 读取,而要采用非阻塞 I/O 的方式呢?
问题其实可以抽象成「多路复用为什么要搭配非阻塞 I/O」,具体讨论可以参考 这里

参考资料

  1. Tornado 2.0
  2. 有没有什么很好的 Tornado 的教材或者开源项目可以做参考的?
  3. Tornado: 1. 流程分析
  4. Tornado: 2. 源码分析
  5. 高性能网络编程(一)---- accept 建立连接
  6. 为什么 IO 多路复用要搭配非阻塞 IO?
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,311评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,339评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,671评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,252评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,253评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,031评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,340评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,973评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,466评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,937评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,039评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,701评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,254评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,259评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,497评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,786评论 2 345

推荐阅读更多精彩内容