Django路由層如何獲取正確的url

更新時間：2021年07月15日 11:35:14 作者：程序媛小莊

本文介紹路由層是如何進行路由匹配的，以diango1.x版本為例，文中通過示例代碼介紹的非常詳細，文中通過示例代碼介紹的非常詳細，

前言

客戶端瀏覽器訪問Django后端時通過網(wǎng)關(guān)和中間件之后會首先在路由層進行路由匹配，只有路由匹配成功之后才能執(zhí)行對應的視圖函數(shù)內(nèi)的邏輯進行數(shù)據(jù)的處理，本文就來介紹路由層(以diango1.x版本為例)是如何進行路由匹配的？

Tips - django版本區(qū)別

在django1.x版本和django2.x及更高版本之間有些許不同，不同點之一就是路由層的路由表達式，路由表達式之間的不同具體如下述表格：

區(qū)別	django1.x	django2.x or 3.x
方法	url方法`from django.conf.urls import url`	path方法`from django.urls import path`
url參數(shù)	第一個參數(shù)支持正則表達式	第一個參數(shù)不支持正則表達式

如果url參數(shù)習慣使用正則表達式，2.x和3.x版本的django也提供了另一個方法re_path，該方法就等價于django1.x版本中的path。

# django2.x版本的urls.py
from django.contrib import admin
from django.urls import path,re_path
from app01 import views
urlpatterns = [
    path('admin/', admin.site.urls),
    path('index',views.index),
    re_path('^index/\d+',views.index),
]

路由匹配

這里我們以django1.x版本進行說明django如何進行路由匹配？django1.x版本中路由與視圖的對應關(guān)系是通過url方法實現(xiàn)的，而url方法的第一個參數(shù)url的正則表達式，只要客戶端瀏覽器訪問的url能夠和某一個路由成功匹配，就會立刻停止繼續(xù)匹配之后的路由，直接執(zhí)行第一個匹配到的視圖函數(shù)，這樣就會產(chǎn)生一個問題，如下述代碼：

urlpatterns = [
    url(r'test',views.test),
    url(r'testadd',views.testadd),
]

# 127.0.0.1:8080/testadd 會直接和第一個路由匹配上，永遠運行不了下面testadd頁面

如何解決上述問題呢？可以指定路由的正則表達式必須以什么開始以什么結(jié)尾，并且正則表達式不能為空，否則會匹配所有的url，導致后面的頁面無法訪問，因此使用正則表達式的url時可以采用下述解決方式：

urlpatterns = [
    # 首頁,正則表達式不能寫空，否則會匹配所有的url后綴，而導致后面的頁面無法訪問
    url(r'^$',views.home),
 # ^是指匹配的字符必須以什么開始 $是指匹配的字符必須以什么結(jié)尾
    url(r'^test/$',views.test),
    url(r'testadd/',views.testadd),
]

無名分組&有名分組

首先來看什么分組？分組的意思簡單來講就是給某一段正則表達式用小括號括起來。無名分組的意思簡單理解就是分組之后的正則表達式?jīng)]有名字而有名分組就是分組之后正則表達式有名字。~真是深刻的理解。。。

無名分組

無名分組會將分組后括號內(nèi)的正則表達式匹配到的內(nèi)容當做位置參數(shù)傳遞給對應的視圖函數(shù)。

# urls.py
urlpatterns = [
    url(r'test/(\d+)', views.test),   # \d+表示匹配數(shù)字
]

# views.py
def test(request, xx):  #  形參xx可以是任意的
    print(xx)
    return HttpResponse('test')

如果在瀏覽器中訪問127.0.0.1:8000/test/100(數(shù)字可以是隨意的)，在pycharm的終端中就會輸出100，如果在視圖函數(shù)test中不增加形參xx就會報錯。報錯信息如下：

TypeError: test() takes 1 positional argument but 2 were given

翻譯為test函數(shù)只有一個形參但是卻給了兩個實參，因此必須增加一個形參來接收另一個實參。而另一個實參就是無名分組中的正則表達式匹配到的內(nèi)容。

有名分組

就是給被分組了的正則表達式起一個別名,將括號內(nèi)正則表達式匹配到的內(nèi)容當作關(guān)鍵字參數(shù)傳遞給對應的視圖函數(shù)。

# urls.py
urlpatterns = [
    url(r'test/(?P<id>\d+)',views.test),   # \d+表示匹配數(shù)字, id就是分組的正則表達式的名字
]

# views.py
def test(request, id):  # 使用有名分組時，視圖函數(shù)的形參名字必須與有名分組的名字一致
    print(id)
    return HttpResponse('xx')

如果在瀏覽器中訪問127.0.0.1:8000/test/100(數(shù)字可以是隨意的)，在pycharm的終端中就會輸出100，如果在視圖函數(shù)test中形參名字與有名分組的名字不一致，則會報錯，報錯信息如下：

TypeError: test() got an unexpected keyword argument 'id'

翻譯為test函數(shù)得到了一個它不需要的關(guān)鍵字參數(shù)id。因此使用有名分組時視圖函數(shù)的形參必須和有名分組的名字一致。

小提示

有名分組和無名分組不能同時使用，但是每一種分組可以重復使用多次，同時在視圖函數(shù)中必須有對應數(shù)量的形參進行值的接收。

url(r'test/(\d+)/(\d+)/(\d+)',views.test)
url(r'test/(?P<id1>\d+)/(?P<id2>\d+)/(?P<id3>\d+)', views.test)

反向解析

前端瀏覽器發(fā)送過來一條url請求，該url會匹配到一個負責該請求的視圖函數(shù)（可能同時給視圖函數(shù)提供一些傳參），此為正向匹配。
從視圖函數(shù)綁定關(guān)系的別名出發(fā)（可能需要一些參數(shù)），尋找一條完整url的過程是反向，所謂解析就是通過別名（或者說是url匹配關(guān)系的別名，又或者url-pattern的別名）外加一些參數(shù)，獲取一條完整的url。

正向匹配： url --------------------------------> 視圖函數(shù)(+參數(shù))
反向解析：別名(參數(shù)) ----------------------------------> url

使用反向解析的目的就是在前端HTML頁面中更加方便的獲取一條url，避免硬編碼減少程序維護的復雜度。那么如何使用反向解析呢？使用反向解析分為兩步：
①在路由匹配文件urls.py中為路由設(shè)置別名；
②在視圖函數(shù)或者在HTML頁面中使用別名。

使用反向解析也分為兩種情況，一種是路由不涉及分組的情況，另一種就是有名分組和無名分組的反向解析。

路由不涉及分組的反向解析

首先需要在urls.py為路由和視圖函數(shù)的對應關(guān)系設(shè)置別名，代碼如下：

urlpatterns = [
    re_path('index/', views.index, name='index'),
    re_path('test/', views.test, name='test') # 路由與視圖函數(shù)的對應關(guān)系別名name為test, 可以是任意的，但是必須唯一
]

設(shè)置好路由與視圖函數(shù)的對應關(guān)系的別名之后就可以在后端或者前端HTML頁面進行反向解析了，通過別名獲取url。

# views.py - 在后端視圖函數(shù)中反向解析，需要借助模塊實現(xiàn)動態(tài)解析
from django.shortcuts import render, redirect, HttpResponse, reverse


# Create your views here.
def index(request):
    return HttpResponse('index')


def test(request):
    return redirect(reverse('index'))

上述代碼當訪問127.0.0.1:8000/test/時就會通過test函數(shù)重定向，而重定向的url就是通過reverse方法進行反向解析得到的index/路由。

當然在前端HTML頁面上也可以通過模板語法進行反向解析的操作，同樣是通過別名找到對應關(guān)系解析出url后執(zhí)行對應的視圖函數(shù)。

# views.py
from django.shortcuts import render, redirect, HttpResponse


# Create your views here.
def index(request):
    return HttpResponse('index')


def test(request):
    return render(request, 'render_html.html')

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<a href={% url 'index' %}>click me</a>  <!--通過{% url '別名' %}的語法格式對后端的別名進行解析，點擊即可跳轉(zhuǎn)到index/路由-->
</body>
</html>

有名分組&無名分組的反向解析

有名分組和無名分組的反向解析與不分組時有一些不同，有名分組和無名分組反向解析在url.py中的設(shè)置和沒有分組時的設(shè)置操作是一致的，都是通過參數(shù)name為路由和視圖函數(shù)的對應關(guān)系起一個別名，但是在存在分組的情況下反向解析時不僅要提供別名還需要路由正則表達式分組中需要的數(shù)據(jù)，有名分組時反向解析時提供數(shù)據(jù)的方式不論是在前端還是后端都有兩種方式，其中一種是有名分組和無名共有的方式。

首先看無名分組的反向解析：

# urls.py
urlpatterns = [
    re_path('index/(\d+)', views.index, name='index'),
    re_path('test/', views.test, name='test')
]

-----------------------------------------無名分組后端反向解析-------------------------------
# views.py  - 后端的反向解析
def index(request, x):
    return HttpResponse('index')

def test(request):
    # 參數(shù)必須是以元組的形式，并且參數(shù)必須能夠和正則表達式中的分組部分匹配，否則會報錯，Reverse for 'func' with no arguments not found. 1 pattern(s) tried: ['index/(\\d+)']
    return redirect(reverse(viewname='index', args=(1,))) 


-----------------------------------------無名分組前端反向解析--------------------------------
# views.py
def index(request, x):
    return HttpResponse('index')

def test(request):
    return render(request, 'render_html.html')

# render_html.html
<body>
<a href={% url 'index' 1 %}>click me</a>   # {% url 別名 分組匹配的參數(shù) %}
</body>

下面再來看有名分組的方向解析，有名分組的反向解析有兩種實現(xiàn)方式，第一種與無名分組一致，另一種代碼如下：

# urls.py
urlpatterns = [
    re_path('index/(?P<id>\d+)', views.index, name='index'),
    re_path('test/', views.test, name='test')
]

----------------------------------------有名分組反向解析 - 后端反向解析-----------------------
# views.py
def index(request, id):
    return HttpResponse('index')

def test(request):
    # 匹配有名分組的參數(shù)是字典的格式字典的key就是有名分組的名字
    return redirect(reverse(viewname='index', kwargs={'id': 2}))

--------------------------------------有名分組反向解析 - 前端反向解析-------------------------
# views.py
def index(request, id):
    return HttpResponse('index')

def test(request):
    return render(request, 'render_html.html')

# render_html.html
<body>
<a href={% url 'index' id=2 %}>click me</a>  # {% url 別名 有名分組名字=分組匹配的參數(shù)%} 
</body>

路由分發(fā)

django每一個應用都可以有自己的urls.py/templates文件夾/static文件夾，基于這一點django可以非常好的實現(xiàn)分組開發(fā)，每個人只寫自己負責的應用部分即可，那么又如何將不同的應用整合到一起呢？只需要將所有的應用復制到一個新的django項目中(git協(xié)同開發(fā)后期再講...)然后在配置文件中注冊所有的應用最后利用路由分發(fā)將所有應用整合，**路由分發(fā)就是識別當前url屬于哪個應用下的，然后直接分發(fā)給對應的應用再做進一步的處理。**使用路由分發(fā)需要在每個應用下創(chuàng)建urls.py稱為子路由，原本的urls.py稱為總路由，比如說一個django項目中創(chuàng)建了兩個應用分別是first和second，路由分發(fā)可以通過如下方式實現(xiàn)：

----------------------------子路由文件---------------------------------------------------
# first應用下的urls.py - first_django/first/urls.py
from django.conf.urls import url
from first import views

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

# second應用下的urls.py - first_django/second/urls.py
from django.conf.urls import url
from second import views

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

-----------------------------------------總路由文件--------------------------------------
# first_django/first_django/urls.py
from django.conf.urls import url,include
from django.contrib import admin
from firstp import urls as first_url
from second import urls as second_url

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^first/',include(first_url)),
    url(r'^second/',include(second_url))
]

使用路由分發(fā)之后，訪問不同的應用下的url路由中必須表示該路由屬于哪個應用，比如訪問127.0.0.1:8000/first/test，表示先通過first到達總路由進行路由分發(fā)然后在first應用中在進行test/部分的匹配?？偮酚勺雎酚煞职l(fā)時url()的正則表達式參數(shù)不能以$結(jié)尾，必須以/結(jié)尾。

上述總路由文件還有一種簡化版的代碼，無需導入子路由，直接include子路由字符串，如下：

-----------------------------------------總路由文件--------------------------------------
# first_django/first_django/urls.py
from django.conf.urls import url,include
from django.contrib import admin
# from firstp import urls as first_url
# from second import urls as second_url

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^first/',include('first.urls')),
    url(r'^second/',include('first.urls'))
]

到此這篇關(guān)于Django路由層如何獲取正確的url的文章就介紹到這了,更多相關(guān)Django路由層獲取url內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: