django url 源码笔记

在django项目中,我们在使用url时,会这样:

urlpatterns = [
    url(r'^users', 'users.userview.get_users')
]

或者这样:

urlpatterns = [
    url(r'^users', include(user_urls))
]

django url要做的就是基于这些正则表达式的匹配规则,找到与请求的url对应的view,func。

首先看下request请求进来后django路由url的入口,在django.core.handlers.base.get_response()

def get_response(self, request):
    "Returns an HttpResponse object for the given HttpRequest"
    …… ……
    
    # 从settings中导入root_url名称,如'blog.urls'
    urlconf = settings.ROOT_URLCONF
    urlresolvers.set_urlconf(urlconf)
    
    # 基于root_url构建一个RegexURLResolver实例
    resolver = urlresolvers.RegexURLResolver('^/', urlconf)

    …… ……
    # 调用实例的resolve()方法匹配url对应的callback
    resolver_match = resolver.resolve(request.path_info)
    callback, callback_args, callback_kwargs = resolve_match

我们 大概可以看出url路由的基本流程和几个关键概念:

  1. settings.ROOT_UTLCONF是我们在settings中配置的根URL模块名称
  2. 匹配过程主要围绕RegexURLResolver类,通过正则表达式, url模块url_conf两个参数构造一个RegexURLResolver类实例,调用resolve()用来匹配请求的url,并返回匹配结果

下面会展开讲django url类结构,以及匹配的具体流程

django URL 关键类结构

django URL的源码部分主要分为两个模块:

  • django.core.urlresolvers.py:包括django url的所有类结构RegexURLPattern, RegexURLResolver, ResolverMatch以及url匹配逻辑。

  • django.conf.urls.py:包括url(), include(), pattern()三个主要方法,用于创建url相关类的实例。例如上面实例化一条url,相当于创建一个RegexURLPatternRegexURLResolver对象

    django-url-class-example.png-17.5kB
    django-url-class-example.png-17.5kB

RegexURLPattern:

包括属性regex(正则表达式), callback(正则表达式关联的view,func)
以及方法resolve(匹配传入的url对应的callback)

例如我们在url模块中实例化一个url,其实是调用django.conf.urls模块中的url()方法

url(r'^users', 'users.userview.get_users')

实例化一个url,其实是创建一个RegexURLPattern实例:

RegexURLPattern(r'^users', 'users.userview.get_users')

RegexURLResolver:

RegexURLResolver与RegexURLPattern的不同之处在于,RegexURLPattern可以理解为绑定regex和callback,而RegexURLResolver则是绑定regex与其他的RegexURLResolver或者RegexURLPattern。这是因为django支持url分层配置

如果我们这样实例化一个url:

url(r'^users', include(user_urls))

include方法代替了上面的'users.userview.get_users',表示正则表达式regex绑定到另一个urlconf,而不是view,func,这种情况下,相当于创建一个RegexURLResolver实例。

RegexURLResolver(r'^users', 'user_urls')

RegexURLResolver类包括属性regex(正则表达式), urlconf_module, url_patterns以及方法resolve

ResolverMatch:

由RegexURLPattern或RegexURLResolver返回匹配成功的结果, resolve()方法接收一个url,返回ResolverMatch对象

下面 结合实例,例如我们构建了一个django的blog,root_urlconf在app.urls:

urlpatterns = [
    url(r'^users/', include('users.urls'))
    url(r'^blogs/', include('blogs.urls'))
]

在users.urls:

urlpatterns = [
    url(r'^([0-9]+)', userview.detail),
    url(r'^login', userview.login)
]

相当于构建了以下的结构


django-url-class-example (1).png-27.9kB
django-url-class-example (1).png-27.9kB

RegexURLResolver和RegexURLPattern中都有resolve方法,url的路由就是调用resolver和pattern的resolve方法,直到在pattern中匹配到相应的view,func

django URL 路由流程

理解了上面的类结构以后,就能理解url的路由流程,其实就是一层层遍历这些结构化的url配置,直到 hit the target!

再来看看RegexURLResolver的resolve方法

def resolve(self, path):
    path = force_text(path)  # path may be a reverse_lazy object
    tried = []
    match = self.regex.search(path)
    if match:
        new_path = path[match.end():]
        
        # 遍历下一层的所有url实例(可能是urlresolver或urlpattern)
        for pattern in self.url_patterns:
            try:
                # 嵌套另一个urlresolver的resolve()或者urlpattern的resolve()
                sub_match = pattern.resolve(new_path)
            except Resolver404 as e:
                sub_tried = e.args[0].get('tried')
                if sub_tried is not None:
                    tried.extend([pattern] + t for t in sub_tried)
                else:
                    tried.append([pattern])
            else:
                # 匹配成功
                if sub_match:
                    sub_match_dict = dict(match.groupdict(), **self.default_kwargs)
                    sub_match_dict.update(sub_match.kwargs)
                    # 返回ResolverMatch实例
                    return ResolverMatch(
                        sub_match.func,
                        sub_match.args,
                        sub_match_dict,
                        sub_match.url_name,
                        self.app_name or sub_match.app_name,
                        [self.namespace] + sub_match.namespaces
                    )
                tried.append([pattern])
        raise Resolver404({'tried': tried, 'path': new_path})
    raise Resolver404({'path': path})

整个匹配流程最关键的逻辑是嵌套其他urlresolver的resolve()或者urlpattern的resolve()。

RegexURLPattern中的resolve()逻辑比较简单,根据传入的url匹配,匹配成功就返回相应的callback。而RegexURLResolver也会匹配url,但会返回urlconf_module子模块的匹配结果,递归流程,直到找到叶子模块RegexURLPattern,然后将匹配结果层层返回。

结合上面给出的实例,我们需要找到'users/detail'对应的view,func


url-route (1).png-32.5kB
url-route (1).png-32.5kB

小结

之前在项目中遇到一个url路由问题,所以学习了一下django url源码,已经理解了主要的逻辑,但是发现一个小小问题。

RegexURLPattern的resolve()方法中匹配正则表达式和url时,使用re.search而不是re.match方法(search和match区别),search是从字符串的任意位置开始匹配,match必须从起始位置开始匹配。

如果users.urls中配置url改成:

url(r'([0-9]+)', userview.detail)
url(r'posts/([0-9]+)', userview.post_detail)

我想通过users/posts/1找到userview.post_detail,但其实会路由到userview.detail。如果在正则表达式中加入起始符号^就能避免这个问题。

但是问题是,为什么是用search而不是match,难道某些应用场景下允许忽略url前面某部分的路径,只匹配路径靠后的部分?users/extrapath/1同样能路由到userview.detail(应该是users/1)?

也许有人说,你傻啊,在前面加个起始符号^不就没问题了,可是既然需要加起始符号,为什么不直接用match呢?

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

推荐阅读更多精彩内容