npm 包 box-node-sdk 使用教程

简介

Box-node-sdk 是 Box 的官方 Node.js SDK，提供了与 Box API 进行交互的方法。使用该 SDK 可以通过 Node.js 应用程序轻松地与 Box 云存储平台进行交互、上传、下载文件、管理文件和文件夹以及其他操作。

安装

在使用 Box-node-sdk 之前，需要确保已经安装 Node.js。安装过程可以在 Node.js 官网找到相应的操作系统版本。同时，我们还需要在项目目录下安装 Box-nodes-sdk npm 包，使用如下命令进行安装：

npm install box-node-sdk --save

鉴权

使用 Box-node-sdk 前，我们需要先进行密码授权，获取到访问 Box API 所需要的 token。

const BoxSDK = require('box-node-sdk');
const sdk = new BoxSDK({
    clientID: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET'
});
const authorizeURL = sdk.getAuthorizeURL({response_type: 'code'});
console.log('Please navigate to this URL in your browser to authorize your application:\n', authorizeURL);

执行上述代码后，会输出授权链接，用户需要在浏览器中打开该链接进行授权操作。授权成功后，会重定向到一个新的链接，重定向链接中包含的 code 参数即为所需的访问 token。

let code = 'YOUR_AUTHORIZATION_CODE';
sdk.getTokensAuthorizationCodeGrant(code, null, function(err, tokenInfo) {
    if (err) {
        console.log(err);
        throw new Error(`Error exchanging authorization code for tokenInfo: ${err}`);
    }
    console.log(tokenInfo);
});

文件上传

使用 Box-node-sdk 上传文件非常简单，只需要调用 client.folders.create 方法即可。该方法接受一个文件夹对象作为参数，文件夹对象中包含了文件名、所在路径、用户等信息。

const sdk = require('box-node-sdk');
const client = sdk.getBasicClient(token);
client.files.uploadFile('PATH_TO_LOCAL_FILE', '0', function(err, uploadedFile) {
    if(err) console.log(err);
    console.log(`File was uploaded with name ${uploadedFile.name} and URL ${uploadedFile.shared_link.url}`);
});

文件下载

Box-node-sdk 也提供了下载文件的方法，将文件下载到本地目录。

-- -------------------- ---- -------
----- --- - ------------------------
----- ------ - --------------------------
----- ------ - ----------
----- ------ - ------------------------------------------
---------------------------------- ----- ------------- ------- -
    ------- -----------------
    --------------------
    --------------------- -------------
---

文件夹

文件夹是 Box 储存文件的方式。Box-node-sdk 支持以下文件夹相关操作：

创建文件夹

const sdk = require('box-node-sdk');
const client = sdk.getBasicClient(token);
client.folders.create('PARENT_FOLDER_ID', 'NEW_FOLDER_NAME', function(err, folder) {
    console.log(`New folder was created with name ${folder.name}`);
});

列出文件夹中的文件

const sdk = require('box-node-sdk');
const client = sdk.getBasicClient(token);
client.folders.getItems('FOLDER_ID', null, function (err, items) {
    console.log('The folder has those files:')
    items.entries.forEach(function(item) {
        console.log(item.name);
    });
});

删除文件夹

const sdk = require('box-node-sdk');
const client = sdk.getBasicClient(token);
client.folders.delete('FOLDER_ID', function(err, data) {
    if(err) console.log(err);
    console.log(`Folder deleted successfully!`);
});

总结

本文介绍了 Box-node-sdk 的基本使用方法，包括鉴权、文件上传、文件下载以及文件夹相关操作。开发者可以按照本文的教程快速上手 Box-node-sdk，实现文件的上传下载和管理。Box-node-sdk 的官方文档，还提供了更多的功能和 API，可以详细了解后使用。

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