在Java中使用SFTP传输文件

1. 概述

在本教程中，我们将讨论如何在Java中使用SFTP从远程服务器上传和下载文件。

我们将使用三个不同的库:JSch、SSHJ 和 Apache Commons VFS来实现。

2. 使用 JSch

首先，让我们看看如何使用JSch库从远程服务器上传和下载文件。

2.1. Maven 配置

我们需要将 jsch 依赖添加到我们的 pom.xml 中:

<dependency>
    <groupId>com.jcraftgroupId>
    <artifactId>jschartifactId>
    <version>0.1.55version>
dependency>
1
2
3
4
5

jsch 的最新版本可以在 [Maven Central](https://search.maven.org/search?q=g:com.jcraft AND a:jsch) 上找到。

2.2. 设置 JSch

现在我们将设置 JSch。

JSch 使我们能够使用密码验证或公钥验证来访问远程服务器。 在此示例中，我们将使用密码验证：

private ChannelSftp setupJsch() throws JSchException {
    JSch jsch = new JSch();
    jsch.setKnownHosts("/Users/john/.ssh/known_hosts");
    Session jschSession = jsch.getSession(user_name, remote_Host);
    jschSession.setPassword(pass_word);
    jschSession.connect();
    return (ChannelSftp) jschSession.openChannel("sftp");
}
1
2
3
4
5
6
7
8

在上面的示例中，remoteHost 代表远程服务器的名称或 IP 地址（即 example.com）。 我们可以将测试中使用的变量定义为：

private String remote_Host = "HOST_NAME_HERE";
private String user_name = "USERNAME_HERE";
private String pass_word = "PASSWORD_HERE";
1
2
3

我们还可以使用以下命令生成 known_hosts 文件：

ssh-keyscan -H -t rsa REMOTE_HOSTNAME >> known_hosts
1

2.3. 使用 JSch 上传文件

要将文件上传到远程服务器，我们将使用方法 ChannelSftp.put():

@Test
public void whenUploadFileUsingJsch_thenSuccess() throws JSchException, SftpException {
    ChannelSftp channelSftp = setupJsch();
    channelSftp.connect();
 
    String localFile = "src/main/resources/sample.txt";
    String remoteDir = "remote_sftp_test/";
 
    channelSftp.put(localFile, remoteDir + "jschFile.txt");
 
    channelSftp.exit();
}
1
2
3
4
5
6
7
8
9
10
11
12

在这个例子中，方法的第一个参数代表要传输的本地文件，src/main/resources/sample.txt，而*remoteDir*是远程服务器上目标目录的路径。

2.4. 使用 JSch 下载文件

我们还可以使用 ChannelSftp.get() 从远程服务器下载文件：

@Test
public void whenDownloadFileUsingJsch_thenSuccess() throws JSchException, SftpException {
    ChannelSftp channelSftp = setupJsch();
    channelSftp.connect();
 
    String remoteFile = "welcome.txt";
    String localDir = "src/main/resources/";
 
    channelSftp.get(remoteFile, localDir + "jschFile.txt");
 
    channelSftp.exit();
}
1
2
3
4
5
6
7
8
9
10
11
12

其中remoteFile是要下载的文件的路径，localDir代表目标本地目录的路径。

3. 使用 SSHJ

接下来，我们将使用 SSHJ 库从远程服务器上传和下载文件。

3.1. Maven 配置

首先，我们将依赖添加到我们的 pom.xml 中：

<dependency>
    <groupId>com.hierynomusgroupId>
    <artifactId>sshjartifactId>
    <version>0.27.0version>
dependency>
1
2
3
4
5

最新的sshj版本可以在 [Maven Central](https://search.maven.org/search?q=g:com.hierynomus AND a:sshj) 上找到。

3.2. 设置 SSHJ

然后我们设置 SSHClient.

SSHJ 还允许我们使用密码或公钥认证来访问远程服务器。

我们将在示例中使用密码验证：

private SSHClient setupSshj() throws IOException {
    SSHClient client = new SSHClient();
    client.addHostKeyVerifier(new PromiscuousVerifier());
    client.connect(remoteHost);
    client.authPassword(username, password);
    return client;
}
1
2
3
4
5
6
7

3.3. 使用 SSHJ 上传文件

与 JSch 类似，我们将使用 SFTPClient.put() 方法将文件上传到远程服务器：

@Test
public void whenUploadFileUsingSshj_thenSuccess() throws IOException {
    SSHClient sshClient = setupSshj();
    SFTPClient sftpClient = sshClient.newSFTPClient();
 
    sftpClient.put(localFile, remoteDir + "sshjFile.txt");
 
    sftpClient.close();
    sshClient.disconnect();
}
1
2
3
4
5
6
7
8
9
10

我们在这里定义了两个新变量：

private String localFile = "src/main/resources/input.txt";
private String remoteDir = "remote_sftp_test/";
1
2

3.4. 使用 SSHJ 下载文件

从远程服务器下载文件也是如此； 我们将使用 SFTPClient.get()：

@Test
public void whenDownloadFileUsingSshj_thenSuccess() throws IOException {
    SSHClient sshClient = setupSshj();
    SFTPClient sftpClient = sshClient.newSFTPClient();
 
    sftpClient.get(remoteFile, localDir + "sshjFile.txt");
 
    sftpClient.close();
    sshClient.disconnect();
}
1
2
3
4
5
6
7
8
9
10

我们将添加上面使用的两个变量：

private String remoteFile = "welcome.txt";
private String localDir = "src/main/resources/";
1
2

4. 使用 Apache Commons VFS

最后，我们将使用 Apache Commons VFS 将文件传输到远程服务器。

实际上，Apache Commons VFS 内部使用 JSch 库。

4.1. Maven 配置

我们需要将 commons-vfs2 依赖项添加到 pom.xml 中：

<dependency>
    <groupId>org.apache.commonsgroupId>
    <artifactId>commons-vfs2artifactId>
    <version>2.4version>
dependency>
1
2
3
4
5

最新版本的 commons-vfs2 可以在 [Maven Central](https://search.maven.org/search?q=g:org.apache.commons AND a:commons-vfs2) 上找到。

4.2. 使用 Apache Commons VFS 上传文件

Apache Commons VFS 有点不同。

我们将使用 FileSystemManager 从我们的目标文件创建 FileObjects，然后使用 FileObjects 传输我们的文件。

在本例中，我们将使用 FileObject.copyFrom() 方法上传文件：

@Test
public void whenUploadFileUsingVfs_thenSuccess() throws IOException {
    FileSystemManager manager = VFS.getManager();
 
    FileObject local = manager.resolveFile(
      System.getProperty("user.dir") + "/" + localFile);
    FileObject remote = manager.resolveFile(
      "sftp://" + username + ":" + password + "@" + remoteHost + "/" + remoteDir + "vfsFile.txt");
 
    remote.copyFrom(local, Selectors.SELECT_SELF);
 
    local.close();
    remote.close();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

注意本地文件路径应该是绝对路径，远程文件路径应该以*sftp://username:password@remoteHost/*开头

4.3. 使用 Apache Commons VFS 下载文件

从远程服务器下载文件非常相似； 我们将使用 FileObject.copyFrom() 从 remoteFile 复制 localFile：

@Test
public void whenDownloadFileUsingVfs_thenSuccess() throws IOException {
    FileSystemManager manager = VFS.getManager();
 
    FileObject local = manager.resolveFile(
      System.getProperty("user.dir") + "/" + localDir + "vfsFile.txt");
    FileObject remote = manager.resolveFile(
      "sftp://" + username + ":" + password + "@" + remoteHost + "/" + remoteFile);
 
    local.copyFrom(remote, Selectors.SELECT_SELF);
 
    local.close();
    remote.close();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

5. 结束

在本文中，我们学习了如何使用 Java 从远程 SFTP 服务器上传和下载文件。 为此，我们使用了多个库：JSch、SSHJ 和 Apache Commons VFS。

完整的源代码可以在 over on GitHub 中找到。