本文主要記了一些Django中URL映射相關的知識點，包括URL映射關系配置、URL傳參、URL反轉等，本文為學習筆記，僅供參考，
一、URL映射關系配置
URL映射關系默認是配置在主app下urls.py中的urlpatterns串列中，如果想要自己指定配置映射關系所在檔案，只需要修改主app中settings.py檔案中的ROOT_URLCONF配置項即可，但是urlpatterns這個變數是固定的，無法修改，所以修改ROOT_URLCONF配置項之后，Django就會到你指定的檔案中查找urlpatterns變數，并根據這個串列中的映射關系來進行URL的映射，
urlpatterns串列中的元素是一個經過path或re_path函式包裝后的結果，這兩個函式都在django.urls中，直接匯入使用即可，這兩個函式的用法都是相似的，不同之處在于，re_path的route引數（即URL）需要使用正則運算式，如果對URL沒有特殊要求的話，建議盡量使用path就可以了，
path函式常見用法有兩種：
- 一種是直接傳入URL字串和對應視圖函式兩個引數即可，例如
path('article/page/2/', views.page_detail)，第一個route引數為URL字串，第二個view引數為URL對應的視圖函式，通常情況下兩個引數已經夠用了，但是如果想要給這個URL命令，以便用于URL的反轉，可以指定name引數， - 另一種是指定子app的URL前綴以及使用
include函式包裝的子appurls.py路徑，例如path('articel/', include('article.urls'))，第一個route引數只需要指定子app的URL前綴，不需要給出完整的URL字串，第二個view引數為通過django.urls.include包裝后的子appurls.py路徑，這種用法涉及到URL的分層管理，可以參考后面“URL分層管理”小節，
二、URL傳參
1、URL查詢字串
URL中查詢字串的引數直接使用視圖函式的第一個引數request.GET進行獲取即可，查詢字串通常是通過GET方式發送的請求，所以查詢字串的資訊可以在request.GET中得到，而這個變數是一個類似字典的資料結構，直接使用它的get方法進行獲取即可，
示例：訪問http://127.0.0.1:8000/book/author/?id=3，對應的視圖函式如下
def author_detail(request):
author_id = request.GET.get('id')
text = '作者的ID是：{}'.format(author_id)
return HttpResponse(text)
2、URL引數傳遞
如果想要URL字串中的某部分變成引數傳遞給視圖函式，可以在指定URL字串時使用尖括號<param_name>將對應引數括起來，并在視圖函式中定義相同名稱的引數即可，當然，也可以在URL字串中定義多個引數，只需要在視圖函式中按順序定義同樣的引數來接收即可，
注：可以給視圖函式的引數指定默認值，訪問時如果URL中沒有傳入該引數則會使用該引數的默認值，
"""視圖函式代碼"""
from django.http import HttpResponse
def book(request):
return HttpResponse("圖書首頁！")
# 注意此處的book_id必須與URL中的引數<book_id>是相同的
def book_detail(request, book_id):
text = "你獲取的圖書id是：{}".format(book_id)
return HttpResponse(text)
"""URL映射關系配置代碼"""
urlpatterns = [
path('admin/', admin.site.urls),
path('book/', book),
path('book/detail/<book_id>/', book_detail)
]
注：使用re_path時，傳參使用正則運算式的分組命名方式，即(?P<param_name>)，這個引數名與視圖函式的引數名也是一一對應的，
3、使用URL型別轉換器指定引數型別
URL字串中傳遞給視圖函式的引數默認都是字串型別的，即使用的是默認的URL型別轉換器str，如果想要給引數指定為別的型別，如int型別，則需要使用形如<int:book_id>來進行引數型別指定，注意，如果指定了URL型別，那么在視圖函式中拿到的該引數也是對應的資料型別，例如指定了引數為int型別，不僅URL字串中該部分必須滿足int型別要求，而且視圖函式中該引數拿到后也是Python中對應的int型別，
Django中有一些內置的URL型別轉換器，都在from django.urls import converters中，可自行查看，常用的有以下幾種：
int：必須是0到9之間的一個或多個數字，str：除了斜杠/之外的一個或多個任意字符，（也是默認的引數型別）uuid：一個uuid字串，可以使用Python內置庫方法來生成import uuid;uuid.uuid4()，slug：滿足正則[-a-zA-Z0-9_]+的所有字串，path：一個或多個任意字符（斜杠/也可以），
4、自定義URL型別轉換器
自定義URL型別轉換器其實也是根據內置的轉換器寫法來進行自定義的，可以參考from django.urls import converters中內置轉換器的原始碼，一個自定義的url型別轉換器通常分為三部分：regex正則運算式（轉換規則）、to_python函式（將url中的引數處理之后再傳入視圖函式）和to_url函式（將引數處理之后再拼接到url之中），定義好轉換器之后，需要使用from django.urls import register_converter將轉換器注冊到Django中，
示例代碼如下：
"""直接定義在urls.py中"""
from django.urls import path
from . import views
from django.urls import register_converter
# 自定義URL型別轉換器：將URL中類似python+django+flask的字串
# 轉換為以+分隔的串列傳入視圖函式中，反轉為URL時再以+拼接到URL中
class CategoryConverter:
regex = r'\w+|\w+(\+\w+)+'
def to_python(self, value):
# 此方法是將url中的引數處理之后再傳入對應的視圖函式中
# value：python+django+flask
return value.split('+')
def to_url(self, value):
# 此方法是將在reverse反轉時給url傳入的引數處理之后再放入url中，形成最終的url
# value：['python', 'django', 'flask']
return '+'.join(value)
# 注冊自定義的轉換器
register_converter(CategoryConverter, 'cate')
urlpatterns = [
path('', views.article),
# 使用自定義的轉換器
path('list/<cate:categories>/', views.article_list, name='list')
]
"""views.py"""
def article_list(request, categories):
# 如果訪問：http://127.0.0.1:8000/article/list/python+django+flask/
# 列印結果為：/article/list/python+django+flask/
print(reverse('list', kwargs={'categories': categories}))
text = '文章分類是：{}'.format(categories)
return HttpResponse(text)
注：url轉換器定義的檔案一定要在運行時得到執行，不然無法進行注冊，可以放在urls.py中，也可以將定義轉換器的檔案在包的__init__.py檔案中進行匯入，
三、URL分層管理
當新建的app較多時，不宜將所有的URL映射都放在主app（該app通常與專案同名）的urls.py檔案中，就像app下的views.py、models.py等檔案（使用命令視窗的命令創建app時，會自動生成這些檔案），用專門的檔案來管理各自的功能，推薦在app下新建一個urls.py檔案，用來專門管理當前app的所有URL映射關系，這樣也方便開發人員的維護和管理，
URL的分層管理需要注意以下兩點：
- 在子app下新建一個
urls.py（檔案名稱可以自己取，但是通常就命名為urls.py即可，方便辨認），然后在里面同樣定義一個urlpatterns變數，注意，這個urlpatterns中的URL字串不用再添加子app對應的URL前綴了， - 在主app的
urls.py的urlpatterns變數中添加一個URL映射，第一個引數為子app的URL前綴，第二個引數為from django.urls import include包裝的子app對應的urls.py檔案路徑（此路徑為相對于專案根目錄的相對路徑），
"""主app的urls.py檔案內容"""
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
# 這里只需要添加app的url前綴和對應urlpattterns變數所在檔案的路徑即可
path('book/', include('book.urls'))
]
"""子app“book”目錄中的urls.py檔案內容"""
from django.urls import path
from .views import book, book_detail
# 這里不用再添加app的url前綴了
urlpatterns = [
path('', book),
path('detail/<book_id>/', book_detail)
]
四、URL反轉
URL反轉表示根據一個名稱就可以得到對應的完整URL字串，而不用自己每次手動撰寫完整的URL，如果專案中許多地方都會用到某個URL，就可以考慮使用URL反轉了，URL反轉需要用到from django.shortcuts import reverse，基本用法為：使用形如reverse(url_name)即可得到對應的URL，
1、URL命名
想要給URL命名，在配置URL映射關系時，給path函式指定name引數即可，然后使用reverse(url_name)函式反轉就可以得到對應名稱的URL了，
"""配置URL映射關系"""
from django.urls import path
from hello_world import views
urlpatterns = [
# 使用name引數給當前URL指定名稱
path('index/', views.index, name='index')
]
"""視圖函式定義"""
from django.shortcuts import render, reverse
def index(request):
# 獲取名稱為index的URL，列印結果為：/index/
print(reverse('index'))
return render(request, 'index.html')
2、app應用命名空間和實體命名空間
配置app應用命名空間是為了規避產生同名URL的情況，app應用命令空間的配置是直接在對應app目錄的urls.py中定義一個app_name=xxx的變數即可，反轉時加上對應的app_name即可，如reverse('app_name:url_name')，
from django.urls import path
from . import views
# 配置app應用命令空間
app_name = 'front'
urlpatterns = [
path('', views.index),
# 給URL指定名稱
path('login/', views.login, name='login'),
]
from django.http import HttpResponse
from django.shortcuts import redirect, reverse
def index(request):
username = request.GET.get('username')
if username:
return HttpResponse('前臺 首頁！')
else:
# 反轉時使用“app應用命名空間:url名稱”的格式
return redirect(reverse('front:login'))
使用實體命名空間是為了規避不同的URL映射到了相同的urls.py中，即不同的實體映射到了同一個app上，此時反轉得到的URL可能就不是我們想要的了，實體命名空間配置是在主app中配置子app的URL前綴時的include中指定其namespace引數，然后再使用request.resolver_match.namespace獲取當前實體命名空間即可，此時就不再使用應用命名空間了（雖然配置了），注意，指定實體命名空間時必須同時指定應用命名空間，單獨指定實體命名空間是不可以的，程式會報錯，
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
# 在include中指定namespace命名空間
# 不同的前綴指向了相同的urls.py檔案，所以只用app應用空間是不夠的
# 需要再指定namespace命名空間，即實體命名空間
path('cms1/', include('cms.urls', namespace='cms1')),
path('cms2/', include('cms.urls', namespace='cms2')),
path('', include('front.urls'))
]
from django.http import HttpResponse
from django.shortcuts import redirect, reverse
def index(request):
username = request.GET.get('username')
if username:
return HttpResponse('cms 首頁！')
else:
# 獲取當前所處的實體命名空間
current_namespace = request.resolver_match.namespace
return redirect(reverse('{}:login'.format(current_namespace)))
五、其他函式
1、django.urls.include
include有三種用法：include(module, namespace=None)、include((pattern_list, app_namespace), namespace=None和include(pattern_list)，它們的引數使用如下：
module：子URL的模塊字串（即對應app的urls.py檔案路徑），namespace：實體命名空間，需要注意的是，指定實體命名空間時，需要同時指定對應的app應用命名空間（在對應app的urls.py中配置變數app_name），pattern_list：一個子URL的模塊字串或者path物件的串列，后者相當于是在path的第一個引數指定了子app的URL前綴，如果這個子app下有多個URL，就可以直接放在這個pattern_list串列中，app_namespace：應用命名空間，注意，應用命名空間既可以在include中指定，也可以通過在子app的urls.py中配置app_name的方式來指定，namespace：實體命名空間，
2、django.shortcuts.reverse
reverse用于url的反轉，通常只需要在path中指定name引數即可（必要的時候也可以指定app應用命名空間或實體命名空間），如果url中含有引數，則需要在使用reverse時傳入kwargs引數，以字典的形式將引數傳入，
注：如果是查詢字串的引數，則需要reverse反轉之后自己手動進行拼接url字串，
"""視圖函式"""
from django.http import HttpResponse
from django.shortcuts import reverse, redirect
def index(request):
username = request.GET.get('username')
if username:
return HttpResponse('首頁')
else:
# detail對應的url映射為：path('detail/<article_id>/', article_detail, name='detail'),
detail_url = reverse('detail', kwargs={'article_id': 333})
# 如果需要傳入查詢字串，則需要自己手動進行拼接，如：detail_url += '?username=xxx'
return redirect(detail_url)
def article_detail(request, article_id):
text = '文章的id是：{}'.format(article_id)
return HttpResponse(text)
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/166768.html
標籤：Python