使用PHP和GraphQL实现高效的API数据查询和操作-php教程-PHP中文网

使用PHP和GraphQL实现高效的API数据查询和操作

WBOY

发布： 2023-06-25 11:23:27

原创

1361人浏览过

随着互联网技术的不断发展，api已经成为了各种软件之间相互交流的重要方式。api能够提供统一的数据接口，使得不同的软件可以互相访问和使用。然而，随着api的数量和规模的不断增大，如何快速高效地处理api数据的查询和操作成为了重要的问题。

在这个问题上，PHP和GraphQL可以提供一种非常有效的解决方案。本文将针对这个解决方案进行一些简单的介绍和分析。

PHP概述

PHP是一种通用的开源脚本语言，特别适用于Web开发并可嵌入HTML中使用。与其他编程语言不同，PHP的语法比较容易入门，因此它成为了许多初学者的首选语言。同时，PHP也具备强大的编程能力，可以轻松地处理各种复杂任务。

PHP的优缺点

立即学习“PHP免费学习笔记（深入）”；

PHP的优点包括：

易于上手：PHP的语法比较简单，许多初学者可以很快入门。
可跨平台使用：PHP可以在大多数操作系统上运行，包括Windows、Linux、MacOS等。
支持开源：PHP是一个完全开源的项目，有庞大的社区和活跃的开发者。
可扩展性好：PHP可以使用各种扩展来增加其功能，比如MySQL扩展、SOAP扩展等。
可嵌入HTML中：PHP可以嵌入到HTML中，方便Web开发。

PHP的缺点包括：

代码可读性差：PHP的代码通常比较密集，可读性不如其他语言。
性能有限：受限于其动态解释的性质，PHP的性能比较低。
安全性不高：PHP存在一些安全隐患，如SQL注入、XSS攻击等。

GraphQL概述

GraphQL是一种数据查询语言和运行时环境，可用于API的查询和操作。它最初由Facebook开发，在2015年公开发布。GraphQL的核心思想是允许客户端指定其需要的数据，从而减少不必要的网络流量和服务器负载。

GraphQL的优缺点

GraphQL的优点包括：

灵活性强：GraphQL允许客户端自定义数据的查询和返回方式，相对于传统的REST API更加灵活。
可嵌套：GraphQL可以根据需要嵌套数据，并根据需要进行多次查询，提高了查询效率。
模板化：GraphQL的Schema定义了可用数据和数据类型的模板，提高了开发效率。
客户端控制：GraphQL可以让客户端控制API返回的数据，避免了传统API中不必要的数据传输等问题。

GraphQL的缺点包括：

学习成本高：与REST API相比，GraphQL的学习成本较高，需要花费较多时间学习其语言和概念。
跨域访问限制：由于安全原因，浏览器的JavaScript API无法进行跨域访问GraphQL API。
可调试性差：由于GraphQL的查询和返回方式是灵活的，因此其调试难度较大。

如何使用PHP和GraphQL实现高效的API数据查询和操作？

PHP和GraphQL可以相互结合使用，以便提高API的查询和操作效率。下面是其中一种实现方式：

火龙果写作

用火龙果，轻松写作，通过校对、改写、扩展等功能实现高质量内容生产。

106

查看详情

步骤一：创建GraphQL Schema

GraphQL Schema是一种定义数据类型和操作的模板，用来指定API支持的数据类型和可执行的操作。使用GraphQL的Schema后，我们就可以使用在该模型上工作的查询语言。

我们可以建立如下的Schema：

type Book {
    id: ID!
    title: String!
    author: String!
    publisher: String!
    price: Float!
}

type Query {
    getBook(id: ID!): Book
    getAllBooks: [Book]
}

type Mutation {
    addBook(title: String!, author: String!, publisher: String!, price: Float!): ID!
    updateBook(id: ID!, title: String, author: String, publisher: String, price: Float): Book
    deleteBook(id: ID!): Boolean
}

登录后复制

步骤二：实现GraphQL执行器

GraphQL执行器可以执行查询，变异和订阅等操作。我们可以使用PHP实现GraphQL的执行器，下面是一个简单的实例。

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use GraphQLTypeSchema;
use GraphQLTypeDefinitionObjectType;
use GraphQLTypeDefinitionType;
use GraphQLGraphQL;
use GraphQLTypeDefinitionResolveInfo;

$db = mysqli_connect('localhost', 'root', '', 'books');
mysqli_query($db, "SET NAMES 'UTF8'");

$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => [
        'getBook' => [
            'type' => $bookType,
            'args' => [
                'id' => Type::nonNull(Type::id())
            ],
            'resolve' => function ($root, $args) use ($db) {
                $result = mysqli_query($db, "SELECT * FROM books WHERE id = {$args['id']}");
                $book = mysqli_fetch_assoc($result);
                return $book;
            }
        ],
        'getAllBooks' => [
            'type' => Type::listOf($bookType),
            'resolve' => function ($root, $args) use ($db) {
                $result = mysqli_query($db, "SELECT * FROM books");
                $books = mysqli_fetch_all($result, MYSQLI_ASSOC);
                return $books;
            }
        ]
    ]
]);

$mutationType = new ObjectType([
    'name' => 'Mutation',
    'fields' => [
        'addBook' => [
            'type' => Type::id(),
            'args' => [
                'title' => Type::nonNull(Type::string()),
                'author' => Type::nonNull(Type::string()),
                'publisher' => Type::nonNull(Type::string()),
                'price' => Type::nonNull(Type::float())
            ],
            'resolve' => function ($root, $args) use ($db) {
                $result = mysqli_query($db, "INSERT INTO books (title, author, publisher, price) VALUES ('{$args['title']}', '{$args['author']}', '{$args['publisher']}', {$args['price']})");
                $id = mysqli_insert_id($db);
                return $id;
            }
        ],
        'updateBook' => [
            'type' => $bookType,
            'args' => [
                'id' => Type::nonNull(Type::id()),
                'title' => Type::string(),
                'author' => Type::string(),
                'publisher' => Type::string(),
                'price' => Type::float()
            ],
            'resolve' => function ($root, $args) use ($db) {
                $sql = "UPDATE books SET";
                if (!is_null($args['title'])) $sql .= " title='{$args['title']}',";
                if (!is_null($args['author'])) $sql .= " author='{$args['author']}',";
                if (!is_null($args['publisher'])) $sql .= " publisher='{$args['publisher']}',";
                if (!is_null($args['price'])) $sql .= " price={$args['price']},";
                $sql = rtrim($sql, ',');
                $sql .= " WHERE id = {$args['id']}";
                mysqli_query($db, $sql);
                $result = mysqli_query($db, "SELECT * FROM books WHERE id = {$args['id']}");
                $book = mysqli_fetch_assoc($result);
                return $book;
            }
        ],
        'deleteBook' => [
            'type' => Type::boolean(),
            'args' => [
                'id' => Type::nonNull(Type::id())
            ],
            'resolve' => function ($root, $args) use ($db) {
                mysqli_query($db, "DELETE FROM books WHERE id = {$args['id']}");
                return true;
            }
        ],
    ]
]);

$bookType = new ObjectType([
    'name' => 'Book',
    'fields' => [
        'id' => [
            'type' => Type::nonNull(Type::id())
        ],
        'title' => [
            'type' => Type::nonNull(Type::string())
        ],
        'author' => [
            'type' => Type::nonNull(Type::string())
        ],
        'publisher' => [
            'type' => Type::nonNull(Type::string())
        ],
        'price' => [
            'type' => Type::nonNull(Type::float())
        ],
    ]
]);

$schema = new Schema([
    'query' => $queryType,
    'mutation' => $mutationType
]);

$input = file_get_contents('php://input');

try {
    $result = GraphQL::executeQuery($schema, $input);
    echo json_encode($result->toArray());
} catch (Exception $e) {
    echo json_encode([
        'error' => [
            'message' => $e->getMessage()
        ]
    ]);
}
?>

登录后复制

在这个PHP脚本中，我们创建了一个GraphQL Schema，并定义了三个请求：getBook、getAllBooks和addBook、updateBook、deleteBook（在Mutation中定义）。这些请求将提供查询、以及三种变异操作——添加、更新和删除。我们可以将它们存储在MySQL数据库中。在运行时，通过执行查询语句来处理请求。

步骤三：开发GraphQL客户端

在本阶段，客户端可以使用PHP脚本自动生成查询（或变异）语句。这意味着客户端不需要手写代码，也可以在不使用Web表单或UI的情况下快速构建GraphQL查询。我们可以使用如下的PHP库进行实现：

composer require  webonyx/graphql-php

登录后复制

下面是一个简单的PHP GraphQL客户端示例：

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use GraphQLClient;
use GraphQLQuery;
use GraphQLVariable;

$client = new Client('http://localhost/graphql.php', [
  'headers' => [
      'Content-Type' => 'application/json',
      'Accept' => 'application/json',
  ],
]);

// 查询所有书籍
$queryAllBooks = new Query('getAllBooks', [], [
    'id',
    'title',
    'author',
    'publisher',
    'price'
]);
$response = $client->runQuery($queryAllBooks);
var_dump($response);

// 查询某本书
$queryBook = new Query('getBook', [
    new Variable('id', 'ID!', '1')
], [
    'id',
    'title',
    'author',
    'publisher',
    'price'
]);
$response = $client->runQuery($queryBook);
var_dump($response);

// 添加一本新书
$mutationAddBook = new Query('addBook', [
    new Variable('title', 'String!', 'PHP Programming'),
    new Variable('author', 'String!', 'John Doe'),
    new Variable('publisher', 'String!', 'Publisher 123'),
    new Variable('price', 'Float!', 123.45)
], [
    'id'
]);
$response = $client->runQuery($mutationAddBook);
var_dump($response);

// 更新一本书
$mutationUpdateBook = new Query('updateBook', [
    new Variable('id', 'ID!', 1),
    new Variable('title', 'String', 'PHP Programming'),
    new Variable('author', 'String', 'John Doe'),
    new Variable('publisher', 'String', 'Publisher 321'),
    new Variable('price', 'Float', 123.45)
], [
    'id',
    'title',
    'author',
    'publisher',
    'price'
]);
$response = $client->runQuery($mutationUpdateBook);
var_dump($response);

// 删除一本书
$mutationDeleteBook = new Query('deleteBook', [
    new Variable('id', 'ID!', 1),
], [
    'id'
]);
$response = $client->runQuery($mutationDeleteBook);
var_dump($response);
?>

登录后复制

在这个客户端脚本中，我们定义了getAllBooks、getBook、addBook、updateBook、deleteBook五个请求。这些请求涵盖了在执行GraphQL API中最常见的操作。

最后思考

PHP和GraphQL的结合提供了一种高效处理API查询和操作的解决方案。PHP作为一种Web编程语言，适用于处理服务器端的业务逻辑；而GraphQL则可以通过客户端控制和模板化架构，减少数据传输量，提高了查询效率。通过上述三个步骤，我们可以更好地理解PHP和GraphQL在API开发中的应用场景，也可以做出更加智能、更加高效的API。

以上就是使用PHP和GraphQL实现高效的API数据查询和操作的详细内容，更多请关注php中文网其它相关文章！