前端调用GraphQLAPI的方法-创新互联

这篇文章将为大家详细讲解有关前端调用GraphQL API的方法，文章内容质量较高，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。

GraphQL是一个开源的API数据查询和操作语言及实现为了实现上述操作的相应运行环境。GraphQL相较于REST以及其他web service架构提供了一种高效、强大和灵活的开发web APIs的方式。它通过由客户端根据所需定义数据结构，同时由服务端负责返回相同数据结构的对应数据的方式避免了服务端大量冗余数据的返回，但与此同时也意味着这种方式不能有效利用起查询结果的web缓存。GraphQL这种查询语言所带来的灵活性和丰富性的同时也增加了复杂性，使得这项技术对于简单APIs并不是好的选择。

而 gq-loader 是一个 webpack 插件，你可以认为它一针对前端项目的一种 client 端实现，它的目的是帮助前端开发同学更简便的调用 GraphQL API，它让前端开发人员在使用 GraphQL 时更加方便，像普通 js 模块一样轻松自如，使前端开发人员能在 js 文件中通过 import 或 require 导入 .gql 和 .graphql 文件，然后直接调用。

并且它还支持通过 #import 语法导入其它 .gql 文件，比如 fragments。

#import 还提供了两个别名，分别是 #require 和 #include，这两个别名和 #import 的用法及行为完全一致。

安装

npm install gq-loader --save-dev

或者

yarn add gq-loader

基本使用

如同其它 loader 一样，首先，我们在 webpack.config.js 中添加 gq-loader 的配置

{
  test: /\.(graphql|gql)$/,
  exclude: /node_modules/,
  use: {
    loader: 'gq-loader'
    options: {
      url: 'Graphql Server URL'
    }
  }
}

然后，我们就可以在 js 文件中通过 import 来导入 .gql 文件使用它了，我们来一个简单的示例，假设已经有一个可以工作的 Graphql Server，那么，我们先创建一个可以查询用户的 getUser.gql

#import './fragment.gql' 
query MyQuery($name: String) {
  getUser(name: $name)
    ...userFields
  }
}

可以看到，我们通过 #import 引用了另外一个 .gql 文件 fragment.gql，在这个文件中我们描术了要返回的 user 的字段信息，这样我们就能在不同的地方「重用」它了，我们也创建一下这个文件

fragment userFields on User {
  name
  age
}

好了，我们可以在 js 文件中直接导入 getUser.gql，并且使用它查询用户了，从未如此简便，我们来看看

import getUser from './getUser.gql';
import React from 'react';
import ReactDOM from 'react-dom';
async function query() {
  const user = await getUser({ name: 'bob' });
  console.log('user', user);
}
function App() {
  return click;
}
ReactDOM.render(, document.getElementById('root'));

在调用 getUser 时，我们可以给函数参数向 GraphQL 传递变量，这些变量就是我们的查询参数。

自定义请求

默认 gq-loader 就会帮你完成 graphql 请求，但某些场景下或许你想自已控制所有请求，如果有这样需要，我们还可以通过 request 属性来「自定义」请求，看一下示例，需要先稍微改动一下 loader 配置

{
  test: /\.(graphql|gql)$/,
  exclude: /node_modules/,
  use: {
    loader: 'gq-loader'
    options: {
      url: 'Graphql Server URL',
      //指定自动请求模块路径
      request: require.resolve('your_request_module_path');
    }
  }
}

在 your_request_module_path 填写自定义请求模块路径，gq-loader 将自动加载并使用对应请求模块，模块只需要改出一个「请求函数即可」，看如下自定义示例

onst $ = require('jquery');
//url 是要请求的 GraphQL 服务地址
//data 是待发送的数据
//options 是自定义选项
module.exports = function(url, data, options){
  //如果有需要还可以处理 options
  return $.post(url, data);
};

其中，options 是导入 .gql 文件后「函数的第二个参数」，比如，可以这样传递 options 参数

import getUser from './getUser.gql';
async function query() {
  const options = {...};
  const user = await getUser({ name: 'bob' }, options);
  console.log('user', user);
}

注意，gq-loader 的 extensions 无论配置何值，在 js 中 import 时都不能省略扩展名，此选项仅作用于 .gql 文件 import 其它 .gql 文件

以上就是前端调用GraphQL API的方法，看完之后是否有所收获呢？如果想了解更多相关内容，欢迎关注创新互联网站制作公司行业资讯，感谢各位的阅读。