Django路由层(urls.py)

时间:2022-02-07 04:36:04

url路由配置实质上就是一个url与视图函数之间的映射表。

官方示例:

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:slug>/', views.article_detail),
]

基本规则:

  • 使用尖括号(<>)从url中捕获值。
  • 捕获值中可以包含一个转化器类型(converter type),比如使用 <int:name> 捕获一个整数变量。若果没有转化器,将匹配任何字符串,当然也包括了 / 字符。
  • 无需添加前导斜杠

path和re_path

path() 具有四个参数,两个必选参数:route 和 view,两个可选参数:kwargs 和 name
  route 是一个匹配 URL 的准则(类似正则表达式)。当 Django 响应一个请求时,它会从 urlpatterns 的第一项开始,按顺序依次匹配列表中的项,直到找到匹配的项。这些准则不会匹配 GET 和 POST 参数或域名。例如,URLconf 在处理请求 https://www.example.com/myapp/ 时,它会尝试匹配 myapp/ 。处理请求 https://www.example.com/myapp/?page=3 时,也只会尝试匹配 myapp/。
  view:当匹配到url时,就会调用它对应的视图函数,并传入一个 HttpRequest 对象作为第一个参数。
  kwargs:任意个关键字参数可以作为一个字典传递给目标视图函数。
  name:为url取一个别名,便于在 Django 的任意地方唯一地引用它,尤其是在模板中。这个有用的特性允许你只改一个文件就能全局地修改某个 URL 模式

测试:

urls.py

urlpatterns = [
    path('admin/', admin.site.urls), path('test_kwargs',views.test_kwargs,{"kwarg1":1,"kwarg2":2}), path('test_name',views.test_name,name="tn"), path('testname',views.testname), re_path(r're_test',views.test01), ]

 

views.py

 1 from django.shortcuts import render, HttpResponse,redirect
 2 
 3 # Create your views here.
 4 def test01(request):
 5     return HttpResponse("re_path test")
 6 
 7 def test_kwargs(request,kwarg1,kwarg2):
 8     return HttpResponse("test_kwargs:kwarg1+kwarg2="+str(kwarg1+kwarg2))
 9 
10 def test_name(request):
11     return HttpResponse("testname")
12 
13 def testname(request):
14     return redirect("tn")

re_path的参数和path基本相同,但route参数使用的是正则表达式(?P<name>pattern),而path使用的是转换器,例如<int:name>

django内置的转换器有如下几个: 

  • str- 匹配除路径分隔符之外的任何非空字符串'/'。如果转换器未包含在表达式中,则这是默认值。
  • int - 匹配零或任何正整数。返回一个int
  • slug - 匹配由ASCII字母或数字组成的任何slug字符串,以及连字符和下划线字符。例如, building-your-1st-django-site
  • uuid - 匹配格式化的UUID。要防止多个URL映射到同一页面,必须包含短划线并且字母必须为小写。例如,075194d3-6885-417e-a8a8-6c931e272f00。返回一个 UUID实例。
  • path- 匹配任何非空字符串,包括路径分隔符 '/'。这使您可以匹配完整的URL路径,而不仅仅是URL路径的一部分str

我们可以自定义转换器:

转化器是一个类或接口,它的要求有三点:
    regex 类属性,字符串类型
    to_python(self, value) 方法,value是由类属性 regex 所匹配到的字符串,返回具体的Python变量值,以供Django传递到对应的视图函数中。
    to_url(self, value) 方法,和 to_python 相反,value是一个具体的Python变量值,返回其字符串,通常用于url反向引用。

example:

新建一个MyConverter.py

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

 

在urls.py中使用register_converter注册

1 from django.contrib import admin
2 from django.urls import path,re_path,register_converter
3 from app01 import views,MyConverter
4 
5 register_converter(MyConverter.YearConverter, 'yyyy')
6 urlpatterns = [
7     path('test_my_converter/<yyyy:year>/',views.test_my_converter),
8 ]

 

在views.py中传入参数

1 from django.shortcuts import render, HttpResponse,redirect
2 
3 # Create your views here.
4 
5 def test_my_converter(request,year):
6     return HttpResponse("test_my_converter<br>year:"+str(year))

 

 

路由分发

使用include实现路由分发

example:

在项目文件夹下的urls.py

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

 

在app02下的urls.py

1 from django.urls import path
2 from app02 import views
3 
4 urlpatterns = [
5     path('test',views.test)
6 ]

 

在app02下的views.py

from django.shortcuts import HttpResponse

# Create your views here.
def test(request):
    return HttpResponse("路由分发")

 

Namespace

命名空间(英语:Namespace)是表示标识符的可见范围。一个标识符可在多个命名空间中定义,它在不同命名空间中的含义是互不相干的。这样,在一个新的命名空间中可定义任何标识符,它们不会与任何已有的标识符发生冲突,因为已有的定义都处于其它命名空间中。
由于name没有作用域,Django在反解URL时,会在项目全局顺序搜索,当查找到第一个name指定URL时,立即返回。
我们在开发项目时,会经常使用name属性反解出URL,当不小心在不同的app的urls中定义相同的name时,可能会导致URL反解错误,为了避免这种事情发生,引入了命名空间。

example:

项目文件夹下的urls.py

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

 

app01下的urls.py

1 from django.urls import path
2 from app01 import views
3 app_name='app01'
4 
5 urlpatterns = [
6     path('test',views.test,name='test')
7 ]

 

app02下的urls.py

1 from django.urls import path
2 from app02 import views
3 app_name='app02'
4 
5 urlpatterns = [
6     path('test',views.test,name='test')
7 ]

 

app01下的viewspy

1 from django.shortcuts import HttpResponse
2 from django.urls import reverse
3 # Create your views here.
4 def test(request):
5     return HttpResponse(reverse("app01:test"))

 

app02下的views.py

1 from django.shortcuts import HttpResponse
2 # from django.core.urlresolvers import reverse
3 from django.urls import reverse
4 # Create your views here.
5 def test(request):
6     return HttpResponse(reverse("app02:test"))

 

反向解析


在使用Django 项目时,一个常见的需求是获得URL 的最终形式,以用于嵌入到生成的内容中(视图中和显示给用户的URL等)或者用于处理服务器端的导航(重定向等)。人们强烈希望不要硬编码这些URL(费力、不可扩展且容易产生错误)或者设计一种与URLconf 毫不相关的专门的URL 生成机制,因为这样容易导致一定程度上产生过期的URL。
在需要URL 的地方,对于不同层级,Django 提供不同的工具用于URL 反查:
  在模板中:使用url 模板标签。
  在Python 代码中:使用from django.urls import reverse()函数

example(在模板中):

<a href="{% url 'app01:test' %}">app01反向解析</a><br/>
<a href="{% url 'app01:test_contain_pattern' 2019 %}">app01反向解析带参数</a>

 

example(在python中):

  如namespace中所示

注意:

  在二级路由(也即app的urls文件中),在urlpatterns后,应该加上app_name='app_name(app名称)',否则会报错。