Django02-路由系统urls

一、路由配置系统（URLconf）

分为：
静态路由
动态路由

1、URL配置

URL配置(URLconf)就像Django所支撑网站的目录。它的本质是URL与该URL调用的视图函数之间的映射表

语法：
urlpatterns = [
　　url(正则表达式, views视图函数，参数，别名),
]

参数说明：

一个正则表达式字符串
一个可调用对象，通常为一个视图函数或一个指定视图函数路径的字符串
可选的要传递给视图函数的默认参数（字典形式）
一个可选的name参数

例子：

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

urlpatterns = [
    url(r'^articles/2003/$', views.special_case_2003),
    url(r'^articles/([0-9]{4})/$', views.year_archive),
    url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
    url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]

2、Django 2.0推荐的新用法path

from django.urls import path
from . import views

urlpatterns = [
path('articles/2018/', views.article_2018),
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),
]

路由转换器Path converters匹配可以支持以下几种形式：

str 匹配任意非空字符串，除了/，例如path('articles/<str:name>/', views.name_archive)
int 匹配任意正整数
slug 可理解为注释 匹配任何ascii码包括连接线和下划线
uuid 匹配uuid格式，唯一机器码，例如path('articles/<uuid:uuid>/', views.name_archive)
path 匹配任意非空字符串，包括/，意思就是path前边和后边的所有，例如path('articles/<path:path>/', views.path_archive)

二、正则表达式详解

1、基本配置

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

urlpatterns = [
    url(r'^articles/2003/$', views.special_case_2003),
    url(r'^articles/([0-9]{4})/$', views.year_archive),
    url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
    url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]

2、注意事项

• urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式，一旦匹配成功则不再继续。
• 若要从URL中捕获一个值，只需要在它周围放置一对圆括号（分组匹配）。
• 不需要添加一个前导的反斜杠，因为每个URL 都有。例如，应该是^articles 而不是 ^/articles。
• 每个正则表达式前面的'r' 是可选的但是建议加上。
• 可以通过正则表达式\d+表示多个数字类型
• ^表示以什么开头，$表示以什么结尾，（a|b）表示a或b

3、补充说明

是否开启URL访问地址后，为不带/的路径跳转至带有/的路径的配置

APPEND_SLASH=True
Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数，但 Django 默认这个参数为 APPEND_SLASH = True。 其作用就是自动在网址结尾加'/'。

其效果就是：
我们定义了urls.py：

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

urlpatterns = [
    url(r'^blog/$', views.blog),
]
访问 http://www.example.com/blog 时，默认将网址自动转换为 http://www.example/com/blog/ 。
如果在settings.py中设置了 APPEND_SLASH=False，此时我们再请求 http://www.example.com/blog 时就会提示找不到页面。

三、分组命名匹配

1、基本配置

上面的示例使用简单的正则表达式分组匹配（通过圆括号）来捕获URL中的值，并以位置参数形式传递给视图。
在更高级的用法中，可以使用分组命名匹配的正则表达式组来捕获URL中的值，并以关键字参数形式传递给视图。
在Python的正则表达式中，分组命名正则表达式组的语法是(?P<name>pattern)，其中name是组的名称，pattern是要匹配的模式。

下面是以上URLconf 使用命名组的重写：

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

urlpatterns = [
    url(r'^articles/2003/$', views.special_case_2003),
    url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive),
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail),
]

?P表示分组匹配，<year>表示关键字key为year，匹配数字0-9，{4}表示匹配4次，返回一个字典year:xxxx
这个实现与前面的示例完全相同，只有一个细微的差别：捕获的值作为关键字参数而不是位置参数传递给视图函数。例如：
/articles/2005/03/ 请求将调用views.month_archive(request, year='2005', month='03')函数
/articles/2003/03/03/ 请求将调用函数views.article_detail(request, year='2003', month='03', day='03')。

在实际应用中，这意味你的URLconf 会更加明晰且不容易产生参数顺序问题的错误。你可以在你的视图函数定义中重新安排参数的顺序。但有些开发人员认为命名组语法丑陋而繁琐。至于究竟应该使用哪一种，你可以根据自己的喜好来决定。

2、URLconf匹配的位置

URLconf在请求的URL上查找，将它当做一个普通的Python字符串。不包括GET和POST参数以及域名。
例如，http://www.example.com/myapp/ 请求中，URLconf将查找/myapp/。
在http://www.example.com/myapp/?page=3 请求中，URLconf仍将查找/myapp/。

URLconf不检查请求的方法。换句话讲，所有的请求方法 —— 同一个URL的POST、GET、HEAD等等 —— 都将路由到相同的函数。

3、捕获的参数永远都是字符串

每个在URLconf中捕获的参数都作为一个普通的Python字符串传递给视图，无论正则表达式使用的是什么匹配方式。例如，下面这行URLconf 中：
url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
传递到视图函数views.year_archive() 中的year参数永远是一个字符串类型。

4、视图函数中指定默认值

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

urlpatterns = [
    url(r'^blog/$', views.page),
    url(r'^blog/page(?P<num>[0-9]+)/$', views.page),
]

# views.py中，可以为num指定默认值
def page(request, num=""):
    pass

在上面的例子中，两个URL模式指向相同的view - views.page - 但是第一个模式并没有从URL中捕获任何东西。
如果第一个模式匹配上了，page()函数将使用其默认参数num=“1”,如果第二个模式匹配，page()将使用正则表达式捕获到的num值。

5、include其他的URLconfs

当项目中的app数量较多时，所有的url和函数对应关系都写在同一个urls.py文件中是不合适的，应该将不同的app对应的url分别写到各自的urls.py文件中。
1、在每个app中创建urls.py子文件，分别编写各自的url和函数的对应关系
2、在项目的urls.py根文件中，使用include方法包含各个app中的子urls.py文件即可

例如在urls.py文件中使用include方法将以/blog/开头的url分配到blog.urls文件中

from django.conf.urls import include, url

urlpatterns = [
   url(r'^admin/', admin.site.urls),
   url(r'^blog/', include('blog.urls')),  # 可以包含其他的URLconfs文件
]

四、传递额外的选项给视图函数

URLconfs 具有一个钩子，让你传递一个Python字典作为额外的参数传递给视图函数。

django.conf.urls.url() 函数可以接收一个可选的第三个参数，它是一个字典，表示想要传递给视图函数的额外关键字参数。

例如：

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

urlpatterns = [
    url(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}),
]

在这个例子中，对于/blog/2005/请求，Django 将调用views.year_archive(request, year='2005', foo='bar')。
这个技术在Syndication 框架中使用，来传递元数据和选项给视图。

五、命名URL和URL反向解析

在使用Django项目时，一个常见的需求是获得URL的最终形式，以用于嵌入到生成的内容中（视图中和显示给用户的URL等）或者用于处理服务器端的导航（重定向等）。
人们强烈希望不要硬编码这些URL（费力、不可扩展且容易产生错误）或者设计一种与URLconf 毫不相关的专门的URL 生成机制，因为这样容易导致一定程度上产生过期的URL。
它允许设计的URL可以自动更新而不用遍历项目的源代码来搜索并替换过期的URL。

获取一个URL最开始想到的信息是处理它视图的标识（例如名字），查找正确的URL的其它必要的信息有视图参数的类型（位置参数、关键字参数）和值。

Django 提供一个办法是URL映射。填充你的URLconf，然后可以双向使用它：

• 根据用户/浏览器发起的URL请求，它调用正确的Django视图，并从URL中提取它的参数需要的值。
• 根据Django视图的标识和将要传递给它的参数的值，获取与之关联的URL。

简单来说就是可以给我们的URL匹配规则起个名字，一个URL匹配模式起一个名字。
这样我们以后就不需要写死URL代码了，只需要通过名字来调用当前的URL。

举个简单的例子：

url(r'^home', views.home, name='home'),  # 给我的url匹配模式起名为 home
url(r'^index/(\d+)', views.index, name='index'),  # 给我的url匹配模式起名为index

这样在模板里面可以这样引用：
{% url 'home' %}

在views函数中可以这样引用：
from django.urls import reverse
reverse("index", args=("", ))

例子：

考虑下面的URLconf：
from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'),
]

根据这里的设计，某一年nnnn对应的归档的URL是/articles/nnnn/。

你可以在模板的代码中使用下面的方法获得它们：
<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a>

<ul>
{% for yearvar in year_list %}
<li><a href="{% url 'news-year-archive' yearvar %}">{{ yearvar }} Archive</a></li>
{% endfor %}
</ul>

在Python 代码中，这样使用：
from django.urls import reverse
from django.shortcuts import redirect

def redirect_to_year(request):
    year = 2006
    return redirect(reverse('news-year-archive', args=(year,)))

如果出于某种原因决定按年归档文章发布的URL应该调整一下，那么你将只需要修改URLconf 中的内容，其他地方只需要仍然引用news-year-archive这个名称就可以了。

在某些场景中，一个视图是通用的，所以在URL和视图之间存在多对一的关系。对于这些情况，当反查URL时，只有视图的名字还不够。

注意：

为了完成上面例子中的URL 反查，你将需要使用命名的URL模式。URL的名称使用的字符串可以包含任何你喜欢的字符。不只限制在合法的Python名称。

• 当命名你的URL模式时，请确保使用的名称不会与其它应用中名称冲突。如果你的URL模式叫做comment，而另外一个应用中也有一个同样的名称，当你在模板中使用这个名称的时候不能保证将插入哪个URL。
• 在URL名称中加上一个前缀，比如应用的名称，将减少冲突的可能。我们建议使用myapp-comment 而不是comment。

总结：

1、静态路由
命名方法：url('user_list',user,name='user_list' )
反向解析：
　　视图中的配置：
　　from django.urls import reverse
　　reverse('user_list') 　　路由将会匹配到/app01/user_list

　　模板中的配置：
　　{% url 'user_list' %}　　路由将会匹配到/app01/user_list

2、分组
命名方法： url(r'^del_(book|publisher)/(\d+)/$', views.delete, name='del'),
反向解析：
　　视图中的配置：
　　reverse('del',args=('book',1)) 　　路由将会匹配到/del_book/1/

　　模板中的配置：
　　{% url 'del' 'book' 1 %} 　　路由将会匹配到/del_book/1/

3、命名分组
命名方法： url(r'^edit_(?P<name>publisher)/(?P<pk>\d+)/$', views.edit_publisher, name='edit_pub'),
反向解析：
　　视图中的配置：
　　reverse('edit_pub',args=('publisher',2)) 　　路由将会匹配到/edit_publisher/2/
　　reverse('edit_pub',kwargs={'name':'publisher','pk':2})　　路由将会匹配到/edit_publisher/2/

　　模板中的配置：
　　{% url 'edit_pub' 'publisher' 2 %} 　　路由将会匹配到/edit_publisher/2/
　　{% url 'edit_pub' pk=2 name='publisher' %} 　　路由将会匹配到/edit_publisher/2/

六、命名空间模式

即使不同的APP使用相同的URL名称，URL的命名空间模式也可以让你唯一反转命名的URL。

举个例子：

project中的urls.py
from django.conf.urls import url, include

urlpatterns = [
    url(r'^app01/', include('app01.urls', namespace='app01')),
    url(r'^app02/', include('app02.urls', namespace='app02')),
]

app01中的urls.py
from django.conf.urls import url
from app01 import views

app_name = 'app01'
urlpatterns = [
    url(r'^(?P<pk>\d+)/$', views.detail, name='detail')
]

app02中的urls.py
from django.conf.urls import url
from app02 import views

app_name = 'app02'
urlpatterns = [
    url(r'^(?P<pk>\d+)/$', views.detail, name='detail')

现在，我的两个app中 url名称重复了，反转URL的时候就可以通过命名空间的名称得到我当前的URL。

语法：

'命名空间名称:URL名称'

模板中使用：
{% url 'app01:detail' pk=12 %}

views中的函数中使用
v = reverse('app01:detail', kwargs={'pk':11})
这样即使app中URL的命名相同，我也可以反转得到正确的URL了。　　

七、自定义converters的调用

如果有需要，可以自定义路由转换器

urls.py文件中编写如下代码：
from django.urls import register_converter, path
from . import converters, views

register_converter(converters.YearConverter, 'yyyy')  #注册

urlpatterns = [
    path('articles/2018', views.special_case_2018),
    path('articles/<yyyy:year>', views.year_archive),
    ...
]

converters.py文件中编写如下代码：
#自定义一个类
class YearConverter:
    regex = r'[0-9]{4}'

    def to_python(self, value):
        return int(value)

    def to_url(self, value):
        return '%04d'

views.py文件中编写如下代码：
def year_archive(request, year):
    return HttpResponse('article %s'%year)