02-01 Django之路由層

Django之路由層

一 路由的作用

路由即請求地址與視圖函數的映射關系，如果把網站比喻為一本書，那路由就好比是這本書的目錄，在Django中路由默認配置在urls.py中，如下圖：

二 簡單的路由配置

# urls.py 
from django.conf.urls import url

# 由一條條映射關系組成的urlpatterns這個列表稱之為路由表
urlpatterns = [
     url(regex, view, kwargs=None, name=None), # url本質就是一個函數
]
#函數url關鍵參數介紹
# regex：正則表達式,用來匹配url地址的路徑部分，
		# 例如url地址為：http://127.0.0.1:8001/index/，正則表達式要匹配的部分是index/
# view：通常為一個視圖函數，用來處理業務邏輯
# kwargs：略（用法詳見有名分組）
# name：略（用法詳見反向解析）

案例：

urls.py文件

from django.conf.urls import url
from django.contrib import admin
from app01 import views # 導入模塊views.py

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    
    url(r'^index/$',views.index), # 新增一條
]

views.py文件

from django.shortcuts import render
from django.shortcuts import HttpResponse # 導入HttpResponse，用來生成響應信息

# 新增視圖函數index
def index(request):
    return HttpResponse('index page...')

測試：

python manage.py runserver 8001 # 在瀏覽器輸入：http://127.0.0.1:8001/index/ 會看到 index page...

注意一：

剛剛我們在瀏覽器輸入：http://127.0.0.1:8001/index/，Django會拿着路徑部分index/去路由表中自上而下匹配正則表達式，一旦匹配成功，則立即執行其后的視圖函數，不會繼續往下匹配，此處匹配成功的正則表達式是 r'^index/$'。

注意二：

但是我們在瀏覽器輸入：http://127.0.0.1:8001/index，Django同樣會拿着路徑部分index去路由表中自上而下匹配正則表達式，貌似並不會匹配成功任何正則表達式（ r'^index/$'匹配的是必須以 / 結尾，所以不會匹配成功index），但實際上仍然會看到結果 index page...，原因如下：

在配置文件settings.py中有一個參數APPEND_SLASH，該參數有兩個值True或False

當APPEND_SLASH=True（如果配置文件中沒有該配置，APPEND_SLASH的默認值為True），並且用戶請求的url地址的路徑部分不是以 / 結尾，例如請求的url地址是 http://127.0.0.1:8001/index，Django會拿着路徑部分（即index）去路由表中匹配正則表達式，發現匹配不成功，那么Django會在路徑后加 / （即index/）再去路由表中匹配，如果匹配失敗則會返回路徑未找到，如果匹配成功，則會返回重定向信息給瀏覽器，要求瀏覽器重新向 http://127.0.0.1:8001/index/地址發送請求。

當APPEND_SLASH=False時，則不會執行上述過程，即一旦url地址的路徑部分匹配失敗就立即返回路徑未找到，不會做任何的附加操作
ps：注意！！！在末尾加/然后重新發起請求，這是瀏覽器的功能，如果是在終端直接執行curl http://127.0.0.1:8901/index，則沒有該功能

三 分組

什么是分組、為何要分組呢？比如我們開發了一個博客系統，當我們需要根據文章的id查看指定文章時，瀏覽器在發送請求時需要向后台傳遞參數（文章的id號），可以使用 http://127.0.0.1:8001/article/?id=3，也可以直接將參數放到路徑中http://127.0.0.1:8001/article/3/

針對后一種方式Django就需要直接從路徑中取出參數，這就用到了正則表達式的分組功能了，分組分為兩種：無名分組與有名分組

3.1 無名分組

urls.py文件

from django.conf.urls import url
from django.contrib import admin
from app01 import views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    
    # 下述正則表達式會匹配url地址的路徑部分為:article/數字/，匹配成功的分組部分會以位置參數的形式傳給視圖函數，有幾個分組就傳幾個位置參數
    url(r'^aritcle/(\d+)/$',views.article), 
]

views.py文件

from django.shortcuts import render
from django.shortcuts import HttpResponse

# 需要額外增加一個形參用於接收傳遞過來的分組數據
def article(request,article_id):
    return HttpResponse('id為 %s 的文章內容...' %article_id)

測試：

python manage.py runserver 8001 # 在瀏覽器輸入：http://127.0.0.1:8001/article/3/ 會看到: id為 3 的文章內容...

3.2 有名分組

urls.py文件

from django.conf.urls import url
from django.contrib import admin
from app01 import views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    
    # 該正則會匹配url地址的路徑部分為:article/數字/，匹配成功的分組部分會以關鍵字參數（article_id=匹配成功的數字）的形式傳給視圖函數，有幾個有名分組就會傳幾個關鍵字參數
    url(r'^aritcle/(?P<article_id>\d+)/$',views.article), 
]

views.py文件

from django.shortcuts import render
from django.shortcuts import HttpResponse

# 需要額外增加一個形參，形參名必須為article_id
def article(request,article_id):
    return HttpResponse('id為 %s 的文章內容...' %article_id)

測試：

python manage.py runserver 8001 # 在瀏覽器輸入：http://127.0.0.1:8001/article/3/ 會看到: id為 3 的文章內容...

總結：有名分組和無名分組都是為了獲取路徑中的參數，並傳遞給視圖函數，區別在於無名分組是以位置參數的形式傳遞，有名分組是以關鍵字參數的形式傳遞。

強調：無名分組和有名分組不要混合使用

四 路由分發

隨着項目功能的增加，app會越來越多，路由也越來越多，每個app都會有屬於自己的路由，如果再將所有的路由都放到一張路由表中，會導致結構不清晰，不便於管理，所以我們應該將app自己的路由交由自己管理，然后在總路由表中做分發，具體做法如下

1 創建兩個app

# 新建項目mystie2
E:\git>django-admin startproject mysite2
# 切換到項目目錄下
E:\git>cd mysite2
# 創建app01和app02
E:\git\mysite2>python3 manage.py startapp app01
E:\git\mysite2>python3 manage.py startapp app02

2 在每個app下手動創建urls.py來存放自己的路由，如下：

app01下的urls.py文件

from django.conf.urls import url
# 導入app01的views
from app01 import views

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

app01下的views.py

from django.shortcuts import render
from django.shortcuts import HttpResponse

def index(request):
    return HttpResponse('我是app01的index頁面...')

app02下的urls.py文件

from django.conf.urls import url
# 導入app02的views
from app02 import views

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

app02下的views.py

from django.shortcuts import render
from django.shortcuts import HttpResponse

def index(request):
    return HttpResponse('我是app02的index頁面...')

3 在總的urls.py文件中（mysite2文件夾下的urls.py）

from django.conf.urls import url,include
from django.contrib import admin

# 總路由表
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    
    # 新增兩條路由，注意不能以$結尾
    # include函數就是做分發操作的，當在瀏覽器輸入http://127.0.0.1:8001/app01/index/時，會先進入到總路由表中進行匹配，正則表達式r'^app01/'會先匹配成功路徑app01/，然后include功能會去app01下的urls.py中繼續匹配剩余的路徑部分
    url(r'^app01/', include('app01.urls')),
    url(r'^app02/', include('app02.urls')),
]

測試：

python manage.py runserver 8001  
# 在瀏覽器輸入：http://127.0.0.1:8001/app01/index/ 會看到:我是app01的index頁面...
# 在瀏覽器輸入：http://127.0.0.1:8001/app02/index/ 會看到:我是app02的index頁面...

五 反向解析

在軟件開發初期，url地址的路徑設計可能並不完美，后期需要進行調整，如果項目中很多地方使用了該路徑，一旦該路徑發生變化，就意味着所有使用該路徑的地方都需要進行修改，這是一個非常繁瑣的操作。

解決方案就是在編寫一條url(regex, view, kwargs=None, name=None)時，可以通過參數name為url地址的路徑部分起一個別名，項目中就可以通過別名來獲取這個路徑。以后無論路徑如何變化別名與路徑始終保持一致。

上述方案中通過別名獲取路徑的過程稱為反向解析

案例：登錄成功跳轉到index.html頁面

在urls.py文件中

from django.conf.urls import url
from django.contrib import admin
from app01 import views
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    
    url(r'^login/$', views.login,name='login_page'), # 路徑login/的別名為login_page
    url(r'^index/$', views.index,name='index_page'), # 路徑index/的別名為index_page
]

在views.py中

from django.shortcuts import render 
from django.shortcuts import reverse # 用於反向解析
from django.shortcuts import redirect #用於重定向頁面
from django.shortcuts import HttpResponse

def login(request):
    if request.method == 'GET':
        # 當為get請求時，返回login.html頁面,頁面中的{% url 'login_page' %}會被反向解析成路徑：/login/
        return render(request, 'login.html')
	
    # 當為post請求時，可以從request.POST中取出請求體的數據
    name = request.POST.get('name')
    pwd = request.POST.get('pwd')
    if name == 'kevin' and pwd == '123':
        url = reverse('index_page')  # reverse會將別名'index_page'反向解析成路徑：/index/       
        return redirect(url) # 重定向到/index/
    else:
        return HttpResponse('用戶名或密碼錯誤')


def index(request):
    return render(request, 'index.html')

login.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>登錄頁面</title>
</head>
<body>
<!--強調：login_page必須加引號-->
<form action="{% url 'login_page' %}" method="post">
    {% csrf_token %} <!--強調：必須加上這一行，后續我們會詳細介紹-->
    <p>用戶名：<input type="text" name="name"></p>
    <p>密碼：<input type="password" name="pwd"></p>
    <p><input type="submit" value="提交"></p>

</form>
</body>
</html>

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
<h3>我是index頁面...</h3>
</body>
</html>

測試：

python manage.py runserver 8001  
# 在瀏覽器輸入：http://127.0.0.1:8001/login/ 會看到登錄頁面，輸入正確的用戶名密碼會跳轉到index.html
# 當我們修改路由表中匹配路徑的正則表達式時，程序其余部分均無需修改

總結：

在views.py中，反向解析的使用：
	url = reverse('index_page')
在模版login.html文件中，反向解析的使用
	{% url 'login_page' %}

拓展閱讀：

如果路徑存在分組的反向解析使用：

from django.conf.urls import url
from django.contrib import admin
from app01 import views
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    
    url(r'^aritcle/(\d+)/$',views.article,name='article_page'), #　無名分組
    url(r'^user/(?P<uid>\d+)/$',views.article,name='user_page'), # 有名分組
]

# 1 針對無名分組，比如我們要反向解析出：/aritcle/1/ 這種路徑，寫法如下
在views.py中，反向解析的使用：
	url = reverse('article_page',args=(1,)) 
在模版login.html文件中，反向解析的使用
	{% url 'article_page' 1 %}

    
# 2 針對有名分組，比如我們要反向解析出：/user/1/ 這種路徑，寫法如下
在views.py中，反向解析的使用：
	url = reverse('user_page',kwargs={'uid':1}) 
在模版login.html文件中，反向解析的使用
	{% url 'user_page' uid=1 %}

六 名稱空間

當我們的項目下創建了多個app，並且每個app下都針對匹配的路徑起了別名，如果別名存在重復，那么在反向解析時則會出現覆蓋，如下

1 創建兩個app

# 新建項目mystie2
E:\git>django-admin startproject mysite2
# 切換到項目目錄下
E:\git>cd mysite2
# 創建app01和app02
E:\git\mysite2>python3 manage.py startapp app01
E:\git\mysite2>python3 manage.py startapp app02

2 在每個app下手動創建urls.py來存放自己的路由，並且為匹配的路徑起別名

app01下的urls.py文件

from django.conf.urls import url
from app01 import views

urlpatterns = [
    # 為匹配的路徑app01/index/起別名'index_page'
    url(r'^index/$',views.index,name='index_page'), 
]

app02下的urls.py文件

from django.conf.urls import url
from app02 import views

urlpatterns = [
    # 為匹配的路徑app02/index/起別名'index_page',與app01中的別名相同
    url(r'^index/$',views.index,name='index_page'), 
]

3 在每個app下的view.py中編寫視圖函數，在視圖函數中針對別名'index_page'做反向解析

app01下的views.py

from django.shortcuts import render
from django.shortcuts import HttpResponse
from django.shortcuts import reverse

def index(request):
    url=reverse('index_page')
    return HttpResponse('app01的index頁面，反向解析結果為%s' %url)

app02下的views.py

from django.shortcuts import render
from django.shortcuts import HttpResponse
from django.shortcuts import reverse

def index(request):
    url=reverse('index_page')
    return HttpResponse('app02的index頁面，反向解析結果為%s' %url)

3 在總的urls.py文件中（mysite2文件夾下的urls.py）

from django.conf.urls import url,include
from django.contrib import admin

# 總路由表
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    
    # 新增兩條路由，注意不能以$結尾
    url(r'^app01/', include('app01.urls')),
    url(r'^app02/', include('app02.urls')),
]

4、測試：

python manage.py runserver 8001  

在測試時，無論在瀏覽器輸入：http://127.0.0.1:8001/app01/index/還是輸入http://127.0.0.1:8001/app02/index/ 針對別名'index_page'反向解析的結果都是/app02/index/，覆蓋了app01下別名的解析。

解決這個問題的方法之一就是避免使用相同的別名，如果就想使用相同的別名，那就需要用到django中名稱空間的概念，將別名放到不同的名稱空間中，這樣即便是出現重復，彼此也不會沖突，具體做法如下

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

from django.conf.urls import url, include
from django.contrib import admin

# 總路由表
urlpatterns = [
    url(r'^admin/', admin.site.urls),
	
    # 傳給include功能一個元組，元組的第一個值是路由分發的地址，第二個值則是我們為名稱空間起的名字
    url(r'^app01/', include(('app01.urls','app01'))),
    url(r'^app02/', include(('app02.urls','app02'))),
]

2、修改每個app下的view.py中視圖函數，針對不同名稱空間中的別名'index_page'做反向解析

app01下的views.py

from django.shortcuts import render
from django.shortcuts import HttpResponse
from django.shortcuts import reverse

def index(request):
    url=reverse('app01:index_page') # 解析的是名稱空間app01下的別名'index_page'
    return HttpResponse('app01的index頁面，反向解析結果為%s' %url)

app02下的views.py

from django.shortcuts import render
from django.shortcuts import HttpResponse
from django.shortcuts import reverse

def index(request):
    url=reverse('app02:index_page') # 解析的是名稱空間app02下的別名'index_page'
    return HttpResponse('app02的index頁面，反向解析結果為%s' %url)

3、測試：

python manage.py runserver 8001  

瀏覽器輸入：http://127.0.0.1:8001/app01/index/反向解析的結果是/app01/index/

在瀏覽器輸入http://127.0.0.1:8001/app02/index/ 反向解析的結果是/app02/index/

總結+補充

1、在視圖函數中基於名稱空間的反向解析，用法如下
url=reverse('名稱空間的名字:待解析的別名')

2、在模版里基於名稱空間的反向解析，用法如下
<a href="{% url '名稱空間的名字:待解析的別名'%}">哈哈</a>

七 django2.0版的re_path與path

7.1 re_path

Django2.0中的re_path與django1.0的url一樣，傳入的第一個參數都是正則表達式

from django.urls import re_path # django2.0中的re_path
from django.conf.urls import url # 在django2.0中同樣可以導入1.0中的url

urlpatterns = [
    # 用法完全一致
    url(r'^app01/', include(('app01.urls','app01'))),
    re_path(r'^app02/', include(('app02.urls','app02'))),
]

7.2 path

在Django2.0中新增了一個path功能，用來解決：數據類型轉換問題與正則表達式冗余問題，如下

urls.py文件

from django.urls import re_path

from app01 import views

urlpatterns = [
    # 問題一：數據類型轉換
    # 正則表達式會將請求路徑中的年份匹配成功然后以str類型傳遞函數year_archive，在函數year_archive中如果想以int類型的格式處理年份，則必須進行數據類型轉換
    re_path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),

    # 問題二：正則表達式冗余
    # 下述三個路由中匹配article_id采用了同樣的正則表達式，重復編寫了三遍，存在冗余問題，並且極不容易管理，因為一旦article_id規則需要改變，則必須同時修改三處代碼
    
    re_path(r'^article/(?P<article_id>[a-zA-Z0-9]+)/detail/$', views.detail_view),
    re_path(r'^articles/(?P<article_id>[a-zA-Z0-9]+)/edit/$', views.edit_view),
    re_path(r'^articles/(?P<article_id>[a-zA-Z0-9]+)/delete/$', views.delete_view),
]

views.py

from django.shortcuts import render,HttpResponse

# Create your views here.
def year_archive(request,year):
    print(year,type(year))
    return HttpResponse('year_archive page')

def detail_view(request,article_id):
    print(article_id, type(article_id))
    return HttpResponse('detail_view page')

def edit_view(request,article_id):
    print(article_id, type(article_id))
    return HttpResponse('edit_view page')

def delete_view(request,article_id):
    print(article_id, type(article_id))
    return HttpResponse('delete_view page')

Django2.0中的path如何解決上述兩個問題的呢？請看示例

from django.urls import path,re_path

from app01 import views

urlpatterns = [
    # 問題一的解決方案：
    path('articles/<int:year>/', views.year_archive), # <int:year>相當於一個有名分組，其中int是django提供的轉換器，相當於正則表達式，專門用於匹配數字類型，而year則是我們為有名分組命的名，並且int會將匹配成功的結果轉換成整型后按照格式（year=整型值）傳給函數year_archive


    # 問題二解決方法：用一個int轉換器可以替代多處正則表達式
    path('articles/<int:article_id>/detail/', views.detail_view), 
    path('articles/<int:article_id>/edit/', views.edit_view),
    path('articles/<int:article_id>/delete/', views.delete_view),
]

強調：

#1、path與re_path或者1.0中的url的不同之處是，傳給path的第一個參數不再是正則表達式，而是一個完全匹配的路徑，相同之處是第一個參數中的匹配字符均無需加前導斜杠

#2、使用尖括號(<>)從url中捕獲值，相當於有名分組

#3、<>中可以包含一個轉化器類型（converter type），比如使用 <int:name> 使用了轉換器int。若果沒有轉化器，將匹配任何字符串，當然也包括了 / 字符

django默認支持一下5種轉換器（Path converters）

str,匹配除了路徑分隔符（/）之外的非空字符串，這是默認的形式
int,匹配正整數，包含0。
slug,匹配字母、數字以及橫杠、下划線組成的字符串。
uuid,匹配格式化的uuid，如 075194d3-6885-417e-a8a8-6c931e272f00。
path,匹配任何非空字符串，包含了路徑分隔符（/）（不能用？）

例如

path('articles/<int:year>/<int:month>/<slug:other>/', views.article_detail) 
# 針對路徑http://127.0.0.1:8000/articles/2009/123/hello/，path會匹配出參數year=2009,month=123,other='hello'傳遞給函數article_detail

很明顯針對月份month，轉換器int是無法精准匹配的，如果我們只想匹配兩個字符，那么轉換器slug也無法滿足需求，針對等等這一系列復雜的需要，我們可以定義自己的轉化器。轉化器是一個類或接口，它的要求有三點：

• regex 類屬性，字符串類型

• to_python(self, value) 方法，value是由類屬性 regex 所匹配到的字符串，返回具體的Python變量值，以供Django傳遞到對應的視圖函數中。

• to_url(self, value) 方法，和 to_python 相反，value是一個具體的Python變量值，返回其字符串，通常用於url反向引用。

自定義轉換器示例：

1. 在app01下新建文件path_ converters.py,文件名可以隨意命名

   class MonthConverter:
       regex='\d{2}' # 屬性名必須為regex
   
       def to_python(self, value):
           return int(value)
   
       def to_url(self, value):
           return value # 匹配的regex是兩個數字，返回的結果也必須是兩個數字
   

2. 在urls.py中，使用register_converter 將其注冊到URL配置中：

   from django.urls import path,register_converter
   from app01.path_converts import MonthConverter
   
   register_converter(MonthConverter,'mon')
   
   from app01 import views
   
   
   urlpatterns = [
       path('articles/<int:year>/<mon:month>/<slug:other>/', views.article_detail, name='aaa'),
   
   ]
   

3. views.py中的視圖函數article_detail

   from django.shortcuts import render,HttpResponse,reverse
   
   def article_detail(request,year,month,other):
       print(year,type(year))
       print(month,type(month))
       print(other,type(other))
       print(reverse('xxx',args=(1988,12,'hello'))) # 反向解析結果/articles/1988/12/hello/
       return HttpResponse('xxxx')
   

4. 測試

   # 1、在瀏覽器輸入http://127.0.0.1:8000/articles/2009/12/hello/，path會成功匹配出參數year=2009,month=12,other='hello'傳遞給函數article_detail
   # 2、在瀏覽器輸入http://127.0.0.1:8000/articles/2009/123/hello/，path會匹配失敗，因為我們自定義的轉換器mon只匹配兩位數字，而對應位置的123超過了2位