博客

详解Django的 get_success_url() 函数：获取成功提交表单后的重定向 URL

  • Post category:Python

Django是一个优秀的Web应用框架，其中的get_success_url()函数用于处理成功后的跳转页面，其功能十分重要，下面就详细讲解一下它的作用和使用方法。

1. get_success_url()函数的作用

Django的get_success_url()函数用于在表单提交成功后，控制页面的跳转。当表单提交成功后，Django会调用get_success_url()函数来获取跳转页面的URL。因此，这个函数的作用是为表单提交提供跳转的URL，同时可以实现更灵活、个性化的页面控制。

2. get_success_url()函数的使用方法

要使用get_success_url()函数，可以在Django的View（视图）中重写这个函数，在函数中定义跳转的URL。具体的使用方法见下:

from django.urls import reverse_lazy
from django.views.generic.edit import CreateView

class MyCreateView(CreateView):
    # 定义成功提交后跳转页面的URL（本例为博客详情页）
    success_url = reverse_lazy('blog:detail')

    # 重写get_success_url()函数，返回跳转页面的URL
    def get_success_url(self):
        return self.success_url

在上面的代码中，我们定义了一个名为MyCreateView的视图，并重写了get_success_url()函数。默认情况下，get_success_url()函数返回success_url属性指定的URL，而我们在这里使用的是一个reverse_lazy()函数来获取博客详情页的URL。

在其他的场景中，可能需要根据表单提交的内容来动态确定跳转的URL，此时可以在get_success_url()函数中动态地生成URL。

class MyCreateView(CreateView):
    # 指定成功提交后跳转页面的名称
    success_url_name = 'blog:detail'

    # 重写get_success_url()函数，动态生成跳转页面的URL
    def get_success_url(self):
        # 根据表单提交的内容获取对应的博客ID
        blog_id = self.object.id
        # 动态生成博客详情页的URL
        return reverse_lazy(self.success_url_name, kwargs={'pk': blog_id})

在这个例子中，我们使用success_url_name属性来指定跳转页面的名称，并在get_success_url()函数中根据表单提交的内容动态生成跳转的博客详情页的URL。

3. 实例分析

下面提供两个用例，以更好地理解get_success_url()函数的作用和使用方法。

例1：重定向到同一个页面

假设我们有一个反馈表单，用于接收用户对网站的反馈信息。当用户提交表单后，我们应该让他们知道他们的反馈已经成功提交，此时可以重定向到同一个页面，并显示一个成功提交的提示信息。这个例子中的场景需要使用get_success_url()函数来动态生成URL。

from django.urls import reverse_lazy
from django.shortcuts import render, redirect
from django.views.generic import TemplateView
from django.views import View
from myapp.forms import FeedbackForm

class FeedbackView(View):
    template_name = 'feedback.html'
    form_class = FeedbackForm

    def get(self, request):
        form = self.form_class()

        context = {
            'form': form,
        }
        return render(request, self.template_name, context)

    def post(self, request):
        form = self.form_class(request.POST)

        if form.is_valid():
            # 保存表单内容并存入数据库
            form.save()
            # 显示提交成功的提示信息
            messages.success(request, 'Thank you for your feedback!')
            # 获取当前页面的URL
            url = request.path
            # 重定向到同一个页面，并显示成功信息
            return redirect(url)

        context = {
            'form': form,
        }
        return render(request, self.template_name, context)

在上面的代码中，我们使用Django的messages模块向用户显示提交成功的提示信息，然后使用request.path获取当前页面的URL，并使用redirect()函数对其进行重定向。

例2：跳转到详情页

假设我们有一个博客网站，用户可以在博客列表页提交新博客。当用户成功提交一篇新博客后，我们希望自动跳转到博客详情页，以查看刚刚提交的博客。这个例子中的场景需要使用success_url属性，而不是get_success_url()函数。

from django.urls import reverse_lazy
from django.views.generic.edit import CreateView
from blog.models import Blog

class CreateBlogView(CreateView):
    model = Blog
    fields = ['title', 'body']
    success_url = reverse_lazy('blog:detail')

    def form_valid(self, form):
        # 获取博客作者
        form.instance.author = self.request.user
        # 调用父类的form_valid()函数
        response = super().form_valid(form)
        return response

在上面的代码中，我们创建了一个名为CreateBlogView的视图，并设置它的model属性为Blog。我们还指定了要使用的字段、成功提交后要跳转的页面（即博客详情页），并在form_valid()函数中设置博客的作者信息。由于CreateView已经在内部处理了表单的提交，因此调用父类的form_valid()函数可以确保博客已被正确保存。

结语

以上就是get_success_url()函数的作用和使用方法的完整攻略。通过这篇文章，你可以掌握这个函数的基本知识并用它来实现一些有趣的场景。总的来说，这个函数可以让我们更好地控制表单提交后的页面跳转，提高网站的用户体验。

Tags: