GraphQL 接口设计

本篇文章主要是结合我之前面试的各种经历和实战开发中遇到的问题解决经验整理的，希望这篇《GraphQL 接口设计》对你有很大帮助！欢迎收藏，分享给更多的需要的朋友学习~

文章原文请移步我的博客：GraphQL 接口设计

graphql 是一种用于 API 的查询语言。它提供了一套完整的和易于理解的 API 接口数据描述，给客户端权力去精准查询他们需要的数据，而不用再去实现其他更多的代码，使 API 接口开发变得更简单高效。

最近在用

type Role {
  name: String
  note: String
}
type User {
  id: Int
  name: String
  gender: Int
  role: Role
}

上面代码用于描述

query userInfo {
  user(id: Int) {
    id
    name
    gender
    role {
      name
      note
    }
  }
}

从上面的代码可以大概猜测出，如果我们不需要查询

query userInfo {
  user(id: Int) {
    id
    name
    gender
  }
}

当请求到达服务端时，graphql会对请求体进行解析，当解析到

function userResolver (id) {
  // ...
  // return User
}

function roleResolver (userId) {
  // ...
  // return Role
}

我们可以在resolver中执行sql、http请求、rpc通信等任何能够获取到所需数据的逻辑。最终只需要按照预定义的结构将数据返回即可。

Schema

前面用来定义不同类型数据结构的代码，称做

{
  User {
    name
    role
  }
}

如果我们把role字段去掉，那么服务器将不会再执行

{
  User {
    name
  }
}

type User {
  name: String
  gender: Int
  # password: String // 敏感信息不应该出现
}
type Role {
  name: String
  note: String
}

其中需要注意的是，敏感数据不应该出现在敏感信息（用户密码等），即使Resolver的结果包含这些敏感信息，只要

type Role {
  name: String
  note: String
}
type User {
  name: String
  gender: Int
  role: Role
}

function userResolver () {
  // ...
  // return User
}

function roleResolver (userId) {
  // ...
  // return Role
}

我们写了

# schema
type User {
  name: String
  gender: Int
  role: Role
  groups: [Group] # 用户组
  userGroups: [UserGroups] # 用户组关系表
}

type Group {
  id: Int
  name: String
  note: String
  users: [User]
  userGroups: [UserGroups]
}

type UserGroup {
  id: Int
  userId: Int
  groupId: Int
  note: String # 关系表中存储一些关联信息
  user: User
  group: Group
}

对于上面的schema，可以看到，在

{
  user (id: 1) {
    name
    groups {
      id
      name
      note
      userGroups {
        id
        userId
        groupId
        note
        user {
          name
          groups {
            # ...
          }
        }
      }
    }
  }
}

可能有人会问，上面的操作无限循环了。没错，确实无限循环了，这并不是bug，而是我前面提到的建立起了连同关系。对于不同的场景，我们可以进行不同方式查询，比如当我需要对用户的用户组进行搜索的时候，我可以在

{
  user (id: 1) {
    name
    groups (name: "admin") {
      id
      name
      note
      userGroups (userId: 1) {
        id
        note
      }
    }
  }
}

上面的查询，如果我们只想对

{
  user (id: 1) {
    name
    userGroups (note: "新用户") {
      id
      userId
      groupId
      note
      group {
        id
        name
        note
      }
    }
  }
}

可以发现，通过建立了对应关系的连通图之后，我们可以从一个表查询到任意一个与之关系的表，同时可以无限嵌套查询。

对于无限循环问题无需担心，因为我们需要指定关联字段后，graphql才会去执行对应的

Resolver

关系处理基本就讲这些内容，如有更好的想法欢迎骚扰。

结束语

本文是我在学习和使用graphql中的实践和思考，如有错误或建议欢迎联系我指正和探讨。另在在实践之前应当着重思考是否需要使用graphql，因为restful api已经能满足大部分的场景需求，盲目的去使用graphql可能会带来一些意料之外的问题。

今天关于《GraphQL 接口设计》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！