npm包 koop-salesforce使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发领域，我们常常需要使用第三方库或者工具来完成一些常见任务。npm是一款常用的包管理器，提供了数量众多的npm包，其中koop-salesforce是一个针对Salesforce的Node.js包。本文将向您介绍koop-salesforce的详细使用方法，并提供一些示例代码作为参考。

什么是koop-salesforce？

Koop-Salesforce是一个node.js包，用于连接Salesforce REST和Streaming API。它提供了一个REST API和一个实时数据合集服务（CaTS）来访问和处理Salesforce数据。koop-salesforce还提供了一个CLI工具，用于创建和启动完整的Koop + CaTS实例。

安装 koop-salesforce

使用npm安装koop-salesforce非常简单：

$ npm install koop-salesforce

这将在项目中添加包并更新“package.json”

{
  "dependencies": {
    "koop-salesforce": "^1.0.0"
  }
}

使用 koop-salesforce

我们可以在Node.js中使用koop-salesforce包。在此之前，我们首先需要将Salesforce OAuth信息添加到环境文件中（env文件）。

SF_CLIENT_ID=<client_id>
SF_CLIENT_SECRET=<client_secret>
SF_CALLBACK_URL=<callback_url>

在使用koop-salesforce时，需要通常需要先生成一个KoopSalesforce实例：

const KoopSalesforce = require('koop-salesforce');
const koopSF = new KoopSalesforce({
  clientId: process.env.SF_CLIENT_ID,
  clientSecret: process.env.SF_CLIENT_SECRET,
  callbackUrl: process.env.SF_CALLBACK_URL
});

可以根据需要传递附加参数来定制KoopSalesforce实例。

使用REST API

使用KoopSalesforce的REST API，我们可以访问Salesforce对象：

const sfLayers = koopSF.serverLayers(); //获取所有可用的Salesforce数据表信息
const layerData = koopSF.getData({ url: '/<object>' }); //获取指定的Salesforce数据表信息

getAPI方法返回‘api’对象，其中包含指向所有可用Salesforce对象的URL：

const { api } = koopSF;

使用Stream API

您可以通过创建一个KoopSalesforce事件处理程序及其提供的回调来订阅Stream API数据。

koopSF.streaming({
     topic: '< topic >', // Salesforce topic
     event: '< event_type >', // Salesforce event type
     geojson: true // 为true时，会在geojson中添加属于事件的geometry信息字段
  }, function(err, geojson) {
    if (err) throw err;
    console.log(geojson)
  });

使用CLI工具

Koop-salesforce也提供了一个CLI工具，可以用于创建和启动Koop + CaTS实例。

首先，需要完成koop-salesforce在Koop中的注册。

const koop = require('koop')();
const KoopSalesforce = require('koop-salesforce');

koop.register(new KoopSalesforce());

然后使用CLI创建实例：

$ koop-salesforce app start

这将创建并启动一个基于Koop和Koop-salesforce的Web应用程序。在启动后，应用程序暴露了REST API和Streaming API以访问数据。

扩展koop-salesforce

在Koop-salesforce中开发插件非常简单，只需要按照既定的规则创建插件即可。下面将介绍如何创建一个简易的koop-salesforce插件。

首先，我们仍需要创建一个KoopSalesforce实例：

const KoopSalesforce = require('koop-salesforce');

const koopSF = new KoopSalesforce({
  clientId: process.env.SF_CLIENT_ID,
  clientSecret: process.env.SF_CLIENT_SECRET,
  callbackUrl: process.env.SF_CALLBACK_URL
});

然后，需要在插件中定义一个新的Endpoint。可以使用以下代码，通过继承标准CORS API来定义一个Endpoint。/healthcheck是我们创建的新Endpoint，它允许我们查看数据源的运行状况。例如，无法连接到Salesforce时该Endpoint会返回503错误。

function MyProvider () {}
function MyProvider (koop) {}
MyProvider.prototype.getData = function (req, callback) { ... };
MyProvider.prototype.getCORSHeaders = function (req) { return [{ 'Access-Control-Allow-Origin': '*' }]; };
MyProvider.prototype.healthcheck = function (command) {
    // 检查数据源是否正常工作
   this.service.healthcheck(function (err, resp) { return command.callback(err, resp); });
};

接下来，需要使用register函数将插件注册到文件中。注册功能之间没有任何依赖关系，因此它们可以广泛注册：

koopSF.register(MyProvider);

最后，要启动插件，需要将插件添加到Koop中并运行Koop服务：

koop.register(koopSF);
koop.server.listen(config.server.port, function () {
  console.log(('Koop server listening on port ' +  process.env.PORT || config.server.port || 1337));
});

小结

通过本文，您已经了解了如何使用koop-salesforce包，并且掌握了如何使用其REST API和Stream API。您还学习了如何使用CLI工具，扩展koop-salesforce进行开发。使用本文中提供的示例代码，您可以快速启动Koop-salesforce并开始构建您自己的应用程序。

Koop-salesforce是一个非常强大的包，使得与Salesforce尤其是开发连接和处理数据变得更加简单。再次强调，针对不同场景和需求，您可以根据需要制定不同的参数，来构建一个定制化的Koop-salesforce实例。

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