详解Django的 get_success_json() 函数：获取表单验证成功后的 JSON 数据

Django中的get_success_json()函数是一个通用的视图mixin中的一个方法。其作用是返回一个JSON对象，该JSON对象包含成功状态的信息。

在Django中，一些类视图提供一个mixin机制，用于增强视图的功能。其中一个通用的mixin是SingleObjectMixin，它允许我们检索一个单一的对象并将其传递给模板或JSON格式。如果我们想要在视图中使用这个mixin，我们可以继承SingleObjectMixin并添加get_success_json()方法，该方法将返回一个JSON对象，该对象包含成功信息。

下面是get_success_json()方法的使用方法和示例：

使用方法

我们可以在继承了Mixin的视图中按照以下方式编写get_success_json()方法。

class MyClass(SingleObjectMixin):

    def get_success_json(self, data):
        return JsonResponse({
            'success': True,
            'data': data,
        })

get_success_json()方法接受一个参数data，该参数允许我们将任何数据类型转换为JSON并返回包含成功状态的JSON响应对象。我们可以使用该方法自行确定成功状态并返回定制的JSON响应。

示例

我们可以使用以下示例来说明get_success_json()的使用方法：

示例1：获取单个对象

假设我们要检索ID为1的Order对象，并返回JSON格式的响应。我们可以编写以下代码。

from django.views.generic import View
from django.http import JsonResponse
from django.shortcuts import get_object_or_404
from django.urls import reverse_lazy
from django.utils.decorators import method_decorator
from django.contrib.auth.decorators import login_required
from django.contrib.messages.views import SuccessMessageMixin
from django.views.generic.edit import CreateView
from django.views.generic.detail import SingleObjectMixin
from .models import Order

@method_decorator(login_required, name='dispatch')
class OrderDetailView(SuccessMessageMixin, SingleObjectMixin, View):

    model = Order
    template_name = 'order_detail.html'

    def get(self, request, *args, **kwargs):
        order = self.get_object()
        return self.get_success_json(order.to_dict())

    def get_success_json(self, data):
        return JsonResponse({
            'success': True,
            'data': data,
        })

    @staticmethod
    def get_redirect_url():
        return reverse_lazy('home')

在上面的示例中，我们从SingleObjectMixin中获取了get_object()方法，该方法允许我们检索ID为1的Order对象。在get()方法中，我们使用to_dict()方法将Order模型对象转换为字典对象，并将该字典对象传递给get_success_json()方法，该方法将返回JSON响应。

示例2：创建新的对象

我们可以使用以下示例来说明如何在创建新的Order对象并返回JSON格式响应。

from django.views.generic.edit import CreateView
from django.contrib.messages.views import SuccessMessageMixin
from django.views.generic.detail import SingleObjectMixin

class OrderCreateView(SuccessMessageMixin, SingleObjectMixin, CreateView):

    model = Order
    template_name = 'order_create.html'
    fields = [
        'name',
        'description',
        'price',
    ]

    def form_valid(self, form):
        order = form.save(commit=False)
        order.user = self.request.user
        order.save()
        return self.get_success_json({
            'order_id': order.id,
            'message': 'Order created successfully.',
        })

    def get_success_json(self, data):
        return JsonResponse({
            'success': True,
            'data': data,
        })

在上面的示例中，我们从CreateView中继承了OrderCreateView，并覆盖了form_valid()方法。在该方法中，我们创建了一个新的Order对象并使用get_success_json()方法返回一个JSON响应，该响应包含新Order对象的ID和成功状态的消息。