前面3个小节分别介绍了URL模式(RegexURLPattern),URL分解器(RegexURLResolver),匹配结果(ResolverMatch),但是三者没有详细地串联起来,也不好理解。
一般来说,一个请求先会从 URL 匹配器 RegexURLPattern 进入,RegexURLPattern 真正发挥匹配作用的是 RegexURLResolver 对象,并调用 RegexURLResolver.resolve() 启动了解析,一切从这里开始。从 urlresolver.py 中抽取主*分,可以得到下面的 UML 图:
LocaleRegexProvider 类只为地区化而存在,它持有 regex 属性,但在 RegexURLResolver 和 RegexURLPattern 中发挥不同的作用:
- RegexURLResolver:过滤 url 的前缀,譬如如果 regex 属性值为 people,那么能将 nowamagic/academy/ 过滤为 academy/。
- RegexURLPattern:匹配整个 url。
ResolverMatch, RegexURLPattern, RegexURLResolver 三个类暂且将他们理解为:
- ResolverMatch 当匹配成功时会实例化返回
- RegexURLPattern,RegexURLResolver 匹配器,但有不同。
摘取 RegexURLPattern 的主干函数作为讲解:
1 # 执行正则匹配 2 def resolve(self, path): 3 match = self.regex.search(path) # 搜索 4 if match: 5 # If there are any named groups, use those as kwargs, ignoring 6 # non-named groups. Otherwise, pass all non-named arguments as 7 # positional arguments. 8 # match.groupdict() 返回正则表达式中匹配的变量以及其值, 需要了解 python 中正则表达式的使用 9 kwargs = match.groupdict() 10 if kwargs: 11 args = () 12 else: 13 args = match.groups() 14 15 # In both cases, pass any extra_kwargs as **kwargs. 16 kwargs.update(self.default_args) 17 18 # 成功, 返回匹配结果类; 否则返回 None 19 return ResolverMatch(self.callback, args, kwargs, self.name) 20 21 # 对 callback 进行修饰, 如果 self._callback 不是一个可调用的对象, 则可能还是一个字符串, 需要解析得到可调用的对象 22 @property 23 def callback(self): 24 if self._callback is not None: 25 return self._callback 26 27 self._callback = get_callable(self._callback_str) 28 return self._callback
再摘取 RegexURLResolver 的主干函数作为讲解:
1 # 最关键的函数 2 def resolve(self, path): 3 4 tried = [] 5 6 # regex 在 RegexURLResolver 中表示前缀 7 match = self.regex.search(path) 8 9 if match: 10 # 去除前缀 11 new_path = path[match.end():] 12 13 for pattern in self.url_patterns: # 穷举所有的 url pattern 14 # pattern 是 RegexURLPattern 实例 15 try: 16 17 """在 RegexURLResolver.resolve() 中的一句: sub_match = pattern.resolve(new_path) 最为关键. 18 从上面 patterns() 函数的作用知道, pattern 可以是 RegexURLPattern 对象或者 RegexURLResolver 对象. 当为 RegexURLResolver 对象的时候, 就是启动子 url 匹配处理器, 于是又回到了上面. 19 20 RegexURLPattern 和 RegexURLResolver 都有一个 resolve() 函数, 所以, 下面的一句 resolve() 调用, 可以是调用 RegexURLPattern.resolve() 或者 RegexURLResolver.resolve()""" 21 22 # 返回 ResolverMatch 实例 23 sub_match = pattern.resolve(new_path) 24 25 except Resolver404 as e: 26 # 搜集已经尝试过的匹配器, 在出错的页面中会显示错误信息 27 sub_tried = e.args[0].get('tried') 28 29 if sub_tried is not None: 30 tried.extend([[pattern] + t for t in sub_tried]) 31 else: 32 tried.append([pattern]) 33 else: 34 # 是否成功匹配 35 if sub_match: 36 # match.groupdict() 37 # Return a dictionary containing all the named subgroups of the match, 38 # keyed by the subgroup name. 39 40 # 如果在 urls.py 的正则表达式中使用了变量, match.groupdict() 返回即为变量和值. 41 sub_match_dict = dict(match.groupdict(), **self.default_kwargs) 42 43 sub_match_dict.update(sub_match.kwargs) 44 45 # 返回 ResolverMatch 对象, 如你所知, 得到此对象将可以执行真正的逻辑操作, 即 views.py 内定义的函数. 46 return ResolverMatch(sub_match.func, 47 sub_match.args, sub_match_dict, 48 sub_match.url_name, self.app_name or sub_match.app_name, 49 [self.namespace] + sub_match.namespaces) 50 51 tried.append([pattern]) 52 53 # 如果没有匹配成功的项目, 将异常 54 raise Resolver404({'tried': tried, 'path': new_path}) 55 56 raise Resolver404({'path' : path}) 57 58 # 修饰 urlconf_module, 返回 self._urlconf_module, 即 urlpatterns 变量所在的文件 59 @property 60 def urlconf_module(self): 61 try: 62 return self._urlconf_module 63 except AttributeError: 64 self._urlconf_module = import_module(self.urlconf_name) 65 return self._urlconf_module 66 67 # 返回指定文件中的 urlpatterns 变量 68 @property 69 def url_patterns(self): 70 patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module) 71 try: 72 iter(patterns) # 是否可以迭代 73 except TypeError: 74 raise ImproperlyConfigured("The included urlconf %s doesn't have any patterns in it" % self.urlconf_name) 75 76 # patterns 实际上是 RegexURLPattern 对象和 RegexURLResolver 对象的集合 77 return patterns
ResolverMatch 不贴代码了,它包装了匹配成功所需要的信息,如 views.py 中定义的函数。