Django url 路由匹配過程詳解

Posted on by

1 Django 如何處理一個請求

當一個用戶請求Django 站點的一個頁面，下面是Django 系統決定執行哪個Python 代碼使用的算法：

Django 確定使用根 URLconf 模塊。通常，這是 ROOT_URLCONF 設置的值（即 settings 中的 ROOT_URLCONF），但如果傳入 HttpRequest 對象擁有 urlconf 屬性（通過中間件設置），它的值將被用來代替 ROOT_URLCONF 設置。可以在 django/core/handlers/base.py 發現該邏輯。

class BaseHandler:
  ...
  def _get_response(self, request):
    ...
    if hasattr(request, 'urlconf'):
      urlconf = request.urlconf
      set_urlconf(urlconf)
      resolver = get_resolver(urlconf)
    else:
      resolver = get_resolver()

Django 加載該 Python 模塊並尋找可用的 urlpatterns 。它是 django.urls.path() 和(或) django.urls.re_path() 實例的序列(sequence)。其實就是我們寫的 url.py

Django 會按順序遍歷每個 URL 模式，然後會在所請求的URL匹配到第一個模式後停止，並與 path_info 匹配。這個是路由匹配的關鍵，相關邏輯均在django/urls/resolvers.py。其中有幾個比較重要的概念，如RegexPattern、RoutePattern、URLPattern、URLResolver。其中URLResolver有嵌套的邏輯，下文詳述。

一旦有 URL 匹配成功，Django 導入並調用相關的視圖，這個視圖是一個Python 函數（或基於類的視圖 class-based view ）。匹配成功會返回一個ResolverMatch對象。

如果沒有 URL 被匹配，或者匹配過程中出現瞭異常，Django 會調用一個適當的錯誤處理視圖。

本文詳述 2、3，即 urlpatterns 相關概念和路由匹配的過程。

2 URL 配置文件

在 Django 2 之後通常會使用 path/re_path 來設置路由，還要一個比較特殊的方法 include 。

  • path: 用於普通路徑
  • re_path：用於正則路徑
  • include： 將一個子 url 配置文件導入

如下示例:

urlpatterns = [
  path('index/', views.index), # 普通路徑
  re_path(r'^articles/([0-9]{4})/$', views.articles), # 正則路徑
  path("app01/", include("app01.urls")),
]

上面的配置文件，設置瞭3條 urlpattern，分別是普通路徑 index/ 與 視圖函數 views.index，正則路徑 ^articles/([0-9]{4})/$ 與視圖函數 views.articles 綁定。app01/ 和app01.urls 綁定，app01.urls 不是一個視圖函數，而是一個子模塊的 urlpatterns。
可以看到 urlpattern 可以把一個 url 和視圖函數綁定，也可以和一個子 urlpattern 進行綁定。

2.1 path、re_path

設置路由的幾個函數均定義在 django/urls/conf.py 中。

def include(arg, namespace=None):
  ...
  return (urlconf_module, app_name, namespace)


def _path(route, view, kwargs=None, name=None, Pattern=None):
  if isinstance(view, (list, tuple)):
    # For include(...) processing.
    pattern = Pattern(route, is_endpoint=False)
    urlconf_module, app_name, namespace = view
    return URLResolver(
      pattern,
      urlconf_module,
      kwargs,
      app_name=app_name,
      namespace=namespace,
    )
  elif callable(view):
    pattern = Pattern(route, name=name, is_endpoint=True)
    return URLPattern(pattern, view, kwargs, name)
  else:
    raise TypeError('view must be a callable or a list/tuple in the case of include().')


path = partial(_path, Pattern=RoutePattern)
re_path = partial(_path, Pattern=RegexPattern)

首先先來看下 path 和 re_path，這兩個函數分別被 functools 下面的 partial 封裝瞭一下。partial 的作用簡單來說就是將一個函數的某些參數給固定住，返回一個新的函數。詳細文檔可以查看partial 文檔。
這樣就不難理解 path 和 re_path，他們就是就是綁定瞭不同的 Pattern 參數的 _path 函數。進一步查看 _path 內部的邏輯，

第一個分支 如果綁定的是一個 list或者tuple，使用 URLResolver 去解析，其實此時就是使用瞭 include 來定義 urlpattern。
另外一種情況如果綁定的 view 是可以調用的，那就使用 URLPattern 去解析。URLPattern 中的 pattern 參數就是根據是采用 path/re_path 方法分別對應 RoutePattern/RegexPattern。

2.2 include

def include(arg, namespace=None):
  ...
  if isinstance(urlconf_module, str):
    urlconf_module = import_module(urlconf_module)
  patterns = getattr(urlconf_module, 'urlpatterns', urlconf_module)
  app_name = getattr(urlconf_module, 'app_name', app_name)
  ...
  return (urlconf_module, app_name, namespace)

include 方法所做的工作就是通過 import_module 將定義的 url 模塊導入。返回一個由子 urlconf 模塊、app_name、命名空間 namespace 組成的元組。回到剛剛上面的 _path 中第一個分支。將這個元組裡面參數代入 URLResolver 並返回。

3 URLPattern 與 URLResolver

3.1 URLPattern

上面提到如果url定義中綁定是一個可以直接調用的view。那就是使用URLPattern直接去解析。

class URLPattern:
  def __init__(self, pattern, callback, default_args=None, name=None):
    # 需要匹配的 urlpattern，這裡根據是path還是re_path 分別是 RoutePattern或RegexPattern的實例
    self.pattern = pattern
    self.callback = callback # the view
    self.default_args = default_args or {}
    self.name = name
  ...
  def resolve(self, path):
    調用 RoutePattern 或 RegexPattern 的實例中的 match 方法進行匹配（註意這裡不是 re 模塊裡面的 match）
    match = self.pattern.match(path)
    if match:
      new_path, args, kwargs = match
      # Pass any extra_kwargs as **kwargs.
      kwargs.update(self.default_args)
      # 匹配成功返回 `ResolverMatch`
      return ResolverMatch(self.callback, args, kwargs, self.pattern.name, route=str(self.pattern))
  ...

URLPattern 初始化時其中的 pattern 就是根據是使用 path/re_path 分別對應RoutePattern或RegexPattern。其實就是指定匹配的模式是普通路由還是正則的路由。

3.2 URLResolver

URLResolver 源碼中比較核心的是 resolve 函數，就是傳入一個 path，進行匹配。

class URLResolver:
  def resolve(self, path):
    path = str(path) # path may be a reverse_lazy object
    tried = []
    # 匹配 path
    match = self.pattern.match(path)
    if match:
      new_path, args, kwargs = match
      # 如果匹配成功，則繼續匹配它的url_patterns
      for pattern in self.url_patterns:
        try:
          # 這個pattern可能是URLPattern，也可能是URLResolver；如果是URLPattern，匹配成功則返回ResolverMatch；如果是URLResolver，則會遞歸調用下去。
          sub_match = pattern.resolve(new_path)
        ...
        else:
          if sub_match:
            ...
            # 匹配成功返回ResolverMatch
            return ResolverMatch(
              sub_match.func,
              sub_match_args,
              sub_match_dict,
              sub_match.url_name,
              [self.app_name] + sub_match.app_names,
              [self.namespace] + sub_match.namespaces,
              self._join_route(current_route, sub_match.route),
            )
          tried.append([pattern])
      raise Resolver404({'tried': tried, 'path': new_path})
    raise Resolver404({'path': path})

URLResolver 比較關鍵的邏輯在 循環匹配 pattern 過程，如果 pattern是URLPattern匹配成功直接返回ResolverMatch，如果是另一個URLResolver，則實現瞭遞歸調用。

Django 就是通過這個 URLResolver 實現瞭多級 URL 配置。

4 總結

Django 路由匹配的有幾個比較核心的概念 path/re_path/include、RegexPattern/RoutePattern、URLPattern/URLResolver。
首先用 partial 封裝 _path，綁定瞭一個 pattern 匹配模式（RegexPattern/RoutePattern），後面多次用到瞭這個 pattern。然後就是根據 view 是元組還是可調用視圖函數，分別使用URLResolver和URLPattern去解析，這兩個類解析之後都會返回給ResolverMatch，由它去回調匹配成功後的結果（view和args等）。

本文從全局的角度大致說明瞭Django路由的匹配流程，後續將從細節部分說明其中的一些關鍵點。

到此這篇關於Django url 路由匹配過程詳解的文章就介紹到這瞭,更多相關Django url 路由匹配內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：