什么是 ssh2-sftp-client-adi？
ssh2-sftp-client-adi 是一个基于 SSH2 协议的 SFTP 客户端，可以通过 JavaScript 调用在 Node.js 环境下连接到 SFTP 服务器上进行文件操作。
ssh2-sftp-client-adi 的优势
相比起其他 SFTP 客户端，ssh2-sftp-client-adi 具有以下优势：
- 支持断点续传，即在文件传输中断时，可以恢复传输而不需要重新开始
- 支持通过 SSH 代理进行连接，即可以在 SSH 通道拓扑中连接到远程的 SFTP 服务器上
- 支持密码和密钥双重认证方式进行连接，提供更安全的连接方式
如何使用 ssh2-sftp-client-adi？
首先，需要使用 npm 安装 ssh2-sftp-client-adi：
npm install ssh2-sftp-client-adi
接下来，需要在 JavaScript 中引入 ssh2-sftp-client-adi 模块：
const SFTP = require('ssh2-sftp-client-adi');建立一个 SFTP 客户端对象：
const client = new SFTP();
连接到 SFTP 服务器：
-- -------------------- ---- ------- ---------------- ----- ----------------- ----- --- -- ---- ------ -- --------- ---------------- --------- ---------------- ---------- -- - ------------------ ---- ------- -- ---------- ------------ -- - ---------------------- ----- -- ---------- ---
以上代码中，connect() 方法返回一个 Promise 对象，当连接成功时执行 then() 方法，失败时执行 catch() 方法。
列出 SFTP 服务器上的文件列表：
client.list('/')
.then(list => {
console.log(list); // 列出来的文件列表
})
.catch(err => {
console.error(err); // 处理错误
});下载文件：
client.get('/path/to/remote/file', '/path/to/local/file')
.then(() => {
console.log('下载完成'); // 下载完成时的回调函数
})
.catch(err => {
console.error('下载失败', err); // 下载失败时的回调函数
});以上代码中，第一个参数为 SFTP 服务器上的文件路径，第二个参数为下载到本地的文件路径。
上传文件：
client.put('/path/to/local/file', '/path/to/remote/file')
.then(() => {
console.log('上传完成'); // 上传完成时的回调函数
})
.catch(err => {
console.error('上传失败', err); // 上传失败时的回调函数
});以上代码中，第一个参数为本地文件路径，第二个参数为上传到 SFTP 服务器上的文件路径。
如何处理上传和下载的进度条？
ssh2-sftp-client-adi 还提供了一些上传和下载的进度条相关的 API。
在上传和下载时，可以通过 progress 参数来监听进度条的变化。
监听文件上传进度：
client.on('upload', info => {
console.log(`上传了 ${info.source.total} 字节入 ${info.destination}，已完成 ${info.source.transferred} 字节。`);
});监听文件下载进度：
client.on('download', info => {
console.log(`下载了 ${info.destination.total} 字节自 ${info.source}，已完成 ${info.destination.transferred} 字节。`);
});总结
通过上述教程，我们已经了解了如何使用 ssh2-sftp-client-adi 在 Node.js 环境下连接到 SFTP 服务器，并进行文件的上传和下载，同时还可以实现上传和下载进度的监听。
ssh2-sftp-client-adi 提供了一个方便且快捷的方式来处理与 SFTP 服务器之间的文件传输，这对于前端的开发者来说无疑是一个优秀的工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055cb381e8991b448da1c1