Flask路由原理分析

本文大致梳理一下Flask框架在处理url路由时的主要过程。

类图

路由类图

route装饰器

在Flask应用中，我们一般通过decorator装饰view函数，来注册一个路由，表示url和处理函数的对应关系，例如：

@app.route('/')
def index():
      return 'Hello World'

route装饰器定义如下, 其本质是调用了Flask对象的add_url_rule函数:

def route(self, rule, **options):
    def decorator(f):
        endpoint = options.pop('endpoint', None)
        self.add_url_rule(rule, endpoint, f, **options)
        return f
    return decorator    

add_url_rule函数签名为def add_url_rule(self, rule, endpoint=None, view_func=None, **options)，其主要做了以下4件事情：

• endpoint默认取view函数名称
• 提供默认的 http方法（HEAD, OPTION）
• 创建url_rule_class对象（url_rule_class默认为werkzeug.routing.Route类），并添加到url_map中（werkzeug.routing.Map对象）
• 将endpoint和view_func保存到view_functions字典中

werkzeug中的Rule、Map和MapAdapter对象

1. 一个Rule对象代表一个url模式，其中重要的字段为：

• rule: string类型，存储原始的url路径，其中包括类似于<converter(arguments):name>的placeholder
• endpoint: 一般为string类型，Flask通过endpoint找到对应的view函数
• map: Map对象引用，bind过程中赋值
• _regex: 根据rule以及一些设置参数创建的正则表达式，bind过程中调用compile时创建，match过程中会根据_regex进行匹配

2. 一个Map对象包含了所有Rule对象集合，以及一些配置参数，其中重要的字段为：

• _rules: list，通过add方法添加Rule对象，同时会调用Rule对象的bind方法将Rule和Map对象绑定，二者为1:n的双向引用关系
• _rules_by_endpoint: 以endpoint为key的字典，方便查找
• converters: dict，url转换器，有默认的和自定义的，Rule对象在compile过程中创建_regex时会用到converters。

3. MapAdapter对象由Map对象的bind或bind_to_environ方法创建（与Rule的bind方法不同，后者是Rule与Map绑定），在RequestContext对象初始化时，会将请求参数environ传给Map对象创建MapAdapter对象，保存在url_adapter字段中，其主要字段和方法为：

• map: 保存Map对象
• match方法: 今次遍历map中_rules列表对象，调用Rule对象的match方法进行实际的匹配过程，如果匹配成功，则返回该Rule（或对应的endpoint）和url路径中的参数

请求路由过程

1. Flask应用初始化过程
   此过程主要通过route装饰器（或直接调用add_url_rule方法）创建好Rule对象，并添加到Map对象中
2. 请求分发过程

• 创建RequestContext对象并推入栈中
• RequestContext初始化时会将请求参数environ传给Map对象创建MapAdapter对象，保存在url_adapter字段中
• 调用MapAdapter对象的match方法找到匹配的Rule并解析出参数，保存在Request对象的url_rule和view_args字段中

    def match_request(self):
        try:
            url_rule, self.request.view_args = \
                self.url_adapter.match(return_rule=True)
            self.request.url_rule = url_rule
        except HTTPException as e:
            self.request.routing_exception = e

• 调用Flask对象的full_dispatch_request、dispatch_request方法，通过request中保存的匹配到的Rule获取endpoint以及的view_args参数，调用对应的view函数，完成一次请求分发