Django reverse() URL 匹配问题详解

本文将深入探讨 Django 中 reverse() 函数在 URL 匹配过程中可能出现的“陷阱”，并解释其背后的原因。通常情况下，我们期望 reverse() 函数通过指定的名称找到对应的 URL，但有时它似乎会匹配到其他的 URL 模式，导致意想不到的结果，例如重定向循环。下面，我们将通过一个实际的例子来分析这个问题，并提供解决方案。

问题描述

假设我们正在开发一个类似维基百科的 Django 项目。当用户访问一个不存在的页面（例如 /wiki/file）时，我们希望将其重定向到一个 "not found" 页面。然而，使用 reverse("notfound") 进行重定向时，却发现用户被无限循环地重定向回原来的页面，而不是 "not found" 页面。

代码示例

以下是相关的 urls.py 和 views.py 代码：

urls.py:

from django.urls import path
from . import views

urlpatterns = [
    path("", views.index, name="index"),
    path("wiki/", views.entry, name="entry"),
    path("wiki/notfound", views.notfound, name="notfound"),
]

views.py:

from django.shortcuts import render
import markdown2
from django.urls import reverse
from django.http import HttpResponseRedirect

from . import util


def index(request):
    return render(request, "encyclopedia/index.html", {
        "entries": util.list_entries()
    })

def entry(request, title):
    md = util.get_entry(title)

    if md is None:
        return HttpResponseRedirect(reverse("notfound"))
    else:
        html = markdown2.markdown(md)

    return render(request, "encyclopedia/entry.html", {
        "title": title,
        "entry": html
    })

def notfound(request):
    return render(request, "encyclopedia/notfound.html")

问题分析

问题的关键在于 URL 模式的匹配顺序和 reverse() 函数的工作方式。reverse("notfound") 会返回 /wiki/notfound。当用户被重定向到这个 URL 时，Django 的 URL 解析器会尝试匹配 urlpatterns 中的模式。

由于 path("wiki/", views.entry, name="entry") 定义的模式具有更高的优先级（因为它更早出现，并且可以匹配任何以 /wiki/ 开头的字符串），所以 /wiki/notfound 首先被这个模式匹配到。因此，entry 视图被调用，由于 notfound 并不是一个有效的页面，entry 视图又会将用户重定向到 /wiki/notfound，从而形成无限循环。

本质原因： reverse() 函数本身没有问题，它正确地根据名称找到了对应的 URL。问题在于该 URL 被其他更通用的 URL 模式优先匹配。

解决方案

有几种方法可以解决这个问题：

1. 调整 URL 模式的顺序： 将 path("wiki/notfound", views.notfound, name="notfound") 放在 path("wiki/", views.entry, name="entry") 之前。这样，/wiki/notfound 会首先被 notfound 视图匹配。

   urlpatterns = [
       path("", views.index, name="index"),
       path("wiki/notfound", views.notfound, name="notfound"), # 调整顺序
       path("wiki/", views.entry, name="entry"),
   ]

2. 修改 URL 模式： 在 entry 视图的 URL 模式中添加一个结束符，使其不能匹配 /wiki/notfound。例如，可以修改为 path("wiki//", views.entry, name="entry")。注意，这需要在 URL 中显式地添加斜杠。

   urlpatterns = [
       path("", views.index, name="index"),
       path("wiki//", views.entry, name="entry"), # 添加结束符
       path("wiki/notfound", views.notfound, name="notfound"),
   ]

3. 使用更精确的URL匹配: 可以考虑使用正则表达式进行更精确的URL匹配，确保/wiki/notfound 不会被 entry 视图匹配。

   from django.urls import re_path
   
   urlpatterns = [
       path("", views.index, name="index"),
       re_path(r"^wiki/(?P