在前端开发中，有时候会涉及到需要通过ssh协议传输文件，在这种情况下，我们可以使用npm包 ssh2-sftp-client来帮助我们快速实现这个功能。本文将详细介绍ssh2-sftp-client的使用方法，包括安装、初始化、连接以及文件传输等。
安装
使用npm包管理器，输入以下命令进行安装：
npm install ssh2-sftp-client --save
等待安装完成后，我们就可以开始使用ssh2-sftp-client了。
初始化
在使用ssh2-sftp-client之前，我们需要先使用它提供的SftpClient类初始化一个SFTP客户端对象。实例如下：
const Client = require('ssh2-sftp-client'); const sftp = new Client();
在这里，我们使用了require方法引入了ssh2-sftp-client模块，然后实例化了一个SftpClient对象sftp。
连接
SFTP客户端对象初始化完成后，我们需要使用它提供的connect方法连接到SFTP服务器上。代码示例如下：
-- -------------------- ---- ------- ----- ------ - - ----- ----------------- ----- ----- --------- --------------- --------- -------------- -- ---------------------------- -- - ---------------------- -- ---- --------- -------------- -- - ---------------- ------ -- ---------- -- ---- --------- ---展开代码
在connect方法中，我们需要传入一个包含连接信息的配置对象。这个对象包含了服务器的IP地址、端口号、用户名和密码等信息。连接成功后，我们可以在控制台输出一条成功信息，否则我们需要捕获并打印错误信息。
文件传输
连接成功后，我们就可以使用SFTP客户端对象的put、get、delete等方法进行文件传输了。
上传文件
上传文件的方法是put，它的第一个参数是本地文件的路径，第二个参数是服务器上保存的路径。代码示例如下：
const localPath = '/path/to/local/file'; const remotePath = '/path/to/remote/file'; sftp.put(localPath, remotePath).then(() =>{ console.log('Upload file success'); }).catch((err) => { console.log(err, 'Upload file failed'); });
下载文件
下载文件的方法是get，它的第一个参数是服务器上文件的路径，第二个参数是本地保存的路径。代码示例如下：
const remotePath = '/path/to/remote/file'; const localPath = '/path/to/local/file'; sftp.get(remotePath, localPath).then(() => { console.log('Download file success'); }).catch((err) => { console.log(err, 'Download file failed'); });
删除文件
删除文件的方法是delete，它的参数为服务器上文件的路径。代码示例如下：
const remotePath = '/path/to/remote/file'; sftp.delete(remotePath).then(() => { console.log('Delete file success'); }).catch((err) => { console.log(err, 'Delete file failed'); });
示例代码
最后，我们来看一下一个完整的示例代码，它可以上传下载一个文件并在服务器上删除文件。
-- -------------------- ---- ------- ----- ------ - ---------------------------- ----- ---- - --- --------- ----- ------ - - ----- ----------------- ----- ----- --------- --------------- --------- -------------- -- ----- --------- - ---------------------- ----- ---------- - ----------------------- ---------------------------- -- - ---------------------- -- ---- --------- ------ ------------------- ------------ ---------- -- - ------------------- ---- ---------- ------ -------------------- ----------- ---------- -- - --------------------- ---- ---------- ------ ------------------------ ---------- -- - ------------------- ---- ---------- -------------- -- - ---------------- ---------- --------- ------------- -- - ----------- ---展开代码
在这个示例代码中，我们首先实例化了一个SftpClient对象，然后使用它的connect方法连接到SFTP服务器上。连接成功后，我们使用put方法上传了本地文件，然后使用get方法下载了服务器上的文件，并使用delete方法删除了服务器上的文件。最后，我们使用end方法关闭了SFTP客户端对象。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67116
