Django之路由层
URL配置(URLconf)就像Django所支撑网站的目录。它的本指是URL与要为该URL调用的视图函数之间的映射表,你就是以这种方式告诉Django,对于客户端发来的某个URL调用哪一段逻辑代码对应执行。
一、简单的路由配置
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这个字符串是“原始的”——字符串中任何字符都不应该转义。
一些请求的例子:
/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')。
二、有名分组
上面的示例使用简单的、没有命名的正则表达式(通过圆括号)来捕获URL中的额值并以位置参数传递给视图。在更高级的用法中,可以使用命名的正则表达式组来捕获URL中的值并以关键字参数传递给视图。在Python正则表达式中,命名正则表达式组的语法是(?P
,其中name是组的名称,pattern是要匹配的模式。下面是以上URLconf使用命名组的重写:
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[0-9]{4})/$', views.year_archive),
re_path(r'^articles/(?P[0-9]{4})/(?P[0-9]{2})/$', views.month_archive),
re_path(r'^articles/(?P[0-9]{4})/(?P[0-9]{2})/(?P[0-9]{2})/$', views.article_detail),
]
这个实现与前面的示例完全相同,只有一个细微的差别:捕获的值作为关键字参数而不是位置参数传递给视图函数。例如:
/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')。
三、分发
'''
At any point, your urlpatterns can “include” other URLconf modules. This
essentially “roots” a set of URLs below other ones.
'''
from django.urls import path,re_path,include
from app01 import views
urlpatterns = [
re_path(r'^admin/', admin.site.urls),
re_path(r'^blog/', include('blog.urls')),
]
四、反向解析
在使用Django项目时,一个常见的需求是获得URL的最终形式,以用于嵌入到生成的内容中(视图中和显示给用户的URL等)或者用于处理服务器端的导航(重定向等)。人们强烈希望不要硬编码这些URL(费力、不可扩展且容易产生错误)或者设计一种与URLconf毫不相关的专门的URL生成机制,因为这样容易导致一定程度上产生过期的URL。在需要URL的地方,对于不同层级,Django提供不同的额工具用于URL反查:
1、在模板中:使用URL模板标签。
2、在Python代码中:使用from django.urls import reverse
函数 urls.py:
from django.conf.urls import url
from . import views
urlpatterns = [
#...
re_path(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'),
#...
]
在模板中:
2012 Archive
{% for yearvar in year_list %}
- {{ yearvar }} Archive
{% endfor %}
在python中:
from django.urls import reverse
from django.http import HttpResponseRedirect
def redirect_to_year(request):
# ...
year = 2006
# ...
return HttpResponseRedirect(reverse('news-year-archive', args=(year,))) # 同redirect("/path/")
当命名你的URL模式时,请确保使用的名称不会与其它应用中名称冲突。如果你的URL模式叫做comment,而另外一个应用中也有一个同样的名称,当你在模板中使用这个名称的时候不能保证将插入哪个URL。在URL名称中加上一个前缀,比如应用的名称,将减少冲突的可能。我们建议使用myapp-comment 而不是 comment。
五、名称空间
命名空间(Namespace)是标识符的可见范围。一个标识符可在多个命名空间中定义,它在不同命名空间中的含义是互不相干的。这样,在一个新的命名空间中可定义任何标识符,它们不会与任何已有的标识符发生冲突,因为已有的定义都处于其它命名空间中。由于name没有作用域,Django在反解URL时,会在项目全局顺序搜索,当查找到第一个name指定URL时,立即返回。我们在开发项目时,会经常使用name属性反解出URL,当不小心在不同的app的urls中定义相同的name时,可能会导致URL反解错误,为了避免这种事情发生,引入了命名空间。
在项目的urls.py中:
urlpatterns = [
re_path(r'^admin/', admin.site.urls),
re_path(r'^app01/', include(("app01.urls",namespace="app01"))),
re_path(r'^app02/', include(("app02.urls",namespace="app02"))),
]
app01.urls:
urlpatterns = [
re_path(r'^index/', index,name="index"),
]
app02.urls:
urlpatterns = [
re_path(r'^index/', index,name="index"),
]
app01.views:
from django.core.urlresolvers import reverse
def index(request):
return HttpResponse(reverse("app01:index"))
app02.views:
from django.core.urlresolvers import reverse
def index(request):
return HttpResponse(reverse("app02:index"))
六、Django2.0版本的path
urlpatterns = [
re_path('articles/(?P[0-9]{4})/', year_archive),
re_path('article/(?P[a-zA-Z0-9]+)/detail/', detail_view),
re_path('articles/(?P[a-zA-Z0-9]+)/edit/', edit_view),
re_path('articles/(?P[a-zA-Z0-9]+)/delete/', delete_view),
]
考虑一下这样的两个问题:
1、函数year_archive中year参数是字符串类型,因此需要先转换为整数类型的变量值,当然year = int(year)不会有诸如TypeError或者VaError的异常。那么有没有一种方法,在url中,使得这一转换步骤可以由Django自动完成?
2、三个路由中article_id规则改变后,需要同时修改三处代码,那么有没有一种方法,只需要修改一处即可?
在Django2.0版本中,可以使用path解决以上的两个问题。
简单示例:
from django.urls import path
from . import views
urlpatterns = [
path('articles/2003/', views.special_case_2003),
path('articles//', views.year_archive),
path('articles///', views.month_archive),
path('articles////', views.article_detail),
]
基本规则:
1、使用尖括号<>
从url中捕获值。
2、捕获值中可以包含一个转换器类型(converter type),比如使用/
字符。
3、无需添加前导斜杠。
以下是根据https://docs.djangoproject.com/en/2.0/topics/http/urls/#example而整理的示例分析表:
path转换器:
文档原文是Path converters,暂且翻译为转换器。
Django默认支持以下5个转换器:
1、str——匹配除了路径分隔符/
之外的非空字符串,这是默认的形式。
2、int——匹配正整数,包含0。
3、slug——匹配字母、数字以及横杠、下划线组成的字符串。
4、uuid——匹配格式化的uuid,如075194d3-6885-417e-a8a8-6c931e272f00。
5、path——匹配任何非空字符串,包含了路径分隔符。
注册自定义转换器:
对于一些复杂或者复用的需要,可以定义自己的转换器。
转换器是一个类或者接口,它的要求有三点:
1、regex类属性,字符串类型。
2、to_python(self, value)方法,value是由类属性regex所匹配到的字符串没返回具体的Python变量值,以供Django传递到对应的视图函数中。
3、to_url(self, value)方法,和to_python相反,value是一个具体的Python变量值,返回其字符串,通常用于url反向引用。
示例:
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配置中:
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//', views.year_archive),
...
]