npm 包 facebook-graph-utils 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

很多前端开发者都需要使用 Facebook 的 Graph API 来获取一些数据，比如用户信息、页面信息等。尽管 Graph API 提供了一些官方的 SDK，但是这些 SDK 要么不支持前端，要么不支持某些接口。同时，如果你想获取一些个性化的数据，那么你也需要对 Graph API 进行一些深度的定制。

而 facebook-graph-utils 就是一个专门为前端开发者打造的 npm 包，它提供了一些常用的 Graph API 接口，同时也提供了一些可配置的参数，方便开发者进行扩展。

在本文中，我们将详细介绍 facebook-graph-utils 的使用方法，并且通过一些示例代码来帮助大家快速上手。

安装

首先，你需要在你的项目中安装 facebook-graph-utils，可以通过 npm 来进行安装：

npm install facebook-graph-utils

基础用法

使用 facebook-graph-utils，你需要先初始化一个 GraphAPI 的实例，并指定你的 access_token：

const GraphAPI = require('facebook-graph-utils').GraphAPI;

const graphApi = new GraphAPI('你的 access_token');

在上面的代码中，access_token 是你的 Facebook 应用程序的 access_token。

接下来，你可以使用 GraphAPI 的方法来调用 Graph API 的接口：

graphApi.get('/me', (response) => {
  console.log(response);
});

在上面的代码中，我们调用了 /me 接口来获取当前用户的基本信息，并将返回的结果打印到控制台上。

高级用法

facebook-graph-utils 提供了一些可配置的参数，方便开发者进行深度定制。它们的使用方法如下：

fields

fields 参数指定了返回结果中需要包含的字段，比如 /me 接口返回的数据中包含了很多信息，如果我们只需要获取用户姓名和邮箱，我们可以在调用 get 方法的时候加上 fields 参数：

graphApi.get('/me', { fields: 'name,email' }, (response) => {
  console.log(response);
});

limit 和 offset

limit 参数指定了返回结果中最多包含多少个条目，而 offset 参数指定了结果中从哪个位置开始返回。比如，如果我们要获取当前用户的前十个好友，我们可以这样写：

graphApi.get('/me/friends', { limit: 10 }, (response) => {
  console.log(response);
});

如果我们要获取用户的第十个到第二十个好友，我们可以这样写：

graphApi.get('/me/friends', { limit: 10, offset: 10 }, (response) => {
  console.log(response);
});

edge

edge 参数可以用来访问一个对象的子项，比如 /me/videos 可以获取当前用户上传的所有视频。比如，我们要获取当前用户上传的前十个视频，我们可以这样写：

graphApi.get('/me/videos', { limit: 10 }, (response) => {
  console.log(response);
});

进一步定制

如果上面的一些可配置参数无法满足你的需求，你也可以进一步深入定制 facebook-graph-utils。在 facebook-graph-utils 的底层，其实就是对 request 这个库的封装。

你可以传递一些额外的参数来对 request 进行进一步的配置。比如，如果你要在请求时添加一些 header，你可以传递 headers 参数：

graphApi.get('/me', { headers: { 'X-My-Header': '123' } }, (response) => {
  console.log(response);
});

当然，除了 headers 以外，request 还提供了很多其他的配置，你可以在官方文档中查看更多信息。

示例代码

最后，我们给大家提供了一些示例代码，以便帮助大家更好地理解 facebook-graph-utils 的使用：

获取用户基本信息

const GraphAPI = require('facebook-graph-utils').GraphAPI;

const graphApi = new GraphAPI('你的 access_token');

graphApi.get('/me', (response) => {
  console.log(response);
});

获取用户好友列表

const GraphAPI = require('facebook-graph-utils').GraphAPI;

const graphApi = new GraphAPI('你的 access_token');

graphApi.get('/me/friends', { limit: 10 }, (response) => {
  console.log(response);
});

获取用户上传的视频

const GraphAPI = require('facebook-graph-utils').GraphAPI;

const graphApi = new GraphAPI('你的 access_token');

graphApi.get('/me/videos', { limit: 10 }, (response) => {
  console.log(response);
});

添加一个新的客户端

const GraphAPI = require('facebook-graph-utils').GraphAPI;

const graphApi = new GraphAPI('你的 access_token');

graphApi.post('/me/customers', { client_id: '123', name: '客户端名称' }, (response) => {
  console.log(response);
});

总结

facebook-graph-utils 是一个非常好用的 npm 包，它可以帮助前端开发者更加方便地调用 Graph API 接口。我们在本文中介绍了 facebook-graph-utils 的基础用法和高级用法，并给大家提供了一些示例代码来帮助大家理解。

如果您在使用过程中遇到了问题，可以参考 facebook-graph-utils 的官方文档或者在社区中寻求帮助。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60056cf181e8991b448e6a22