Django(6)自定義路由轉換器

Silent丿丶黑羽 發表於 2021-05-13
Django

自定義路徑轉換器

有時候上面的內建的url轉換器並不能滿足我們的需求,因此django給我們提供了一個介面可以讓我們自己定義自己的url轉換器
 

django內建的路徑轉換器原始碼解析

在我們自定義路由轉換器之前,我們先檢視一下django內建的那些路由轉換器怎麼寫的,原始碼路徑from django.urls import converters

class IntConverter:
    regex = '[0-9]+'

    def to_python(self, value):
        return int(value)

    def to_url(self, value):
        return str(value)


class StringConverter:
    regex = '[^/]+'

    def to_python(self, value):
        return value

    def to_url(self, value):
        return value


class UUIDConverter:
    regex = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'

    def to_python(self, value):
        return uuid.UUID(value)

    def to_url(self, value):
        return str(value)


class SlugConverter(StringConverter):
    regex = '[-a-zA-Z0-9_]+'


class PathConverter(StringConverter):
    regex = '.+'


DEFAULT_CONVERTERS = {
    'int': IntConverter(),
    'path': PathConverter(),
    'slug': SlugConverter(),
    'str': StringConverter(),
    'uuid': UUIDConverter(),
}


REGISTERED_CONVERTERS = {}


def register_converter(converter, type_name):
    REGISTERED_CONVERTERS[type_name] = converter()
    get_converters.cache_clear()

從上面我們可以非常分析的看到,django內建的路徑轉換器是先定義了一個類,類中定義了一個類屬性regex作為正規表示式的值,然後定義了2個方法to_pythonto_url,最後定義了一個register_converter函式,將路徑轉換器註冊到django中去
我們這裡給他劃分為5步:

  • 1.建立一個converters.py,在檔案中定義一個類。
  • 2.在類中定義一個屬性regex,這個屬性是用來儲存url轉換器規則的正規表示式。
  • 3.實現to_python(self,value)方法,這個方法是將url中的值轉換一下,然後傳給檢視函式的。
  • 4.實現to_url(self,value)方法,這個方法是在做url反轉的時候,將傳進來的引數轉換後拼接成一個正確的url。
  • 5.將定義好的轉換器,註冊到django中。
     

小案例

接下來我們自己定義一個轉換器,滿足4位數字的路徑匹配
新建一個converters.py檔案,程式碼如下:

class FourDigitYearConverter:
    # 定義正規表示式
    regex = '[0-9]{4}'

    def to_python(self, value):
        return value

    def to_url(self, value):
        return '%04d' % value

urls.py檔案下注冊自定義的轉換器

from django.urls import path,  converters
# 註冊自定義轉換器
register_converter(converters.FourDigitYearConverter, 'yyyy')  # yyyy是自定義轉換器的型別名稱
urlpatterns = [
  path('articles/<yyyy:year>', views.articles_yyyy),
]

這樣我們就可以匹配4位數字的url地址了