Django 中的 reverse 【反向/逆转/扭转/逆向】使用详解以及使用案例

Django 中的 reverse 使用详解

reverse ：中文翻译:反向/逆转/扭转/逆向

什么是 reverse 方法？

Django 中的 reverse 方法用于根据视图的名称和传递的参数，动态生成URL。这样做的好处是，如果你在 urls.py 中更改了URL模式，只要视图名称不变，使用 reverse 生成的URL仍然是正确的。这对于维护和修改代码非常有用。

什么情况下需要使用 reverse？

当你需要动态生成URL时，使用 reverse 特别有用。

例如，在视图中获取到API数据时，如果API返回的URL参数不符合你的需求或你需要更改URL结构，就可以使用 reverse 来重新生成符合要求的URL。

如：'http://localhost:10005/api/article/5/' ---转换为---》'http://localhost:10005/article/5/'

reverse 方法的参数

视图名称：传递给 reverse 方法的第一个参数是视图的名称，它是你在 urls.py 中指定的名称。

参数列表（args）：传递给 reverse 方法的第二个参数是一个参数列表，这些参数将被插入到URL中。

示例代码及讲解

URL配置（urls.py）

python 复制代码

from django.urls import path
from . import views

urlpatterns = [
    path('article/<int:article_id>/', views.article_detail_view, name='article_detail_view'),
]

# 定义了一个名为 article_detail_view 的URL模式，该模式接受一个整数类型的 article_id 作为参数。

视图函数（views.py）

python 复制代码

from django.urls import reverse

def article_detail_view(request, article_id):
    # 示例：假设获取的 previous_article_url 是 'http://localhost:10005/api/article/5/'
    previous_article_url = 'http://localhost:10005/api/article/5/'
    
    # 提取文章ID
    previous_article_id = previous_article_url.split('/')[-2]
    
    # 使用 reverse 方法生成HTML视图的URL
    new_previous_article_url = reverse('article_detail_view', args=[previous_article_id])
    
    # 示例：new_previous_article_url 将生成 '/article/5/'
    print(new_previous_article_url)  # 输出：'/article/5/'

参数处理的详细过程

处理前的URL

python 复制代码

previous_article_url = 'http://localhost:10005/api/article/5/'

提取文章ID

python 复制代码

previous_article_id = previous_article_url.split('/')[-2]

python 复制代码

split('/') 将URL按斜杠分割成数组：['http:', '', 'localhost:10005', 'api', 'article', '5', '']

[-2] 表示倒数第二个元素，即 5

使用 reverse 方法生成新URL

python 复制代码

new_previous_article_url = reverse('article_detail_view', args=[previous_article_id])

python 复制代码

reverse('article_detail_view', args=['5']) 根据视图名称和参数生成URL

假设在 urls.py 中，名为 article_detail_view 的URL模式是 path('article/<int:article_id>/', views.article_detail_view, name='article_detail_view')

因此，reverse 方法生成的URL将是 /article/5/

整理后的示例代码及注释

python 复制代码

from django.urls import reverse

def article_detail_view(request, article_id):
    """
    处理显示文章详情的视图函数。
    
    参数:
    - request: HttpRequest 对象，包含了请求的所有信息。
    - article_id: int，文章的唯一标识符，用于获取特定的文章数据。
    
    返回:
    - HttpResponse: 包含渲染后的文章详情HTML页面。
    """
    
    # 假设从API获取的 previous_article_url 是 'http://localhost:10005/api/article/5/'
    previous_article_url = 'http://localhost:10005/api/article/5/'
    
    # 提取文章ID
    previous_article_id = previous_article_url.split('/')[-2]
    
    # 使用 reverse 方法生成HTML视图的URL
    new_previous_article_url = reverse(
        'article_detail_view',  # 视图的名称
        args=[previous_article_id]  # 提取文章ID并作为参数传递
    )
    
    # new_previous_article_url 将生成 '/article/5/'
    print(new_previous_article_url)  # 输出：'/article/5/'
    
    # 将数据渲染到模板中（此处只是示例，实际代码中应包含更多处理逻辑）
    return render(request, 'article_detail.html', {'previous_article_url': new_previous_article_url})

总结
通过上述例子，可以看出 reverse 方法是如何根据视图名称和参数动态生成URL的。具体过程如下：

获取并处理API返回的URL：从API获取数据并提取所需参数。

使用 reverse 方法动态生成URL：通过 reverse 方法，根据视图名称和参数生成新的URL。

这样，当API返回的URL指向 http://localhost:10005/api/article/5/ 时，我们可以将其转换为指向HTML视图的URL http://localhost:10005/article/5/，从而实现预期的跳转效果。

场景 1：重定向用户到特定页面

假设你有一个用户登录后的视图，如果登录成功，你想重定向用户到他们的个人主页：

URL配置（urls.py）

python 复制代码

from django.urls import path
from . import views

urlpatterns = [
    path('profile/<str:username>/', views.profile_view, name='profile_view'),
]

视图函数（views.py）

python 复制代码

from django.shortcuts import redirect
from django.urls import reverse

def login_view(request):
    if request.method == 'POST':
        # 进行登录验证...
        if login_successful:
            username = request.user.username
            return redirect(reverse('profile_view', args=[username]))
    return render(request, 'login.html')

场景 2：生成API端点的URL

你有一个API端点，需要在Django的视图中生成该端点的URL，并将其传递给前端。

URL配置（urls.py）

python 复制代码

from django.urls import path
from . import views

urlpatterns = [
    path('api/data/<int:item_id>/', views.data_api_view, name='data_api_view'),
]

视图函数（views.py）

python 复制代码

from django.urls import reverse

def frontend_view(request):
    item_id = 42
    api_url = reverse('data_api_view', args=[item_id])
    return render(request, 'frontend.html', {'api_url': api_url})

场景 3：邮件中的动态链接

假设你需要在发送给用户的电子邮件中包含一个动态链接，如密码重置链接。

URL配置（urls.py）

python 复制代码

from django.urls import path
from . import views

urlpatterns = [
    path('reset-password/<str:token>/', views.reset_password_view, name='reset_password_view'),
]

视图函数（views.py）

python 复制代码

from django.core.mail import send_mail
from django.urls import reverse

def send_password_reset_email(request, user):
    token = generate_password_reset_token(user)
    reset_link = request.build_absolute_uri(reverse('reset_password_view', args=[token]))
    
    send_mail(
        'Password Reset',
        f'Click the link to reset your password: {reset_link}',
        'from@example.com',
        [user.email],
    )

场景 4：在模板中生成URL

有时你需要在Django模板中生成一个链接到特定视图的URL，可以使用 reverse 配合模板标签。

URL配置（urls.py）

python 复制代码

from django.urls import path
from . import views

urlpatterns = [
    path('article/<int:article_id>/', views.article_detail_view, name='article_detail_view'),
]

模板（template.html）

python 复制代码

{% load static %}

<a href="{% url 'article_detail_view' article.id %}">查看文章详情</a>

场景 5：动态生成JavaScript变量

你可能需要在JavaScript代码中使用动态生成的URL，例如通过AJAX调用的URL。

视图函数（views.py）

python 复制代码

from django.shortcuts import render
from django.urls import reverse

def my_view(request):
    some_api_url = reverse('data_api_view', args=[123])
    return render(request, 'my_template.html', {'some_api_url': some_api_url})

模板（my_template.html）

python 复制代码

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>My Page</title>
</head>
<body>
    <script type="text/javascript">
        var apiUrl = "{{ some_api_url }}";
        console.log("API URL:", apiUrl);
    </script>
</body>
</html>

总结

通过这些例子，你可以看到 reverse 方法如何在不同的场景中使用，从重定向、生成API端点URL、动态邮件链接、模板中生成URL，到JavaScript变量的生成。每个例子都展示了 reverse 的多功能性和灵活性。

希望这些例子能帮助你更好地理解和应用 reverse 方法！

python 复制代码

from django.urls import reverse

def reverse(viewname, urlconf=None, args=None, kwargs=None, current_app=None):
    """
    根据给定的视图名称和参数返回匹配的URL。

    参数:
    - viewname (str): 视图的名称或URL模式的名称。
    - urlconf (str, 可选): 用于反向URL解析的URLconf模块。默认为None。
    - args (list, 可选): URL中的位置参数。默认为None。
    - kwargs (dict, 可选): URL中的关键字参数。默认为None。
    - current_app (str, 可选): 当前应用的名称。默认为None。

    返回:
    - str: 反向解析生成的URL。
    """
    
    # 如果未提供urlconf，则使用默认的URL配置
    if urlconf is None:
        urlconf = get_urlconf()
    resolver = get_resolver(urlconf)
    args = args or []
    kwargs = kwargs or {}

    # 获取脚本前缀
    prefix = get_script_prefix()

    # 如果viewname不是字符串类型，直接赋值给view
    if not isinstance(viewname, str):
        view = viewname
    else:
        # 将viewname按照冒号分割成路径和视图
        *path, view = viewname.split(":")

        # 如果提供了current_app，则将其分割并反转路径
        if current_app:
            current_path = current_app.split(":")
            current_path.reverse()
        else:
            current_path = None

        resolved_path = []
        ns_pattern = ""
        ns_converters = {}
        for ns in path:
            current_ns = current_path.pop() if current_path else None
            try:
                # 查找名称以确定是否为应用标识符
                app_list = resolver.app_dict[ns]
                if current_ns and current_ns in app_list:
                    # 如果当前命名空间在应用列表中，使用该命名空间
                    ns = current_ns
                elif ns not in app_list:
                    # 如果名称不在实例列表中，选择第一个实例作为默认值
                    ns = app_list[0]
            except KeyError:
                pass

            if ns != current_ns:
                current_path = None

            try:
                # 解析命名空间
                extra, resolver = resolver.namespace_dict[ns]
                resolved_path.append(ns)
                ns_pattern += extra
                ns_converters.update(resolver.pattern.converters)
            except KeyError as key:
                if resolved_path:
                    raise NoReverseMatch(
                        "%s 不是 '%s' 内注册的命名空间"
                        % (key, ":".join(resolved_path))
                    )
                else:
                    raise NoReverseMatch("%s 不是注册的命名空间" % key)
        if ns_pattern:
            resolver = get_ns_resolver(
                ns_pattern, resolver, tuple(ns_converters.items())
            )

    # 使用解析器和前缀进行反向解析，并返回生成的URL
    return resolver._reverse_with_prefix(view, prefix, *args, **kwargs)

解释

函数参数：
viewname：视图的名称或URL模式的名称。
urlconf：用于反向URL解析的URLconf模块。如果未指定，默认为None。
args：URL中的位置参数。默认为None。
kwargs：URL中的关键字参数。默认为None。
current_app：当前应用的名称。默认为None。



默认URL配置：
如果没有提供 urlconf，则使用默认的URL配置。
获取解析器 resolver。



参数初始化：
初始化 args 和 kwargs 参数为空列表或字典。

脚本前缀：
获取脚本前缀 prefix。



处理视图名称：
如果 viewname 不是字符串类型，直接赋值给 view。
如果是字符串类型，则按冒号分割 viewname，获取路径和视图。



命名空间处理：
如果提供了 current_app，将其路径分割并反转。
遍历路径，解析命名空间，处理命名空间转换器。


反向解析：
使用解析器 resolver 和脚本前缀 prefix 进行反向解析，生成URL。

返回URL：
最终返回生成的URL。