Django-URL路由配置

一、URL配置
- 参数说明
二、正则表达式详解
- 注意事项
- 捕获的参数永远都是字符串：
三、include其他的URLconfs（也叫URL分发）
四、传递额外的参数给视图函数
五、命名URL（别名）和URL的反向解析
六、命名空间模式

一、URL配置

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

　　基本格式：

from django.conf.urls import url
#循环urlpatterns，找到对应的函数执行,匹配上一个路径就找到对应的函数执行，就不再往下循环了，并给函数传一个参数request，和wsgiref的environ类似，就是请求信息的所有内容
urlpatterns = [
     url(正则表达式, views视图函数，参数，别名),
]

　　注意：

　　Django 2.0版本中的路由系统已经替换成下面的写法，但是django2.0是向下兼容1.x版本的语法的（官方文档）：

from django.urls import path

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),
]

参数说明

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

二、正则表达式详解

　　上面的示例使用简单的正则表达式分组匹配（通过圆括号）来捕获URL中的值并以位置参数形式传递给视图。

　　在更高级的用法中，可以使用分组命名匹配的正则表达式组来捕获URL中的值并以关键字参数形式传递给视图。

　　在Python的正则表达式中，分组命名正则表达式组的语法是(?P<name>pattern)，其中name是组的名称，pattern是要匹配的模式。

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

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

urlpatterns = [
    # url(r'^admin/', admin.site.urls),
　　 url(r"",views.home)   # 匹配所有，这种一般使用home主页，写在项目文件中urls.py文件中就是项目的首页，写在应用文件中的urls.py就是应用文件首页
    url(r'^articles/', views.articles),    # 正则匹配所有以articles开头的：例如：articles/，articles/xxx等
    url(r'^articles/2001/$', views.articles_2001),    # 正则匹配只能是articles/2001/满足条件
    url(r'^articles/[0-9]{4}/$', views.year_archive),  # 如果用户想看2004、2005、2006....等，你要写一堆的url吗，是不是在articles后面写一个正则表达式/d{4}/就行啦
    url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.year_month_archive1), # 如果你想拿到用户输入的什么年份，并通过这个年份去数据库里面匹配对应年份的文章，获取用户输入的年份: 分组(位置参数)：/(\d{4})/
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.year_month_archive2), # 如果你想拿到用户输入的什么年份，并通过这个年份去数据库里面匹配对应年份的文章，获取用户输入的年份: 分组(关键字)：/(\d{4})/
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.year_month_archive3, {"foo": "1234"}),  # foo是一个额外参数，以字典形式存在,value必须是一个str类型
]

注意事项

urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式，一旦匹配成功则不再继续。
若要从URL中捕获一个值，只需要在它周围放置一对圆括号（分组匹配）。
不需要添加一个前导的反斜杠（也就是写在正则最前面的那个/），因为每个URL 都有。例如，应该是^articles 而不是 ^/articles。
每个正则表达式前面的'r' 是可选的但是建议加上。
^articles& 以什么结尾，以什么开头，严格限制路径

　　下面是views中对url中分发的实现：

# 模糊匹配，以articles开头
def articles(request):
    return HttpResponse("hello")           # http://127.0.0.1:8000/articles/

# 参数指定默认值，以articles开头
def articles(request, num="123"):          # 未做匹配时，num为默认值，否则为匹配的结果
    return HttpResponse("hello"+num)           # http://127.0.0.1:8000/articles/

# 精确匹配：^articles/2001/$
def articles_2001(request):
    return HttpResponse("hello1")           # http://127.0.0.1:8000/articles/2001/

# 匹配多个结果：^articles/[0-9]{4}/$
def year_archive(request):
    return HttpResponse("hello2")           # http://127.0.0.1:8000/articles/1222/

# 分组：默认参数，接收变量的位置不能随意改变，匹配多个结果：^articles/([0-9]{4})/([0-9]{2})/$
def year_month_archive1(request, year, month):
    return HttpResponse("hello"+year+month)           # http://127.0.0.1:8000/articles/2005/02/

# 分组：关键字参数，接收变量的位置能随意改变，匹配多个结果：^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$
def year_month_archive2(request, month, year):
    return HttpResponse("hello"+year+month)           # http://127.0.0.1:8000/articles/2005/02/

# 额外参数，接收变量的位置必须放在默认参数的后面，对关键字参数传参无影响
def year_month_archive3(request, month, year, foo):
    return HttpResponse("hello"+year+month+foo)           # http://127.0.0.1:8000/articles/2005/02/

　　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等等 —— 都将路由到相同的函数。

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

　　传递到视图函数views.year_archive() 中的year 参数永远是一个字符串类型。

补充说明：

# 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项
APPEND_SLASH=True

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

例如：
访问 http://www.example.com/blog 时，默认将网址自动转换为 http://www.example/com/blog/ 。

如果在settings.py中设置了 APPEND_SLASH=False，此时我们再请求 http://www.example.com/blog 时就会提示找不到页面。

三、include其他的URLconfs（也叫URL分发）

　　项目文件夹里面的文件都是全局文件，所有的app应用都可以访问到，这种情况下，一个项目文件可能存在多个应用app文件，这是后为了每个app应用方便管理，降低应用之间的耦合度，所以django在url这里给你提供了一个分发接口，叫做include

　　项目文件(urls)：#At any point, your urlpatterns can “include” other URLconf modules. This

#essentially “roots” a set of URLs below other ones.

#For example, here’s an excerpt of the URLconf for the Django website itself.
#It includes a number of other URLconfs:


from django.conf.urls import include, url


urlpatterns = [
   url(r'^admin/', admin.site.urls),

    # app01应用：
    url(r'^app01/', include("app01.urls")),   # 可以包含其他的URLconfs文件
　　url(r'^app01/2003/', views.special_case_2003,{'foo':'xxxxx'}), #{'foo':'xxxxx'}那么你的视图函数里面必须有个形参叫做foo来接收这种传参
    # app02应用：
    url(r'^app02/', include("app02.urls")),   # 别忘了要去app01这个应用下创建一个urls.py的文件，现在的意思是凡是以app01开头的路径请求，都让它去找app01下的urls文件中去找对应的视图函数，还要注意一点，此时这个文件里面的那个app01路径不能用$结尾，因为如果写了$，就没办法比配上app01/后面的路径了
]

　　应用文件(urls):

app01应用文件urls.py：

urlpatterns = [
    url(r"^home/(\d{4})/(\d{1,2})/", views.home),   # 默认参数
]


app02应用文件urls.py：

urlpatterns = [
    url(r"^index/(?P<year>\d+)/(?P<month>\d+)/", views.index),   # 关键字参数
]

　　应用文件(views)

app01中的views.py

def home(request, year, month):
    return render(request, "home.html", {"year": year, "month": month})    # http://127.0.0.1:8000/app01/home/2000/23/

app02中的views.py

def index(request, year, month):
    return HttpResponse(year + month)   # http://127.0.0.1:8000/app02/index/1000/23/

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

　　　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'}),#注意，这就像一个命名分组一样，你的函数里面的必须有一个形参，形参必须叫做foo才行，如果是命名分组的url，那么foo参数写在函数的哪个位置都行，如果不是命名分组，那么都是将这个形参写在参数的最后。
]


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

五、命名URL（别名）和URL的反向解析

　　你想，我们自己写的url里面的路径有没有可能会更改，如果路径更改了，那么我们前端访问这个路径的标签（a标签，form表单等等）里面的属性值是不是也要自己手动去改啊，这样我们拓展起来就不方便了

　　人们强烈希望不要硬编码（其实就是在标签里面写死了路径，凡是写死了的代码就是硬编码）这些URL（费力、不可扩展且容易产生错误）或者设计一种与URLconf 毫不相关的专门的URL 生成机制，因为这样容易导致一定程度上产生过期的URL。　

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

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

　　第一种方式是我们在前面的章节中一直讨论的用法。第二种方式叫做反向解析URL、反向URL 匹配、反向URL 查询或者简单的URL 反查。
　　在需要URL 的地方，对于不同层级，Django 提供不同的工具用于URL 反查：

在模板中：使用url模板标签。
在Python 代码中：使用django.core.urlresolvers.reverse() 函数。
在更高层的与处理Django 模型实例相关的代码中：使用get_absolute_url() 方法。

urls.py文件：
url(r'^home', views.home, name='home'),  # 给我的url匹配模式起名（别名）为 home，别名不需要改，路径你就可以随便改了，别的地方使用这个路径，就用别名来搞
url(r'^index/(\d*)', views.index, name='index'),  # 给我的url匹配模式起名为index


在模板里面可以这样引用：html文件
<form action="{% url 'home' %}" method="post">   # {% url "home" %} 模板反向解析的过程
    {% csrf_token %}
    用户名 <input type="text" name="username">
    <input type="submit">
</form>


在views函数中可以这样引用：(这个是视图函数应用反向解析的内容，上面的是模板应用反向解析的过程)
from django.urls import reverse
return redirect(reverse('userindex'))       # 方式一
return redirect('userindex')                # 方式二：内部实现了一个reverse方法
reverse("index", args=("2018", ))    # 可以带参数

　　注意：

　　当命名你的URL 模式时，请确保使用的名称不会与其它应用中名称冲突。如果你的URL 模式叫做comment，而另外一个应用中也有一个同样的名称，当你在模板中使用这个名称的时候不能保证将插入哪个URL。

　　在URL 名称中加上一个前缀，比如应用的名称，将减少冲突的可能。我们建议使用myapp-comment 而不是comment。

　　重定向图例：

六、命名空间模式

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

举个例子：

project中的urls.py：

from django.conf.urls import url, include
 
urlpatterns = [
    url(r'^app01/', include('app01.urls', namespace='app01')),   # 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'  # 指定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'  # 指定app02的命名空间，必须写
urlpatterns = [
    url(r'^(?P<pk>\d+)/$', views.detail, name='detail')
]

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

语法：
'命名空间名称:URL名称'

模板中使用：
{% url 'app01:detail' pk=12 pp=99 %}   # 指定用法：app01:别名


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

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：Django-URL路由配置 - Python技术站