在前端开发中，我们可能会使用一些后端框架提供的 RESTful API 接口来实现前端功能，例如使用 LoopBack 可以快速搭建 REST API 服务。但是在使用 LoopBack 提供的接口时，我们可能需要频繁地手动发送 Ajax 请求，并进行数据处理。
为了解决这个问题，LoopBack 提供了一个 npm 包：loopback-sdk-builder-ny。它可以根据服务端的 Model 信息，自动生成对应的客户端 SDK 文件，方便我们直接在前端中调用后端提供的接口。
本文将详细介绍 loopback-sdk-builder-ny 的使用方法，包括安装、使用、配置等等，希望对大家在前后端协同开发中提供一定的指导意义。
安装 loopback-sdk-builder-ny
在使用 loopback-sdk-builder-ny 之前，我们需要先安装它。可以通过 npm 管理器来进行安装，打开终端输入如下命令：
npm install loopback-sdk-builder-ny --save
安装命令需要加上 --save 参数，是因为我们通常都会将 loopback-sdk-builder-ny 作为项目依赖项来管理，加上 --save 参数可以将依赖项保存至 package.json 文件中，方便后续项目迁移管理。
使用 loopback-sdk-builder-ny
接下来我们需要了解如何使用 loopback-sdk-builder-ny。其实只需要执行一个命令：lb-sdk。在项目的根目录下打开终端，输入如下命令：
lb-sdk server/server.js ../client/js/lb-services.js
其中，server/server.js 表示 LoopBack 后端服务的启动脚本位置，../client/js/lb-services.js 则表示生成的客户端 SDK 文件的保存位置。在自己的项目中需要根据实际情况进行修改。
执行完上述命令后，系统会自动根据 server.js 中定义的 Model 信息，生成对应的 SDK 文件。随后我们在客户端的页面中就可以引入 SDK 文件，并直接使用其中的方法调用后端的 REST API 接口。
配置 loopback-sdk-builder-ny
在使用 loopback-sdk-builder-ny 时，我们需要对其进行一些配置才能满足实际需求。以下是常用的几种配置方式。
- 指定 Model 名称
如果我们只需要针对某个 Model 生成 SDK 文件，可以在 lb-sdk 命令中加上 --models 参数，指定需要生成的 Model 名称。例如：
lb-sdk --models=Product,Order server/server.js ../client/js/lb-services.js
上述命令将只生成 Product 和 Order 两个 Model 对应的 SDK 文件。
- 自定义 SDK 文件名称
默认情况下，生成的 SDK 文件名为 lb-services.js。如果需要自定义 SDK 文件名，可以在 lb-sdk 命令中加上 --output 参数。例如：
lb-sdk --output=backend_sdk.js server/server.js ../client/js/lb-services.js
上述命令将生成一个名为 backend_sdk.js 的 SDK 文件。
- 配置 SDK 的 BaseModel
SDK 文件使用了一个名为 BaseModel 的公共类，它包含了所有 Model 的基本操作，如查询、新增、更新、删除等。如果我们需要改变 SDK 的 BaseModel，默认情况下可以在 server.js 文件中添加如下代码：
-- -------------------- ---- ------- ---------------------------- ----------- ------------------ ----------------- ---------------------------------------------- ----------------- ------------------------- ------- -- ---- -- -------------------- ---- ----- -------- - ----------------------------------- ------------- - ------------- ------------- -------- ---------- ----------- ------------------------------ --------------- ----------------------- ----------------------------- -------------------- ----- -------------------- ------ -- --- --------- -------------- -------------- -------------- ----------------------- ---------------------------------- --- -- ------------------------------
上述代码中，通过 buildSdk(app, options) 的方式对 SDK 进行了详细配置，其中 baseModelName 和 baseModelPath 分别用于指定 BaseModel 的名称和位置。
示例代码
最后，我们来看一个使用 loopback-sdk-builder-ny 的示例代码，具体步骤如下：
- 安装 loopback-sdk-builder-ny
npm install loopback-sdk-builder-ny --save
- 配置 SDK
在 server.js 中添加如上的 loopback-sdk-builder 配置代码。
- 生成 SDK 文件
在项目根目录下执行如下命令：
lb-sdk server/server.js ../client/js/lb-services.js
- 在页面中引入 SDK 文件
在 HTML 页面中引入 SDK 文件：
<script src="js/lb-services.js"></script>
- 调用后端接口
在 JavaScript 文件中调用后端的接口：
angular.module('myApp.controllers', ['lbServices'])
.controller('MyCtrl', function($scope, Product) {
Product.find(function(products) {
$scope.products = products;
});
});到此为止，我们已经成功使用 loopback-sdk-builder-ny 自动生成了客户端 SDK 文件，方便前端调用后端接口，提高开发效率。
总结
本文详细介绍了 loopback-sdk-builder-ny 的使用方法和配置方式，并给出了示例代码。使用 loopback-sdk-builder-ny 可以让前端开发人员更加方便地调用后端接口，提高协同开发效率。如果您正在使用 LoopBack 框架开发后端服务，不妨试试使用 loopback-sdk-builder-ny，相信会带给您更好的开发体验。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f93238a385564ab7038