构建高效PythonWeb：GraphQL+Sanic

news2024/9/23 9:32:48

1.1 简介：在当今快速发展的技术时代，Web应用的性能和灵活性变得越来越重要。在众多技术中，GraphQL和Sanic以其独特的优势脱颖而出。GraphQL，作为一个强大的数据查询语言，为前端和后端之间的通信提供了极大的灵活性。而Sanic，则是一个快速的异步Web框架，专为快速HTTP响应设计。本文将探索如何将GraphQL与Sanic结合使用，以创建高效、灵活的Python Web应用。

2.1 历史攻略：

gin框架：安装使用、restful增删改查

sanic：view - restful普通和异步的写法

API-restful规范

3.1 GraphQL：GraphQL是由Facebook开发的一种数据查询和操作语言，主要用于API。与传统的REST API相比，GraphQL的主要优点在于其灵活性和效率。它允许客户端准确指定所需的数据，避免了过度获取或欠缺获取数据的问题。此外，GraphQL支持实时数据更新，非常适合需要实时功能的现代应用。

3.2 GraphQL的核心特性：

精准的数据获取：客户端可以请求所需的确切数据，无需额外负载。

单一终点：所有数据请求都通过单一API终点处理，简化了数据交互流程。

类型系统：GraphQL拥有强类型系统，使得数据模型更加清晰和健壮。

4.1 安装依赖：注意要相应版本，太新的可能不兼容。

pip install sanic == 20.12.0
pip install graphene == 2.1.9
pip install graphene sanic-graphql == 1.1.0

4.2 案例源码：

# -*- coding: utf-8 -*-
# time: 2024/01/05 09:54
# file: graphql_demo.py
# 公众号: 玩转测试开发

import graphene
from sanic import Sanic
from sanic_graphql import GraphQLView


# 定义一个人物信息的GraphQL类型
class Person(graphene.ObjectType):
    name = graphene.String()
    age = graphene.Int()
    address = graphene.String()


class Query(graphene.ObjectType):
    hello = graphene.String()
    fruit = graphene.List(graphene.String)  # 定义为字符串列表
    person_info = graphene.Field(Person)  # 使用Person类型

    def resolve_hello(self, info):
        return "World"

    def resolve_fruit(self, info):
        return ["apple", "orange"]  # 返回一个字符串列表

    def resolve_person_info(self, info):
        # 返回一个Person实例
        return Person(name="Tom", age=30, address="UK")


app = Sanic("GraphQLApp")

app.add_route(
    GraphQLView.as_view(
        schema=graphene.Schema(query=Query),
        graphiql=True
    ),
    '/graphql',
    methods=['GET', 'POST']  # 允许 GET 和 POST 请求
)

if __name__ == '__main__':
    app.run()

4.3 后端运行：

5.1 客户端访问：http://127.0.0.1:8000/graphql

5.2 单个查询：

{
  hello
}

5.3 单个查询的返回结果：

{
  "data": {
    "hello": "World"
  }
}

5.4 多个查询：

{
  hello
  fruit
  personInfo {
    name
    age
    address
  }
}

5.5 多个查询的返回结果：

{
  "data": {
    "hello": "World",
    "fruit": [
      "apple",
      "orange"
    ],
    "personInfo": {
      "name": "Tom",
      "age": 30,
      "address": "UK"
    }
  }
}