拥抱高效上传：用 Node.js 轻松实现交互式 SFTP 上传

2023-09-06 22:53:00

Node.js 实现交互式的 SFTP 上传

在软件开发过程中，测试环境是一个必不可少的环节。为了保证代码的质量和稳定性，需要对代码进行全面的测试。在测试环境中，往往需要将本地打包的代码上传到对应的测试机目录。传统的方法是通过脚本进行 SFTP 上传，但这种方法缺乏交互性，难以满足复杂的需求。本文将介绍如何使用 Node.js 开发一个交互式的 SFTP 上传工具，帮助您轻松实现代码的上传。

1. Node.js 简介

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，允许开发人员使用 JavaScript 编写服务器端应用程序。Node.js 具有跨平台、高性能、高并发等特点，被广泛用于 Web 开发、网络应用、物联网等领域。

2. SFTP 简介

SFTP（SSH File Transfer Protocol）是一种安全的、加密的文件传输协议，是 SSH 的一个扩展。SFTP 允许用户在远程服务器上以安全的方式传输文件，具有速度快、安全性高等优点。

3. 使用 Node.js 实现交互式的 SFTP 上传

接下来，我们将介绍如何使用 Node.js 开发一个交互式的 SFTP 上传工具。这个工具将允许您指定远程服务器的 IP 地址、端口、用户名和密码，并选择要上传的文件。

首先，我们需要安装必要的 Node.js 模块。可以使用以下命令安装：

npm install ssh2

安装完成后，就可以开始编写代码了。首先，我们需要创建一个新的 Node.js 项目：

mkdir sftp-upload
cd sftp-upload
npm init -y

然后，在项目中创建一个名为 index.js 的文件，并输入以下代码：

const Client = require('ssh2').Client;

const conn = new Client();

conn.on('ready', () => {
  console.log('Connected to the server!');

  conn.sftp((err, sftp) => {
    if (err) {
      console.log(err);
    } else {
      sftp.fastPut(localPath, remotePath, (err) => {
        if (err) {
          console.log(err);
        } else {
          console.log('File transferred successfully!');
        }

        conn.end();
      });
    }
  });
});

conn.connect({
  host: '127.0.0.1',
  port: 22,
  username: 'username',
  password: 'password'
});

这段代码将创建一个新的 SSH 连接，并连接到远程服务器。然后，它将创建一个 SFTP 连接，并使用 fastPut 方法将本地文件上传到远程服务器。

最后，我们需要在命令行中运行以下命令来执行这个脚本：

node index.js

这样，就可以将本地文件上传到远程服务器了。

4. 扩展交互式 SFTP 上传工具

我们可以进一步扩展这个工具，使其具有交互性。例如，我们可以允许用户指定远程服务器的 IP 地址、端口、用户名和密码，并选择要上传的文件。

const inquirer = require('inquirer');

inquirer.prompt([
  {
    type: 'input',
    name: 'host',
    message: 'Enter the IP address of the remote server:',
  },
  {
    type: 'input',
    name: 'port',
    message: 'Enter the port of the remote server:',
  },
  {
    type: 'input',
    name: 'username',
    message: 'Enter the username for the remote server:',
  },
  {
    type: 'password',
    name: 'password',
    message: 'Enter the password for the remote server:',
  },
  {
    type: 'input',
    name: 'localPath',
    message: 'Enter the path to the local file:',
  },
  {
    type: 'input',
    name: 'remotePath',
    message: 'Enter the path to the remote directory:',
  },
]).then((answers) => {
  const { host, port, username, password, localPath, remotePath } = answers;

  const conn = new Client();

  conn.on('ready', () => {
    console.log('Connected to the server!');

    conn.sftp((err, sftp) => {
      if (err) {
        console.log(err);
      } else {
        sftp.fastPut(localPath, remotePath, (err) => {
          if (err) {
            console.log(err);
          } else {
            console.log('File transferred successfully!');
          }

          conn.end();
        });
      }
    });
  });

  conn.connect({
    host,
    port,
    username,
    password
  });
});