DjangoJSONResponse：讓接口開發更簡單

一、什麼是DjangoJSONResponse

DjangoJSONResponse是一個用於快速開發Django框架JSON接口的庫。它使用了Django自帶的JsonResponse類來向客戶端返回JSON結果，同時提供了一些簡單的裝飾器來幫助開發者更方便、快速地開發接口。

二、怎樣使用DjangoJSONResponse

1. 安裝

在Django項目的虛擬環境中，使用pip命令安裝DjangoJSONResponse。

pip install djangojsonresponse

2. 導入

在Django項目中，引入DjangoJSONResponse庫。

from djangojsonresponse import JsonResponse, json_response, ajax_required

3. JsonResponse類

DjangoJSONResponse庫中提供了一個JsonResponse類，直接繼承自Django自帶的JsonResponse類。該類提供了以下幾個方法：

• JsonResponse.success(data=None, msg=’請求成功’)：返回一個請求成功的JSON結果，data參數用來設置返回數據，msg參數用來設置返回信息；
• JsonResponse.error(data=None, code=-1, msg=’請求失敗’)：返回一個請求失敗的JSON結果，data參數用來設置返回數據，code參數是一個錯誤碼，用來表示錯誤類型，msg參數用來設置返回信息；
• JsonResponse.pagination(total_count, queryset, serializer_class, page_size=10)：返回一個分頁的JSON結果，total_count是總數據量，queryset是要分頁的queryset對象，serializer_class是序列化器類，page_size是每頁數據數量；

4. 裝飾器

DjangoJSONResponse庫中提供了一些簡單的裝飾器來幫助開發者更方便、快速地開發接口。

• @json_response()：將視圖函數的返回值封裝成JSON格式返回；
• @ajax_required()：判斷請求是否為AJAX請求，僅返回JSON結果；

三、實例應用

1. JsonResponse類的使用

示例代碼：

from django.http import JsonResponse
from django.shortcuts import render

def index(request):
    data = {'name': '張三', 'age': 18}
    return JsonResponse.success(data=data)

在視圖函數中，可以直接使用JsonResponse類的success方法返回JSON結果。示例中返回一個data為{‘name’: ‘張三’, ‘age’: 18}的JSON數據，msg會默認返回“請求成功”的信息。

2. 裝飾器的使用

示例代碼：

from django.shortcuts import render
from djangojsonresponse import json_response, ajax_required

@json_response()
@ajax_required()
def index(request):
    data = {'name': '張三', 'age': 18}
    return data

這裡使用了兩個裝飾器：@json_response和@ajax_required。@json_response將視圖函數返回值封裝成JSON格式返回，在這個例子中，返回的是一個為{‘name’: ‘張三’, ‘age’: 18}的JSON數據。@ajax_required裝飾器會判斷請求是否為AJAX請求，僅返回JSON結果。

3. 分頁的使用

示例代碼：

from django.shortcuts import render
from djangojsonresponse import JsonResponse

def index(request):
    queryset = User.objects.filter(is_active=True)
    total_count = queryset.count()
    page = request.GET.get('page', 1)
    page_size = request.GET.get('page_size', 10)
    paginator = Paginator(queryset, page_size)
    serializer = UserSerializer(paginator.page(page), many=True)
    data = serializer.data
    return JsonResponse.pagination(total_count=total_count, queryset=queryset, serializer_class=UserSerializer, page_size=page_size)

在這個例子中，我們通過Django自帶的Paginator類來進行分頁。使用JsonResponse類的pagination方法返回分頁的JSON結果。返回結果中包含了“data”字段（即序列化後的數據）以及“meta”字段，該字段包括了總數據量“total_count”、“page_size”（每頁數據量）、“page”（當前頁碼）三個參數。?