Python Django项目URL中包含另外一个urls模块

2023-10-26

在我们的项目中，不可能只有一个app，如果把所有的app的views中的视图都放在urls.py中进行映射，肯定会让代码显得非常乱。因此django给我们提供了一个方法，可以在app内部包含自己的url匹配规则，而在项目的urls.py中再统一包含这个app的urls。使用这个技术需要借助include函数。示例代码如下：

# first_project/urls.py文件：

from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('book/',include("book.urls"))
]

在urls.py文件中把所有的和book这个app相关的url都移动到app/urls.py中了，然后在first_project/urls.py中，通过include函数包含book.urls，以后在请求book相关的url的时候都需要加一个book的前缀。

# book/urls.py文件：

from django.urls import path
from . import views

urlpatterns = [
    path('list/',views.book_list),
    path('detail/<book_id>/',views.book_detail)
]

以后访问书的列表的url的时候，就通过/book/list/来访问，访问书籍详情页面的url的时候就通过book/detail/<id>来访问。

path函数：

path函数的定义为：path(route,view,name=None,kwargs=None)。以下对这几个参数进行讲解。

route参数：url的匹配规则。这个参数中可以指定url中需要传递的参数，比如在访问文章详情页的时候，可以传递一个id。传递参数是通过<>尖括号来进行指定的。并且在传递参数的时候，可以指定这个参数的数据类型，比如文章的id都是int类型，那么可以这样写<int:id>，以后匹配的时候，就只会匹配到id为int类型的url，而不会匹配其他的url，并且在视图函数中获取这个参数的时候，就已经被转换成一个int类型了。其中还有几种常用的类型：
- str：非空的字符串类型。默认的转换器。但是不能包含斜杠。
- int：匹配任意的零或者正数的整形。到视图函数中就是一个int类型。
- slug：由英文中的横杠-，或者下划线_连接英文字符或者数字而成的字符串。
- uuid：匹配uuid字符串。
- path：匹配非空的英文字符串，可以包含斜杠。
view参数：可以为一个视图函数或者是类视图.as_view()或者是django.urls.include()函数的返回值。
name参数：这个参数是给这个url取个名字的，这在项目比较大，url比较多的时候用处很大。
kwargs参数：有时候想给视图函数传递一些额外的参数，就可以通过kwargs参数进行传递。这个参数接收一个字典。传到视图函数中的时候，会作为一个关键字参数传过去。比如以下的url规则：

from django.urls import path
 from . import views

 urlpatterns = [
     path('blog/<int:year>/', views.year_archive, {'foo': 'bar'}),
 ]

那么以后在访问blog/1991/这个url的时候，会将foo=bar作为关键字参数传给year_archive函数。

re_path函数：

有时候我们在写url匹配的时候，想要写使用正则表达式来实现一些复杂的需求，那么这时候我们可以使用re_path来实现。re_path的参数和path参数一模一样，只不过第一个参数也就是route参数可以为一个正则表达式。
一些使用re_path的示例代码如下：

from django.urls import path, re_path

    from . import views

    urlpatterns = [
        path('articles/2003/', views.special_case_2003),
        re_path(r'articles/(?P<year>[0-9]{4})/', views.year_archive),
        re_path(r'articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/', views.month_archive),
        re_path(r'articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<slug>[\w-_]+)/', views.article_detail),
    ]

以上例子中我们可以看到，所有的route字符串前面都加了一个r，表示这个字符串是一个原生字符串。在写正则表达式中是推荐使用原生字符串的，这样可以避免在python这一层面进行转义。而且，使用正则表达式捕获参数的时候，是用一个圆括号进行包裹，然后这个参数的名字是通过尖括号<year>进行包裹，之后才是写正则表达式的语法。

include函数：

在项目变大以后，经常不会把所有的url匹配规则都放在项目的urls.py文件中，而是每个app都有自己的urls.py文件，在这个文件中存储的都是当前这个app的所有url匹配规则。然后再统一注册到项目的urls.py文件中。include函数有多种用法，这里讲下两种常用的用法。

1.include(pattern,namespace=None)：直接把其他app的urls包含进来。示例代码如下：

from django.contrib import admin
 from django.urls import path,include

 urlpatterns = [
     path('admin/', admin.site.urls),
     path('book/',include("book.urls"))
 ]

当然也可以传递namespace参数来指定一个实例命名空间，但是在使用实例命名空间之前，必须先指定一个应用命名空间。示例代码如下：

# 主urls.py文件：
from django.urls import path,include
urlpatterns = [
    path('movie/',include('movie.urls',namespace='movie'))
]

然后在movie/urls.py中指定应用命名空间。实例代码如下：

from django.urls import path
from . import views

# 应用命名空间
app_name = 'movie'

urlpatterns = [
    path('',views.movie,name='index'),
    path('list/',views.movie_list,name='list'),
]

2.include(pattern_list)：可以包含一个列表或者一个元组，这个元组或者列表中又包含的是path或者是re_path函数。

3.include((pattern,app_namespace),namespace=None)：在包含某个app的urls的时候，可以指定命名空间，这样做的目的是为了防止不同的app下出现相同的url，这时候就可以通过命名空间进行区分。示例代码如下：

from django.contrib import admin
 from django.urls import path,include

 urlpatterns = [
     path('admin/', admin.site.urls),
     path('book/',include(("book.urls",'book')),namespace='book')
 ]

但是这样做的前提是已经包含了应用命名空间。即在myapp.urls.py中添加一个和urlpatterns同级别的变量app_name。

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

python