Sanic 源码阅读 - 基于0.1.2

Published on Dec 20, 2017 ,2 min reading time

Sanic是一个可以使用async/await语法编写项目的异步非阻塞框架,它写法类似于Flask,但使用了异步特性,而且还使用uvloop作为事件循环,其底层使用的是libuv,从而使 Sanic的速度优势更加明显。

如果你:

将Sanic-0.1.2阅读完后,我觉得你应该有以下基础再阅读源码才会理解地比较好:

Sanic-0.1.2 的核心文件如下:

.
├── __init__.py
├── blueprints.py
├── config.py
├── exceptions.py
├── log.py
├── request.py
├── response.py
├── router.py
├── sanic.py
├── server.py
└── utils.py

通过运行下面的示例,这些文件都会被我们看到它的作用,拭目以待吧。

simple_server.py

让我们从simple_server开始吧,代码如下:


from sanic_0_1_2.src import Sanic
from sanic_0_1_2.src.response import json

app = Sanic(__name__)


@app.route("/")
async def test(request):
    return json({"test": True})


app.run(host="0.0.0.0", port=8000)

或许你直接把sanic_annotation项目直接clone到本地比较方便调试+理解:

git clone https://github.com/howie6879/sanic_annotation
cd sanic_annotation/sanic_0_1_2/examples/

那么,现在一切准备就绪,开始阅读吧。

前两行代码导入包: - Sanic:构建一个 Sanic 服务必须要实例化的类 - json:以json格式返回结果,实际上是HTTPResponse类,根据实例化参数content_type的不同,构建不同的实例,如: - textcontent_type="text/plain; charset=utf-8" - htmlcontent_type="text/html; charset=utf-8"

实例化一个Sanic对象,app = Sanic(__name__),可见sanic.py,我已经在这个文件里面做了一些注释,这里也详细说下Sanic类:

其实上面这部分介绍已经讲了Sanic基本的运行逻辑,如果你理解了,那下面的讲解对你来说是轻轻松松,如果不怎么明白,也不要紧,这是只是一个大体的介绍,跟着步骤来,也很容易理解,继续看代码:

# 此处将路由 / 与视图函数 test 关联起来
@app.route("/")
async def test(request):
    return json({"test": True})

app.route,上面介绍过,随着Sanic服务的启动而启动,可定义参数uri, methods

目的是为urlpath和视图函数对应起来,构建一对映射关系,本例中Sanic.router类下的Router.routes = []

会增加一个名为Routenamedtuple,如下:

[Route(handler=<function test at 0x10a0f6488>, methods=None, pattern=re.compile('^/$'), parameters=[])]

看到没,uri '/' 和视图函数test对应起来了,如果客户端请求'/',当服务器监听到这个请求的时候,handle_request可以通过参数中的request.url来找到视图函数test并且执行,随即生成视图返回

那么这里write_response就会接受视图函数test返回的json({"test": True})

说下Router类,这个类的目的就是添加和获取路由对应的视图函数,把它想象成dict或许更容易理解:

最后一行,app.run(host="0.0.0.0", port=8000),Sanic 下的run函数,启动一个http server,主要是启动run里面的serve函数,参数如下:


try:
    serve(
        host=host,
        port=port,
        debug=debug,
        # 服务开始后启动的函数
        after_start=after_start,
        # 在服务关闭前启动的函数
        before_stop=before_stop,
        # Sanic(__name__).handle_request()
        request_handler=self.handle_request,
        # 默认读取Config
        request_timeout=self.config.REQUEST_TIMEOUT,
        request_max_size=self.config.REQUEST_MAX_SIZE,
    )
except:
    pass

让我们将目光投向server.py,这也是Sanic框架的核心代码:

至此,Sanic 服务启动了

不要小看这一个小小的demo,执行一下,竟然涉及到下面这么多个文件,让我们总结一下:

除去__init__.pySanic项目一共就10个文件,这个小demo不显山不露水地竟然用到了8个,虽然其中几个没有怎么用到,但也足够说明,你如果理解了这个demo,Sanic的运行逻辑以及框架代码你已经了解地很深入了

blueprints.py

这个例子看完,我们就能轻易地明白什么是blueprints,以及blueprints的运行方式,代码如下:


from sanic_0_1_2.src import Sanic
# 引入Blueprint
from sanic_0_1_2.src import Blueprint
from sanic_0_1_2.src.response import json, text

app = Sanic(__name__)
blueprint = Blueprint('name', url_prefix='/my_blueprint')
blueprint2 = Blueprint('name2', url_prefix='/my_blueprint2')


@blueprint.route('/foo')
async def foo(request):
    return json({'msg': 'hi from blueprint'})


@blueprint2.route('/foo')
async def foo2(request):
    return json({'msg': 'hi from blueprint2'})


app.register_blueprint(blueprint)
app.register_blueprint(blueprint2)

app.run(host="0.0.0.0", port=8000, debug=True)

让我们从这两行开始:


blueprint = Blueprint('name', url_prefix='/my_blueprint')
blueprint2 = Blueprint('name2', url_prefix='/my_blueprint2')

显然,blueprint以及blueprint2Blueprint根据不同的参数生成的不同的实例对象,接下来要干嘛?没错,分析blueprints.py:

请看下routeregister函数,然后再看下面的代码:

# 生成一个匿名函数到self.deferred_functions列表里 包含三个参数 handler(foo), uri, methods
@blueprint.route('/foo')
async def foo(request):
    return json({'msg': 'hi from blueprint'})


@blueprint2.route('/foo')
async def foo2(request):
    return json({'msg': 'hi from blueprint2'})

# 上一个例子说过这个函数,Sanic().register_blueprint() 注册蓝图
app.register_blueprint(blueprint)
app.register_blueprint(blueprint2)

怎么样,现在来看,是不是很轻松,这一行app.run(host="0.0.0.0", port=8000, debug=True)服务启动代码不用多说吧?

总结

看到这里,相信你已经完全理解了Sanic的运行机制,虽然还有middleware&exception的注册以及调用机制没讲,但这和route的运行机制一样,如果你懂了route那么这两个也很简单

本人技术微末,若有错误,请指出,不胜感激

注解地址:sanic_annotation