记一次通过c#运用GraphQL调用Github api

一、Graphql是什么

　　最近在折腾使用Github api做个微信小程序练练手，本篇文章就是在这个过程中记录。

　　直接先看下GraphQL的语法风格，感受一下：

query {
  repository(owner:"octocat", name:"Hello-World") {
      id
  }
}复制代码

　　这是最最最简单的一个运用示例，效果上等价于http://graphqlapi.xxx.com/query/repository?owner=octocat&name=Hello-World ，返回的内容格式是这样：

{
  "data": {
    "repository": {
      "id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
    }
  }
}复制代码

　　再看下稍微复杂点的查询方式：

query {
  repository(owner:"octocat", name:"Hello-World") {
    issues(last:20, states:CLOSED) {
      edges {
        node {
          title
          url
          labels(first:5) {
            edges {
              node {
                name
              }
            }
          }
        }
      }
    }
  }
}复制代码

　　这是一个多级对象嵌套的查询，这里就不继续展开了。关于egde和node在下文会有少许讲解。对GraphQL有兴趣进行更深入了解的可以自行研究学习，我自己也是刚入门，不坑大家了：），官网是graphql.org/（这个可能打不开，可以打开国内的地址graphql.cn），Facebook发布的规范在 facebook.github.io/graphql/Oct…。

　　GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述，使得客户端能够准确地获得它需要的数据，而且没有任何冗余，也让 API 更容易地随着时间推移而演进，还能用于构建强大的开发者工具。

二、.net下如何运用GraphQL

　　由于我需要做一个定时任务将github上的数据定时拉到本地，所以自然的选择了后端处理的方式。找了一下.net下的GraphQL客户端，用了这个graphql-client。代码如下：

var heroRequest = new GraphQLRequest
                {
                    Query = graphql   //这里填写query的内容。
                };

var graphQLClient = new GraphQLClient("https://api.github.com/graphql");

graphQLClient.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue("Safari", "537.36"));   
//上面这行很关键，UserAgent一定要写上，要不然会出现403错误，花了好久才找到这个问题。
graphQLClient.DefaultRequestHeaders.Add("Authorization", "bearer token");   //这里的token是个占位，实际需要在Github上生成。
var graphQLResponse = graphQLClient.PostAsync(heroRequest).Result;复制代码

　　关于token的生成以及其它的一些环境准备工作，在github上有详细的描述，参见：developer.github.com/v4/guides/f…。

　　重要的事情说3遍：UserAgent一定要写上！！ UserAgent一定要写上！！ UserAgent一定要写上！！

三、运用GraphQL调用Github api

　　 Github提供的API和相关文档在developer.github.com/v4/ 右侧的目录树上，这次笔者需要拉取github的大量repository库，所以用到的search接口（但是很奇怪，这个接口在文档中并没有列出来，也不知道为什么）。建议大家可以先在Github提供的explorer中先测试和验证，OK了在把代码写到实际的项目中。

　　接着，笔者在实现自己需要的功能时又学习了2个概念，才能正常开展下面的工作。第一个是edge与node的概念，edge可以理解为一个分页对象，其中除了包含实际的数据外还有一个cursor（返回的每条数据的唯一标识，如果要分页的话用得到这个数据，配合before与after关键字来使用）字段，实际数据就是用node表示的。

　　另外GraphQL是强类型的，所以当笔者用到的search返回的结果并不是一个明确的数据对象时，先需要通过node下的__typename字段来获得实际的对象是什么。代码如下：

query {
  search(query:"language:c#",type:REPOSITORY,first:1){
    edges{
      cursor,
      node{
        __typename
      }
    }
  }
}复制代码

　　得到的结果是：

{
  "data": {
    "search": {
      "edges": [
        {
          "cursor": "Y3Vyc29yOjE=",
          "node": {
            "__typename": "Repository"
          }
        }
      ]
    }
  }
}复制代码

　　得到的实际的数据对象是Repository之后，通过查阅Github Api的文档得到该对象有哪些字段，并且从中选择需要的字段即可。这个就是GraphQL的设计天然优势之一，按需获取。单在接下去运用的时候又需要引入一个新的概念fragment，这个可以理解为一个模板，通过这个模板来向服务端指明需要获取的数据字段。代码如下：

fragment repFragment on Repository {
  name,
  forkCount,
  url,
  createdAt,
  updatedAt,
  licenseInfo{  //对象嵌套
    nickname    //licenseInfo的nickname字段
  },
  stargazers{   //对象嵌套
    totalCount  //stargazers的totalCount字段
  }
}

query {
  search(query:"language:c#",type:REPOSITORY,first:100){
    edges{
      cursor,
      node{
        __typename
        ...repFragment
      }
    }
  }
}复制代码

　　好了，这样就得到我需要的结果了。

　　下面附上笔者做的Demo：github.com/ZacharyFan/…，其中的token在配置文件中自行替换即可。

四、结语

　　最后附带提一下，GraphQL的出现，主要的场景还是在于赋能前端开发，赋予了前端开发者自由组织和定制请求数据的能力。这是一个将前后端分离后的界限偏向前端的框架，所以直接在前端通过GraphQL访问后端数据是个人比较推崇的方式。目前前端非常火热的GraphQL框架也不少，主流的就是下面2个： apollo（https://github.com/apollographql/apollo-client）、relay（https://github.com/facebook/relay）。

　　GraphQL虽好，但是要真正在中大型项目中运用GraphQL，还有有很大的困难的，服务端需要支持到GraphQL的规范格式进行数据输出，我认为需要付出的成本可不小。哪怕的架设一层中间层，也需要解决诸如分发、聚合和性能等问题。

作者：Zachary_Fan
出处：www.cnblogs.com/Zachary-Fan…

如果你想及时得到个人自写文章的消息推送，欢迎扫描下面的二维码~。