天天看點

Django架構之路由層彙總

一 Django中路由的作用

URL配置(URLconf)就像Django 所支撐網站的目錄。它的本質是URL與要為該URL調用的視圖函數之間的映射表;你就是以這種方式告訴Django,對于用戶端發來的某個URL調用哪一段邏輯代碼對應執行

典型的例子:

1
2
3
4
5
6
           
from django.urls import path

urlpatterns = [
    path('articles', views.special),
]
articles這個路由對應着視圖函數中special這個方法,浏覽器輸入這個連結,就會響應到special這個函數來執行
           

二 簡單的路由配置

1
2
3
4
5
           
from django.conf.urls import url

urlpatterns = [
     url(正規表達式, views視圖函數,參數,别名),
]
           
  • 正規表達式:一個正規表達式字元串
  • views視圖函數:一個可調用對象,通常為一個視圖函數或一個指定視圖函數路徑的字元串
  • 參數:可選的要傳遞給視圖函數的預設參數(字典形式)
  • 别名:一個可選的name參數
1
2
3
4
5
6
7
8
9
           
from django.urls import path,re_path
from app01 import views

urlpatterns = [
    re_path(r'^articles/2003/$', views.special_case_2003),
    re_path(r'^articles/([0-9]{4})/$', views.year_archive),
    re_path(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
    re_path(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]
           

注意:

  • 若要從URL 中捕獲一個值,隻需要在它周圍放置一對圓括号。
  • 不需要添加一個前導的反斜杠,因為每個URL 都有。例如,應該是

    ^articles

    而不是

    ^/articles

  • 每個正規表達式前面的’r’ 是可選的但是建議加上。它告訴Python 這個字元串是“原始的” —— 字元串中任何字元都不應該轉義
  • urlpatterns中的元素按照書寫順序從上往下逐一比對正規表達式,一旦比對成功則不再繼續

示例:

1
2
3
4
5
6
7
8
9
           
'''
 一些請求的例子:
/articles/2005/03/ 請求将比對清單中的第三個模式。Django 将調用函數views.month_archive(request, '2005', '03')。
/articles/2005/3/ 不比對任何URL 模式,因為清單中的第三個模式要求月份應該是兩個數字。
/articles/2003/ 将比對清單中的第一個模式不是第二個,因為模式按順序比對,第一個會首先測試是否比對。請像這樣***插入一些特殊的情況來探測比對的次序。
/articles/2003 不比對任何一個模式,因為每個模式要求URL 以一個反斜線結尾。
/articles/2003/03/03/ 将比對最後一個模式。Django 将調用函數views.article_detail(request, '2003', '03', '03')。
   
'''
           

APPEND_SLASH

1
2
           
# 是否開啟URL通路位址後面不為/跳轉至帶有/的路徑的配置項
APPEND_SLASH=True
           

Django settings.py配置檔案中預設沒有 APPEND_SLASH 這個參數,但 Django 預設這個參數為 APPEND_SLASH = True。 其作用就是自動在網址結尾加’/‘。

其效果就是:

我們定義了urls.py:

1
2
3
4
5
6
           
from django.conf.urls import url
from app01 import views

urlpatterns = [
        url(r'^blog/$', views.blog),
]
           

通路 http://www.example.com/blog 時,預設将網址自動轉換為 http://www.example/com/blog/ 。

如果在settings.py中設定了 APPEND_SLASH=False,此時我們再請求 http://www.example.com/blog 時就會提示找不到頁面。

三 有名分組

1
2
3
4
5
6
           
import re
ret=re.search('(?P<year>[0-9]{4})/([0-9]{2})','2012/12')
print(ret.group())
print(ret.group(1))
print(ret.group(2))
print(ret.group('year'))
           

上面的示例使用簡單的、沒有命名的正規表達式組(通過圓括号)來捕獲URL 中的值并以位置 參數傳遞給視圖。在更進階的用法中,可以使用命名的正規表達式組來捕獲URL 中的值并以關鍵字 參數傳遞給視圖。

在Python 正規表達式中,命名正規表達式組的文法是

(?P<name>pattern)

,其中

name

是組的名稱,

pattern

是要比對的模式。

下面是以上URLconf 使用命名組的重寫:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
           
from django.urls import path,re_path

from app01 import views

urlpatterns = [
    re_path(r'^articles/2003/$', views.special_case_2003),
    re_path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
    re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive),
    re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail),
]
#捕獲到的資料都是str類型
#視圖函數裡可以指定預設值
url('blog/$', views.blog),
url('blog/?(?P<num>[0-9]{1})', views.blog),
def blog(request,num=1):
    print(num)
    return HttpResponse('ok')
           

這個實作與前面的示例完全相同,隻有一個細微的差别:捕獲的值作為關鍵字參數而不是位置參數傳遞給視圖函數。例如:

1
2
3
4
5
           
'''
   /articles/2005/03/ 請求将調用views.month_archive(request, year='2005', month='03')函數,而不是views.month_archive(request, '2005', '03')。
   /articles/2003/03/03/ 請求将調用函數views.article_detail(request, year='2003', month='03', day='03')。

   '''
           

在實際應用中,這意味你的URLconf 會更加明晰且不容易産生參數順序問題的錯誤 —— 你可以在你的視圖函數定義中重新安排參數的順序。當然,這些好處是以簡潔為代價;

四 路由分發

Django1.1版本的分發

1
2
3
4
5
6
7
8
9
10
           
#主urls
from django.urls import path,re_path,include
from app01 import views
from app01 import urls
urlpatterns = [ 
  # re_path(r'^app01/',include('app01.urls')),#行
  # re_path(r'^app01/&',include('app01.urls')),#不行
  # path('app01/',include('app01.urls')),#行 
  #path('app01/', include(urls)),
]
           

在app01裡建立一個urls

1
2
3
4
5
           
from django.urls import path,re_path
from app01 import views
urlpatterns = [
    re_path(r'^test/(?P<year>[0-9]{2})/$',views.url_test),
]
           

五 反向解析

在使用Django 項目時,一個常見的需求是獲得URL 的最終形式,以用于嵌入到生成的内容中(視圖中和顯示給使用者的URL等)或者用于處理伺服器端的導航(重定向等)。人們強烈希望不要寫死這些URL(費力、不可擴充且容易産生錯誤)或者設計一種與URLconf 毫不相關的專門的URL 生成機制,因為這樣容易導緻一定程度上産生過期的URL。

在需要URL 的地方,對于不同層級,Django 提供不同的工具用于URL 反查:

  • 在模闆中:使用url 模闆标簽。
  • 在Python 代碼中:使用from django.urls import reverse函數

urls.py

1
2
3
4
5
           
from django.urls import path,re_path
from app01 import views
urlpatterns = [
    re_path(r'^test/(?P<year>[0-9]{2})/(?P<month>[0-9]{2})/$',views.url_test,name='test'),
]
           

html

1
           
<a href="{% url 'test' 10 23 %}">哈哈</a>
           

視圖函數中:

1
2
3
4
5
6
7
           
from django.shortcuts import render, HttpResponse,redirect,reverse
def url_test(request,year,month):
    print(year)
    print(month)
    url=reverse('test',args=(10,20))
    print(url)
    return HttpResponse('ok')
           

總結:

1
2
3
4
5
6
           
1 在html代碼裡
{% url "别名" 參數 參數%}

2 在視圖函數中:
  2.1 url=reverse('test')
  2.2 url=reverse('test',args=(10,20))
           

當命名你的URL 模式時,請確定使用的名稱不會與其它應用中名稱沖突。如果你的URL 模式叫做

comment

,而另外一個應用中也有一個同樣的名稱,當你在模闆中使用這個名稱的時候不能保證将插入哪個URL。在URL 名稱中加上一個字首,比如應用的名稱,将減少沖突的可能。我們建議使用

myapp-comment

而不是

comment

六 名稱空間

命名空間(英語:Namespace)是表示辨別符的可見範圍。一個辨別符可在多個命名空間中定義,它在不同命名空間中的含義是互不相幹的。這樣,在一個新的命名空間中可定義任何辨別符,它們不會與任何已有的辨別符發生沖突,因為已有的定義都處于其它命名空間中。

由于name沒有作用域,Django在反解URL時,會在項目全局順序搜尋,當查找到第一個name指定URL時,立即傳回

我們在開發項目時,會經常使用name屬性反解出URL,當不小心在不同的app的urls中定義相同的name時,可能會導緻URL反解錯誤,為了避免這種事情發生,引入了命名空間。

建立一個app02:python manage.py startapp app02

總urls.py

1
2
3
4
5
           
from django.urls import path,re_path,include
urlpatterns = [
    path('app01/', include('app01.urls')),
    path('app02/', include('app02.urls'))
]
           

app01 的urls.py

1
2
3
4
5
           
from django.urls import path,re_path
from app01 import views
urlpatterns = [
    re_path(r'index/',views.index,name='index'),
]
           

app02 的urls.py

1
2
3
4
5
6
7
           
from django.urls import path, re_path, include
from app02 import views

urlpatterns = [
    re_path(r'index/', views.index,name='index'),

]
           

app01的視圖函數

1
2
3
4
           
def index(request):
    url=reverse('index')
    print(url)
    return HttpResponse('index app01')
           

app02的視圖函數

1
2
3
4
           
def index(request):
    url=reverse('index')
    print(url)
    return HttpResponse('index app02')
           

這樣都找index,app01和app02找到的都是app02的index

如何處理?在路由分發的時候指定名稱空間

總urls.py在路由分發時,指定名稱空間

1
2
3
4
5
6
           
path('app01/', include(('app01.urls','app01'))),
path('app02/', include(('app02.urls','app02')))
url(r'app01/',include('app01.urls',namespace='app01')),
url(r'app02/',include('app02.urls',namespace='app02'))
url(r'app01/',include(('app01.urls','app01'))),
url(r'app02/',include(('app02.urls','app02')))
           

在視圖函數反向解析的時候,指定是那個名稱空間下的

1
2
3
4
           
url=reverse('app02:index')
print(url)
url2=reverse('app01:index')
print(url2)
           

在模版裡:

1
           
<a href="{% url 'app02:index'%}">哈哈</a>
           

七 django2.0版的path

django2.0的re_path和1.0的url一樣

思考情況如下:

1
2
3
4
5
6
           
urlpatterns = [  
    re_path('articles/(?P<year>[0-9]{4})/', year_archive),  
    re_path('article/(?P<article_id>[a-zA-Z0-9]+)/detail/', detail_view),  
    re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/edit/', edit_view),  
    re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/delete/', delete_view),  
]
           

考慮下這樣的兩個問題:

第一個問題,函數

year_archive

中year參數是字元串類型的,是以需要先轉化為整數類型的變量值,當然

year=int(year)

不會有諸如如TypeError或者ValueError的異常。那麼有沒有一種方法,在url中,使得這一轉化步驟可以由Django自動完成?

第二個問題,三個路由中article_id都是同樣的正規表達式,但是你需要寫三遍,當之後article_id規則改變後,需要同時修改三處代碼,那麼有沒有一種方法,隻需修改一處即可?

在Django2.0中,可以使用

path

解決以上的兩個問題。

基本示例

這是一個簡單的例子:

1
2
3
4
5
6
7
8
9
10
           
from django.urls import path  
from . import views  
urlpatterns = [  
    path('articles/2003/', views.special_case_2003),  
    path('articles/<int:year>/', views.year_archive),  
    path('articles/<int:year>/<int:month>/', views.month_archive),  
    path('articles/<int:year>/<int:month>/<slug>/', views.article_detail),  
  # path才支援,re_path不支援
  path('order/<int:year>',views.order),
]
           

基本規則:

  • 使用尖括号(

    <>

    )從url中捕獲值。
  • 捕獲值中可以包含一個轉化器類型(converter type),比如使用

    <int:name>

    捕獲一個整數變量。若果沒有轉化器,将比對任何字元串,當然也包括了

    /

    字元。
  • 無需添加前導斜杠。

以下是根據 2.0官方文檔 而整理的示例分析表:(跟上面url的比對關系)

Django架構之路由層彙總

path轉化器

文檔原文是Path converters,暫且翻譯為轉化器。

Django預設支援以下5個轉化器:

  • str,比對除了路徑分隔符(

    /

    )之外的非空字元串,這是預設的形式
  • int,比對正整數,包含0。
  • slug,比對字母、數字以及橫杠、下劃線組成的字元串。
  • uuid,比對格式化的uuid,如 075194d3-6885-417e-a8a8-6c931e272f00。
  • path,比對任何非空字元串,包含了路徑分隔符(/)(不能用?)

注冊自定義轉化器

對于一些複雜或者複用的需要,可以定義自己的轉化器。轉化器是一個類或接口,它的要求有三點:

  • regex

    類屬性,字元串類型
  • to_python(self, value)

    方法,value是由類屬性

    regex

    所比對到的字元串,傳回具體的Python變量值,以供Django傳遞到對應的視圖函數中。
  • to_url(self, value)

    方法,和

    to_python

    相反,value是一個具體的Python變量值,傳回其字元串,通常用于url反向引用。

例子:

1
2
3
4
5
6
           
class FourDigitYearConverter:  
    regex = '[0-9]{4}'  
    def to_python(self, value):  
        return int(value)  
    def to_url(self, value):  
        return '%04d' % value
           

使用

register_converter

将其注冊到URL配置中:

1
2
3
4
5
6
7
8
           
from django.urls import register_converter, path  
from . import converters, views  
register_converter(converters.FourDigitYearConverter, 'yyyy')  
urlpatterns = [  
    path('articles/2003/', views.special_case_2003),  
    path('articles/<yyyy:year>/', views.year_archive),  
    ...  
]