nativereactssh_ReactNativeSSHSFTP组件

分享一下最近写的 React Native 的 SSH / SFTP 组件&＃xff0c;iOS 端封装了 NMSSH&＃xff0c;Android 端封装了 JSch。支持 SSH 执行命令、实时 Shell 和基本的 SFTP 操作&＃xff0c;同时支持密码或密钥验证。

安装

npm install react-native-ssh-sftp --save

react-native link react-native-ssh-sftp

iOS (only)

NMSSH 需要用 Pod 安装&＃xff0c;如果已经有 Pod 可以直接 pod &＃39;NMSSH&＃39;。没有的话按以下步骤初始化后安装&＃xff1a;

初始化 Pod 文件:

cd ios

pod init

打开 Podfile 添加:

target &＃39;[your project&＃39;s name]&＃39; do

pod &＃39;NMSSH&＃39;

end

安装:

pod install

手动 Link

react-native link 不好使的情况试一下手动添加&＃xff1a;

iOS

打开 XCode 的 project navigator&＃xff0c;右击 Libraries ➜ Add Files to [项目名称]

找到 node_modules ➜ react-native-ssh-sftp 然后选择 RNSSHClient.xcodeproj

打开 XCode 的 project navigator&＃xff0c;选中你的项目&＃xff0c;添加 libRNSSHClient.a 到项目的 Build Phases ➜ Link Binary With Libraries

Android

打开 android/app/src/main/java/[...]/MainActivity.java

- 添加 import com.reactlibrary.RNSshClientPackage; 到文件开头的 imports 中

- 添加 new RNSshClientPackage() 到 getPackages() 方法的列表中

在 android/settings.gradle 中添加以下内容 :

include &＃39;:react-native-ssh-sftp&＃39;

project(&＃39;:react-native-ssh-sftp&＃39;).projectDir &＃61; new File(rootProject.projectDir, &＃39;../node_modules/react-native-ssh-sftp/android&＃39;)

在 android/app/build.gradle 文件的 dependencies 中添加:

compile project(&＃39;:react-native-ssh-sftp&＃39;)

演示

example

我的 App 树莓派助手 也在使用这个组件

运行演示项目

iOS

cd example

cd ios

pod install

cd ..

npm install

react-native run-ios

Android

cd example

npm install

react-native run-android

使用方法介绍

创建 client 并使用密码验证

import SSHClient from &＃39;react-native-ssh-sftp&＃39;;

let client &＃61; new SSHClient(&＃39;10.0.0.10&＃39;, 22, &＃39;user&＃39;, &＃39;password&＃39;, (error) &＃61;> {

if (error)

console.warn(error);

});

创建 client 并使用密钥验证

import SSHClient from &＃39;react-native-ssh-sftp&＃39;;

let client &＃61; new SSHClient(&＃39;10.0.0.10&＃39;, 22, &＃39;user&＃39;, {privateKey: &＃39;-----BEGIN RSA......&＃39;}, (error) &＃61;> {

if (error)

console.warn(error);

});

密钥验证的其他格式:

{privateKey: &＃39;-----BEGIN RSA......&＃39;}

{privateKey: &＃39;-----BEGIN RSA......&＃39;, publicKey: &＃39;ssh-rsa AAAAB3NzaC1yc2EA......&＃39;}

{privateKey: &＃39;-----BEGIN RSA......&＃39;, publicKey: &＃39;ssh-rsa AAAAB3NzaC1yc2EA......&＃39;, passphrase: &＃39;Password&＃39;}

关闭 client

client.disconnect();

执行 SSH 命令

var command &＃61; &＃39;ls -l&＃39;;

client.execute(command, (error, output) &＃61;> {

if (error)

console.warn(error);

if (output)

console.warn(output);

});

Shell

开启 shell:

ptyType 的可选类型: vanilla, vt100, vt102, vt220, ansi, xterm

var ptyType &＃61; &＃39;vanilla&＃39;;

client.startShell(ptyType, (error) &＃61;> {

if (error)

console.warn(error);

});

从 shell 获取数据:

client.on(&＃39;Shell&＃39;, (event) &＃61;> {

if (event)

console.warn(event);

});

向 shell 写数据:

var str &＃61; &＃39;ls -l\n&＃39;;

client.writeToShell(str, (error) &＃61;> {

if (error)

console.warn(error);

});

关闭 shell:

client.closeShell();

SFTP

连接 SFTP

client.connectSFTP((error) &＃61;> {

if (error)

console.warn(error);

});

获取目录列表:

var path &＃61; &＃39;.&＃39;;

client.sftpLs(path, (error, response) &＃61;> {

if (error)

console.warn(error);

if (response)

console.warn(response);

});

创建目录:

client.sftpMkdir(&＃39;dirName&＃39;, (error) &＃61;> {

if (error)

console.warn(error);

});

重命名文件或目录:

client.sftpRename(&＃39;oldName&＃39;, &＃39;newName&＃39;, (error) &＃61;> {

if (error)

console.warn(error);

});

删除目录:

client.sftpRmdir(&＃39;dirName&＃39;, (error) &＃61;> {

if (error)

console.warn(error);

});

删除文件:

client.sftpRm(&＃39;fileName&＃39;, (error) &＃61;> {

if (error)

console.warn(error);

});

下载文件:

client.sftpDownload(&＃39;[path-to-remote-file]&＃39;, &＃39;[path-to-local-direcotry]&＃39;, (error, downloadedFilePath) &＃61;> {

if (error)

console.warn(error);

if (downloadedFilePath)

console.warn(downloadedFilePath);

});

// 获取下载进度

client.on(&＃39;DownloadProgress&＃39;, (event) &＃61;> {

console.warn(event);

});

// 取消下载

client.sftpCancelDownload();

上传文件:

client.sftpUpload(&＃39;[path-to-local-file]&＃39;, &＃39;[path-to-remote-directory]&＃39;, (error) &＃61;> {

if (error)

console.warn(error);

});

// 获取上传进度

client.on(&＃39;UploadProgress&＃39;, (event) &＃61;> {

console.warn(event);

});

// 取消上传

client.sftpCancelUpload();

断开 SFTP:

client.disconnectSFTP();