博客

详解Django的 get_success_message() 函数：获取表单验证成功后的消息

  • Post category:Python

get_success_message()是Django框架中用于获取成功提示信息的函数。当用户执行某些操作，例如创建、更新或删除对象时，如果操作成功，Django会默认跳转到下一个页面，而不会给用户任何提示。这时，使用get_success_message()函数可以在操作成功后显示一条自定义的提示信息。

下面我们来详细讲解该函数的使用方法和作用。

使用方法

get_success_message()函数定义在django.contrib.messages.views模块中，因此需要在视图函数中引入该模块。使用方法如下：

  1. 在你的视图函数中引入messages模块和SuccessMessageMixin类：

    python
    from django.contrib import messages
    from django.contrib.messages.views import SuccessMessageMixin
    from django.views.generic import CreateView, UpdateView, DeleteView

  2. 在视图类中混合SuccessMessageMixin类：

    python
    class MyView(SuccessMessageMixin, CreateView):
    # 视图代码...

  3. 为get_success_message()方法提供一个返回提示信息字符串的实现。你可以根据自己的需要编写不同的提示信息，例如：

    python
    class MyView(SuccessMessageMixin, CreateView):
    # 视图代码...
    def get_success_message(self, cleaned_data):
    return f'The {self.model.__name__} "{cleaned_data["name"]}" was created successfully!'

作用

get_success_message()函数的作用在上面已经提到过。它可以在成功创建、更新或删除对象时，显示一条自定义的提示信息。下面我们来看几个例子，以便更好地理解它的用途：

示例1：创建对象成功提示

假设我们有一个注册用户的页面，当用户成功注册时，我们希望显示一条“注册成功”的提示信息。这时，我们可以在相关的视图类中添加如下代码：

class SignUpView(SuccessMessageMixin, CreateView):
    model = User
    form_class = SignUpForm
    success_url = '/login'
    success_message = 'You have successfully signed up! Welcome to our website.'

    def get_success_message(self, cleaned_data):
        return self.success_message

在上面的代码中，我们混合了SuccessMessageMixin类，并提供了一个get_success_message()方法，其中 self.success_message 是在类属性中定义的提示消息。此外，我们还定义了success_url属性，表示成功后应该转到哪个页面。

示例2：删除对象成功提示

我们再来看一个例子：假设我们有一个删除评论的功能，当删除某个评论成功后，我们希望显示一条“评论已删除”的提示信息。这时，我们可以在相关的视图类中添加如下代码：

class CommentDeleteView(SuccessMessageMixin, DeleteView):
    model = Comment
    success_url = reverse_lazy('post-detail')
    success_message = 'Comment deleted successfully.'

    def get_success_message(self, cleaned_data):
        return self.success_message

在上面的代码中，我们同样混合了SuccessMessageMixin类，并提供了一个get_success_message()方法来获取成功提示信息。此外，我们还定义了success_url属性，表示删除成功后应该转到哪个页面。

到这里，我们已经了解了get_success_message()的使用方法和作用。在实际开发过程中，再结合自己的需求和场景，就能更好地理解该函数的妙用。

Tags: