前端自动化部署之ssh2和ssh2-sftp-client

ssh2-sftp-client 本身是一个专门用于处理 SFTP文件操作的库,它不直接提供执行远程命令的功能。但是可以通过它的底层依赖库 ssh2 实现执行命令的功能。

以下是实现方法和示例代码:


方法一:使用 ssh2 执行远程命令

ssh2ssh2-sftp-client 的底层库,它支持执行远程命令。

安装依赖

如果尚未安装 ssh2,可以通过以下命令安装:

bash 复制代码
npm install ssh2
代码示例
javascript 复制代码
const { Client } = require('ssh2');

const serverOptions = {
  host: 'your-server-ip',
  port: 22,
  username: 'your-username',
  password: 'your-password', // 或者使用 privateKey
};

const command = 'ls -l /home/cuijiying/log_tools';

const conn = new Client();

conn.on('ready', () => {
  console.log('SSH 连接成功!');
  conn.exec(command, (err, stream) => {
    if (err) throw err;

    stream
      .on('close', (code, signal) => {
        console.log(`命令执行完成,退出代码:${code}`);
        conn.end();
      })
      .on('data', (data) => {
        console.log('输出:\n' + data.toString());
      })
      .stderr.on('data', (data) => {
        console.error('错误:\n' + data.toString());
      });
  });
}).connect(serverOptions);
输出解释
  • 标准输出通过 stream.on('data') 接收。
  • 错误输出通过 stream.stderr.on('data') 接收。

方法二:结合 ssh2-sftp-clientssh2

如果你同时需要执行命令和进行 SFTP 文件操作,可以同时使用 ssh2ssh2-sftp-client

代码示例
javascript 复制代码
const { Client } = require('ssh2');
const SftpClient = require('ssh2-sftp-client');

const serverOptions = {
  host: 'your-server-ip',
  port: 22,
  username: 'your-username',
  password: 'your-password',
};

const command = 'df -h'; // 示例命令:查看磁盘使用情况
const sftp = new SftpClient();
const conn = new Client();

async function executeCommand() {
  return new Promise((resolve, reject) => {
    conn.on('ready', () => {
      console.log('SSH 连接成功!');
      conn.exec(command, (err, stream) => {
        if (err) return reject(err);

        let output = '';
        stream
          .on('close', (code, signal) => {
            console.log(`命令执行完成,退出代码:${code}`);
            conn.end();
            resolve(output);
          })
          .on('data', (data) => {
            output += data.toString();
          })
          .stderr.on('data', (data) => {
            console.error('错误:\n' + data.toString());
          });
      });
    }).connect(serverOptions);
  });
}

async function main() {
  try {
    // 执行远程命令
    const commandOutput = await executeCommand();
    console.log('命令输出:\n', commandOutput);

    // 使用 SFTP 上传文件
    await sftp.connect(serverOptions);
    await sftp.put('./example.zip', '/home/cuijiying/example.zip');
    console.log('文件上传成功!');
  } catch (err) {
    console.error('操作失败:', err);
  } finally {
    sftp.end();
  }
}

main();

方法三:使用 ssh2 的高级特性(Shell 模式)

如果需要执行多个命令,可以使用 Shell 模式。

代码示例
javascript 复制代码
const { Client } = require('ssh2');

const serverOptions = {
  host: 'your-server-ip',
  port: 22,
  username: 'your-username',
  password: 'your-password',
};

const conn = new Client();

conn.on('ready', () => {
  console.log('SSH 连接成功!');
  conn.shell((err, stream) => {
    if (err) throw err;

    stream
      .on('close', () => {
        console.log('Shell 会话结束');
        conn.end();
      })
      .on('data', (data) => {
        console.log('输出:\n' + data.toString());
      });

    // 执行多个命令
    stream.write('pwd\n');
    stream.write('ls -l\n');
    stream.write('exit\n');
  });
}).connect(serverOptions);

注意事项

  1. 权限问题

    • 确保 SSH 用户具有执行命令的权限。如果是限制用户(如 chroot 环境),可能无法正常执行某些命令。
  2. 命令路径

    • 某些命令可能需要完整路径,例如 /usr/bin/ls 而非 ls
  3. 错误处理

    • 捕获所有异常,并合理处理连接超时或命令失败等问题。
  4. 谨慎使用rm 相关命令

    • 哈哈,这是一个极其危险的命令,不懂得可以自行搜索。

通过以上方法,你可以在 Node.js 环境中使用 ssh2 执行远程命令,同时结合 ssh2-sftp-client 进行文件传输,满足大多数 SSH 操作需求。

相关推荐
Tiandaren18 分钟前
Selenium 4 教程:自动化 WebDriver 管理与 Cookie 提取 || 用于解决chromedriver版本不匹配问题
selenium·测试工具·算法·自动化
一斤代码2 小时前
vue3 下载图片(标签内容可转图)
前端·javascript·vue
中微子2 小时前
React Router 源码深度剖析解决面试中的深层次问题
前端·react.js
光影少年2 小时前
从前端转go开发的学习路线
前端·学习·golang
中微子2 小时前
React Router 面试指南:从基础到实战
前端·react.js·前端框架
3Katrina2 小时前
深入理解 useLayoutEffect:解决 UI "闪烁"问题的利器
前端·javascript·面试
前端_学习之路3 小时前
React--Fiber 架构
前端·react.js·架构
coderlin_3 小时前
BI布局拖拽 (1) 深入react-gird-layout源码
android·javascript·react.js
伍哥的传说4 小时前
React 实现五子棋人机对战小游戏
前端·javascript·react.js·前端框架·node.js·ecmascript·js
qq_424409194 小时前
uniapp的app项目,某个页面长时间无操作,返回首页
前端·vue.js·uni-app