极客教程Django urlpatterns
在使用 Django 开发 Web 应用程序时，我们经常需要设计 URL 路由以访问不同的视图函数或处理不同的请求。Django 提供了 urlpatterns 机制来帮助我们管理 URL 路由。本文将详细解释 Django urlpatterns 的使用方法和常见技巧。
urlpatterns 的定义和功能
在 Django 项目的主配置文件中（一般是 settings.py 或 urls.py），我们会看到一个名为 urlpatterns 的变量。这个变量是一个列表，其中每个元素是一个路由规则（URLPattern 对象）。Django 会按照 urlpatterns 列表中的顺序，逐个匹配请求的 URL，找到对应的视图函数或处理器。
每个 URLPattern 对象包含以下属性：
pattern: 一个字符串或正则表达式，用于匹配请求的 URL。callback: 一个视图函数或处理器类，用于处理匹配到的请求。name（可选）: 用于给路由规则命名，便于在代码中动态生成 URL。kwargs（可选）: 一个字典，包含额外的关键字参数传递给视图函数或处理器。app_name（可选）: 用于在多个应用程序之间区分相同命名的 URL。
urlpatterns 的基本使用
urlpatterns 的基本使用非常简单，只需对它进行列表操作，添加或移除 URLPattern 对象即可。假设我们有一个 Django 应用程序，其中有两个视图函数 home_view 和 about_view，分别用于处理主页和关于页面的请求。
首先，我们需要导入 path 函数和对应的视图函数：
from django.urls import path
from .views import home_view, about_view
然后，在 urlpatterns 列表中添加对应的路由规则：
urlpatterns = [
path('', home_view, name='home'), # 主页路由
path('about/', about_view, name='about'), # 关于页路由
]
上面的代码中，第一个路由规则使用空字符串来匹配请求的根路径（即主页），并将请求交给 home_view 函数处理。第二个路由规则匹配请求的 “/about/” 路径，并将请求交给 about_view 函数处理。
urlpatterns 中的正则表达式
除了简单的字符串匹配之外，我们还可以使用正则表达式来定义 urlpatterns 中的路由规则。这样就可以更灵活地匹配特定的路径，并提取其中的参数。
例如，假设我们有一个视图函数 user_profile_view，用于显示用户的个人资料。我们的 URL 路径是形如 /user/<username>/profile/，其中 <username> 是一个动态参数，表示用户的用户名。
我们可以使用正则表达式来匹配这个 URL 路径，并将用户名作为参数传递给视图函数。示例代码如下：
from django.urls import path, re_path
from .views import user_profile_view
urlpatterns = [
path('', home_view, name='home'), # 主页路由
path('about/', about_view, name='about'), # 关于页路由
re_path(r'^user/(?P<username>\w+)/profile/$', user_profile_view, name='user_profile'), # 用户资料页面路由
]
上面的代码中，我们使用了 re_path 函数来定义一个正则表达式路由规则。正则表达式 r'^user/(?P<username>\w+)/profile/$' 匹配以 /user/ 开头，以 /profile/ 结尾的路径，并将其中的 <username> 提取为一个参数传递给 user_profile_view 函数。
urlpatterns 中的命名空间
当我们在一个 Django 项目中使用多个应用程序时，为了避免路由名称冲突，我们可以使用命名空间来区分不同应用程序下的路由。
在主配置文件中，可以为 urlpatterns 添加一个命名空间前缀，以区分不同应用程序的路由规则。
app_name = 'blog'
urlpatterns = [
...
]
然后，在每个应用程序的 urls.py 文件中，可以为每个路由规则添加命名空间前缀，并使用 app_name 属性指定所属应用程序的命名空间。
from django.urls import path
from .views import post_list_view, post_detail_view
app_name = 'blog'
urlpatterns = [
path('', post_list_view, name='post_list'),
path('<int:pk>/', post_detail_view, name='post_detail'),
]
在上述示例中，我们创建了一个名为 blog 的应用程序，并为其定义了 post_list 和 post_detail 两个路由规则。这两个规则都以应用程序名称 blog 作为命名空间前缀，可以避免与其他应用程序的路由规则冲突。
urlpatterns 中的动态生成 URL
在 Django 中，我们经常需要在代码中生成不同的 URL。Django 提供了 reverse() 函数来根据路由名称和参数动态生成 URL。
示例代码如下：
from django.urls import reverse
url = reverse('post_detail', args=[1]) # 生成名为 'post_detail' 的路由对应的 URL，其中参数 1 为 <int:pk>
上述代码中，我们通过 reverse() 函数根据路由名称 post_detail，生成了对应的 URL，并将参数 [1] 传递给路由规则中的 <int:pk>。最终生成的 URL 为 /blog/1/（假设我们的应用程序和路由规则与上一节的示例相同）。
urlpatterns 的高级用法和技巧
除了上述基本用法外，我们还可以使用一些高级技巧来更好地组织和管理 urlpatterns，提高代码的可读性和可维护性。
使用 include() 函数
当我们的 Django 项目变得越来越复杂时，我们可能会创建多个应用程序来管理不同的功能模块。这时，我们可以使用 include() 函数将应用程序的路由规则分离到独立的文件中，以便更好地组织和管理。
示例代码如下：
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('blog/', include('blog.urls')), # 包含 blog 应用程序的路由规则
path('api/', include('api.urls')), # 包含 api 应用程序的路由规则
]
上述代码中，我们使用 include() 函数将 blog 应用程序的路由规则包含进来，并将其路由路径设置为 /blog/。这样，我们可以将 blog 应用程序的路由规则单独定义在 blog/urls.py 文件中，便于管理和维护。
使用 re_path() 封装的路由规则
在 Django 的路由规则中，我们可以使用 re_path() 函数来定义一个正则表达式封装的路由规则。这种方式可以更加灵活地匹配复杂的 URL 路径，并且可以使用命名组来提取参数。
例如，我们可以使用正则表达式来匹配一个包含年份和月份的 URL 路径，如 /archives/2022/12/。示例代码如下：
from django.urls import re_path
from .views import archive_view
urlpatterns = [
re_path(r'^archives/(?P<year>\d{4})/(?P<month>\d{2})/$', archive_view, name='archive'),
]
上述代码中，我们使用正则表达式 r'^archives/(?P<year>\d{4})/(?P<month>\d{2})/$' 匹配以 /archives/ 开头，后跟四位数字的年份，再后跟两位数字的月份，最后以 / 结尾的 URL 路径。通过使用命名组 (?P<year>\d{4}) 和 (?P<month>\d{2})，我们可以从 URL 中提取对应的年份和月份，并将其作为参数传递给 archive_view 视图函数。
使用全局和应用程序级别的路由前缀
有时候，我们需要为整个 Django 项目或者某个应用程序的所有路由规则添加一个统一的前缀。这可以通过两种方式来实现：全局级别的路由前缀和应用程序级别的路由前缀。
全局级别的路由前缀
在主配置文件中，我们可以通过使用 path() 函数的 prefix 参数来添加全局级别的路由前缀。这样做可以避免重复编写相同的前缀，提高代码的可读性和可维护性。
示例代码如下：
from django.urls import path, include
urlpatterns = [
path('blog/', include('blog.urls', namespace='blog')), # 包含 blog 应用程序的路由规则，并添加前缀 '/blog'
path('api/', include('api.urls', namespace='api')), # 包含 api 应用程序的路由规则，并添加前缀 '/api'
]
上述代码中，我们使用 include() 函数将 blog 和 api 应用程序的路由规则包含进来，并且为它们分别添加了 /blog 和 /api 的前缀。这样，在使用这些应用程序中的 URL 时，我们只需要写相对路径，而不需要写完整的 URL。
应用程序级别的路由前缀
在应用程序的 urls.py 文件中，我们可以使用 app_name 参数为应用程序的路由规则添加一个命名空间前缀。这样做可以避免与其他应用程序的路由规则冲突。
示例代码如下：
from django.urls import path
from .views import post_list_view, post_detail_view
app_name = 'blog' # 添加应用程序级别的命名空间前缀
urlpatterns = [
path('', post_list_view, name='post_list'),
path('<int:pk>/', post_detail_view, name='post_detail'),
]
上述代码中，我们为应用程序 blog 的路由规则添加了命名空间前缀 blog。这样，在使用应用程序中的路由名称时，我们需要指定命名空间前缀，如 blog:post_list。
使用 URL 名称的参数占位符
在 urlpatterns 中，我们可以使用参数占位符来将一些常见的 URL 部分定义为变量，提高代码的可读性和可维护性。
示例代码如下：
from django.urls import path
from .views import author_view, book_view
author_id = r'\d+' # 作者的 ID 为数字
book_id = r'\d+' # 书籍的 ID 为数字
urlpatterns = [
path('authors/{author_id}/', author_view, name='author_detail').format(author_id=author_id),
path('books/{book_id}/', book_view, name='book_detail').format(book_id=book_id),
]
上述代码中，我们使用参数占位符 {author_id} 和 {book_id} 将作者和书籍的 ID 部分定义为变量。这样，当我们添加新的路由规则时，只需要修改一处变量定义，而不需要逐个修改每个路由规则。这样可以提高代码的复用性和可维护性。
总结
本文详细介绍了 Django urlpatterns 的使用方法和常见技巧，包括 urlpatterns 的定义和功能、基本使用、正则表达式匹配、命名空间、动态生成 URL、高级用法和技巧等。对于使用 Django 开发 Web 应用程序的开发者来说，掌握 urlpatterns 的用法是非常重要的。它可以帮助我们更好地管理和组织 URL 路由，提高代码的可读性和可维护性。