GraphQL入门之查询指令Directive

接前面的文章,考虑这么一种场景,有时候我们希望根据某些参数条件来决定返回某些字段。比如下面的查询操作,有时候我们希望返回name字段,有时候不希望。

shell 复制代码
query GetUsers {
  users {
    id,
    name,
    email
  }
}

此时我们就可以使用 GraphQL 的指令 Directive 来解决这个问题。GraphQL 中使用标识符@+已命名的参数来实现。GraphQL 规范默认支持了几个指令:

@deprecated(reason: String) - 将字段标记为已弃用并说明原因

@skip (if: Boolean) - 如果条件满足则跳过该字段

@include (if: Boolean) - 如果条件满足则包括该字段

下面举个列子看一下。

创建 Node.js 的工程

shell 复制代码
mkdir myapp
cd myapp
npm init (一路回车)

安装依赖包

shell 复制代码
npm install @apollo/server graphql

定义 Schema

创建 schema.graphql 文件,内容如下:

shell 复制代码
type User {
    id: ID!
    name: String!
    email: String!
}

type Query {
    users(includeName: Boolean, skipId: Boolean): [User],
}

schema 文件主要包括:

  1. 定义模型对象:定义了一个User对象,包括 id, name 和 email 属性。
  2. 定义查询操作:定义了一个查询操作,返回用户列表。查询接受两个参数,includeName是否包括name字段,skipId是否跳过id字段。

实现处理器

创建 resolvers.js 文件,内容如下:

javascript 复制代码
const user1 = {id: 1, name: 'user1', email: 'user1@gmail.com'};
const user2 = {id: 2, name: 'user2', email: 'user2@gmail.com'};
const user3 = {id: 3, name: 'user3', email: 'user3@gmail.com'};
const users = [user1, user2, user3];

const resolvers = {
  Query: {
    users(obj, args, context, info) {
      return users;
    },
  },
};

module.exports = resolvers;

处理器文件主要包括

  1. 准备测试数据:这里创建了一个 User 对象的数据组并初始化了几条数据。
  2. 定义处理函数:不做特殊处理,直接返回所有 User 的数组。

主程序

创建 server.js 文件,内容如下:

javascript 复制代码
const { ApolloServer } =  require('@apollo/server');
const { startStandaloneServer } = require('@apollo/server/standalone');
const fs = require("fs");

const typeDefs = fs.readFileSync('./schema.graphql').toString();
const resolvers = require('./resolvers');

const server = new ApolloServer({
  typeDefs,
  resolvers,
});

startStandaloneServer(server).then(function(data) {
  console.log(`🚀 Server ready at ${data.url}`);
});

测试

启动服务

shell 复制代码
node server.js

服务启动后,访问 http://localhost:4000 进行测试。

列表操作

查询操作

shell 复制代码
query GetUsers($includeName: Boolean!, $skipId: Boolean!) {
  users(includeName: $includeName, skipId: $skipId) {
    id @skip(if: $skipId),
    name @include(if: $includeName),
    email
  }
}

查询参数

json 复制代码
{
  "includeName": false,
  "skipId": true
}

查询结果

json 复制代码
{
  "data": {
    "users": [
      {
        "email": "user1@gmail.com"
      },
      {
        "email": "user2@gmail.com"
      },
      {
        "email": "user3@gmail.com"
      }
    ]
  }
}
相关推荐
Linux实战笔记1 个月前
GraphQL vs REST API 设计实测:灵活查询与性能权衡逐项对比
性能优化·graphql·rest api·1024程序员节·dataloader·n+1 查询
Linux实战笔记1 个月前
压测后我对GraphQL vs REST API 设计改了灵活查询与性能权衡
性能优化·graphql·rest api·接口设计·n+1 问题
白帽攻防录2 个月前
SRC 挖洞:Dgraph GraphQL 数据库注入深度复盘,CVE-2026-41328 两个请求拖走全库数据
网络安全·graphql
白帽攻防录2 个月前
SRC 挖洞:GitLab GraphQL 指令绕过深度复盘,CVE-2026-19478 未授权删项目怎么打穿代码托管平台
网络·网络安全·gitlab·graphql
2601_962097362 个月前
GraphQL,Grafana和Dash
python·grafana·数据可视化·graphql·dash
redfred3 个月前
hoppscotch 使用教程:开源 API 调试工具 Postman 免费替代 Web/桌面/Docker 部署详解
开源·postman·graphql
大鹏说大话3 个月前
API 设计之道:用 PHP 构建符合 RESTful 与 GraphQL 规范的高可用接口
php·restful·graphql
美人胖八分3 个月前
RESTful、GraphQL 与 gRPC 接口设计规范及最佳实践
restful·graphql·设计规范·api接口
阿标在干嘛4 个月前
从RESTful到GraphQL:政策快报平台接口设计的演进
后端·restful·graphql
troyzhxu4 个月前
列表查询的 GraphQL —— 一行代码终结你的 if-else 地狱!
java·springboot·graphql