GraphQL在Django中的使用教程

更新時間：2022年12月26日 10:19:14 作者：Mr.Lee jack

這篇文章主要介紹了GraphQL在Django中的使用教程,本文結(jié)合示例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

簡介

特點(diǎn)

請求你所要的數(shù)據(jù)，不多不少
獲取多個資源，只用一個請求
描述所有的可能，類型系統(tǒng)
幾乎所有語言支持

文檔

Graphene-Python

GraphQL | A query language for your API

背景

傳統(tǒng)restful的接口定義類型多，試圖簡化接口定義
django中使用restframework定義restful資源接口時，可能會出現(xiàn)深度查詢，造成有時候查詢過度
例如前端用戶需要查詢接口用于展示在下拉框時，用戶僅需要id與value值時，造成無用字段冗余，影響接口返回性能
當(dāng)一張表字段較多時，例如接口1一共有40個字段，A頁面需要5個字段做展示，B頁面需要另外10個字段展示，這時我們需要根據(jù)用戶需求定義返回接口提升性能，且數(shù)據(jù)不會被暴露

實(shí)際問題

問題

請求數(shù)據(jù)量40kB可以根據(jù)用戶縮減，也就是返回數(shù)據(jù)量可以做到<40KB
后端數(shù)據(jù)實(shí)際耗時783ms,但是數(shù)據(jù)傳輸一共耗時5s
Django中如何使用呢
安裝

安裝

pip install graphene-django

django配置

INSTALLED_APPS = [
    "django.contrib.staticfiles", 
    "graphene_django"
    ]
GRAPHENE = {
    "SCHEMA": "test_api.schema.schema" # 下文中需要定義schema.py文件
}

Demo

定義數(shù)據(jù)庫模型

from django.db import models


class Category(models.Model):
    name = models.CharField(max_length=100, help_text="名稱")
    id = models.BigAutoField(primary_key=True)


class Ingredient(models.Model):
    id = models.BigAutoField(primary_key=True)
    name = models.CharField(max_length=100, help_text="名稱")
    notes = models.TextField(help_text="筆記")
    category = models.ForeignKey(
        Category, related_name="category", on_delete=models.CASCADE
    )

    def __str__(self):
        return self.name

定義serializer

from graphene_django.rest_framework.mutation import SerializerMutation
from rest_framework.serializers import ModelSerializer

from ..models import Category, Ingredient


class CategorySerializer(ModelSerializer):
    class Meta:
        model = Category
        fields = "__all__"


class IngredientSerializer(ModelSerializer):
    class Meta:
        model = Ingredient
        fields = "__all__"

定義接口

import graphene
from graphene import relay
from graphene_django import DjangoObjectType
from graphene_django.filter import DjangoFilterConnectionField
from graphene_django.rest_framework.mutation import SerializerMutation

from ..models import Category, Ingredient

from ..serializer import CategorySerializer, IngredientSerializer


# 為查詢添加查詢總數(shù)
class CountableConnectionBase(relay.Connection):
    class Meta:
        abstract = True

    total_count = graphene.Int()

    def resolve_total_count(self, info, **kwargs):
        return self.iterable.count()


# Ingredient 查看過濾
class IngredientFilter(DjangoObjectType):
    class Meta:
        model = Ingredient
        fields = "__all__"
        filter_fields = {
            "name": ['exact', "contains", "istartswith"],
            "category": ["exact"],
            'category__name': ['exact'],
        }
        interfaces = (relay.Node,)
        connection_class = CountableConnectionBase

    extra_field = graphene.String()

    def resolve_extra_field(self: Ingredient, info):
        return "hello!" + str(self.id)


# CategoryFilter 查詢過濾
class CategoryFilter(DjangoObjectType):
    class Meta:
        model = Category
        fields = "__all__"
        filter_fields = {
            "name": ['exact', "contains", "istartswith"],
        }
        interfaces = (relay.Node,)
        connection_class = CountableConnectionBase


# CategoryMutation 修改或新增
class CategoryMutation(SerializerMutation):
    class Meta:
        serializer_class = CategorySerializer


# IngredientMutation 修改或新增
class IngredientMutation(SerializerMutation):
    class Meta:
        serializer_class = IngredientSerializer


# 匯總query接口
class ApiQuery(graphene.ObjectType):
    search_category = DjangoFilterConnectionField(CategoryFilter)
    search_ingredient = DjangoFilterConnectionField(IngredientFilter)


# 匯總操作類接口
class ApiMutation(graphene.ObjectType):
    update_category = CategoryMutation.Field()
    update_ingredient = IngredientMutation.Field()

匯總所有接口

import graphene

from .api import ApiQuery, ApiMutation


class Query(ApiQuery):
    # 新增時提供多繼承即可
    pass


class Mutation(ApiMutation):
    # 新增時提供多繼承即可
    pass


schema = graphene.Schema(query=Query, mutation=Mutation)

啟動