java 如何连接 sftp

Java 连接 SFTP 的方法主要有：使用JSch库、Apache Commons VFS库、Spring Integration框架。本文将详细介绍这几种方法，帮助你选择和实现适合的SFTP连接方案。

一、使用 JSch 库连接 SFTP

JSch 是一个纯 Java 实现的 SSH2 客户端库。JSch 允许你连接到一个 SSH 服务器并使用端口转发、X11 转发等功能。下面我们详细介绍如何使用 JSch 连接到 SFTP 服务器。

1.1、添加依赖

首先，你需要在你的项目中添加 JSch 库。你可以通过 Maven 或 Gradle 添加依赖：

Maven:

<dependency>

    <groupId>com.jcraft</groupId>
    <artifactId>jsch</artifactId>
    <version>0.1.55</version>
</dependency>

Gradle:

implementation 'com.jcraft:jsch:0.1.55'

1.2、建立连接

接下来，我们编写 Java 代码来建立与 SFTP 服务器的连接：

import com.jcraft.jsch.ChannelSftp;

import com.jcraft.jsch.JSch;
import com.jcraft.jsch.Session;
import com.jcraft.jsch.Channel;
public class SFTPConnection {
    public static void main(String[] args) {
        String host = "sftp.example.com";
        int port = 22;
        String user = "username";
        String password = "password";
        JSch jsch = new JSch();
        Session session = null;
        Channel channel = null;
        ChannelSftp channelSftp = null;
        try {
            session = jsch.getSession(user, host, port);
            session.setPassword(password);
            // Avoid asking for key confirmation
            java.util.Properties config = new java.util.Properties();
            config.put("StrictHostKeyChecking", "no");
            session.setConfig(config);
            session.connect();
            channel = session.openChannel("sftp");
            channel.connect();
            channelSftp = (ChannelSftp) channel;
            System.out.println("Connected to SFTP server");
            // Perform file operations here
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (channelSftp != null) {
                channelSftp.exit();
            }
            if (channel != null) {
                channel.disconnect();
            }
            if (session != null) {
                session.disconnect();
            }
        }
    }
}

1.3、文件操作

在连接建立后，可以进行文件上传、下载等操作：

上传文件:

String localFile = "path/to/local/file.txt";

String remoteDir = "/path/to/remote/dir/";
channelSftp.put(localFile, remoteDir);
System.out.println("File uploaded successfully");

下载文件:

String remoteFile = "/path/to/remote/file.txt";

String localDir = "path/to/local/dir/";
channelSftp.get(remoteFile, localDir);
System.out.println("File downloaded successfully");

二、使用 Apache Commons VFS 连接 SFTP

Apache Commons VFS 提供了一个文件系统抽象，使得我们可以轻松地与各种文件系统（包括 SFTP）进行交互。

2.1、添加依赖

首先，添加 Apache Commons VFS 依赖：

Maven:

<dependency>

    <groupId>org.apache.commons</groupId>
    <artifactId>commons-vfs2</artifactId>
    <version>2.4.1</version>
</dependency>

Gradle:

implementation 'org.apache.commons:commons-vfs2:2.4.1'

2.2、建立连接

接下来，编写代码使用 Apache Commons VFS 连接到 SFTP 服务器：

import org.apache.commons.vfs2.FileObject;

import org.apache.commons.vfs2.FileSystemManager;
import org.apache.commons.vfs2.VFS;
public class SFTPConnection {
    public static void main(String[] args) {
        String sftpUri = "sftp://username:password@sftp.example.com/path/to/dir";
        try {
            FileSystemManager fsManager = VFS.getManager();
            FileObject remoteFile = fsManager.resolveFile(sftpUri);
            System.out.println("Connected to SFTP server");
            // Perform file operations here
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

2.3、文件操作

在连接建立后，可以进行文件上传、下载等操作：

上传文件:

FileObject localFile = fsManager.resolveFile("path/to/local/file.txt");

remoteFile.copyFrom(localFile, Selectors.SELECT_SELF);
System.out.println("File uploaded successfully");

下载文件:

FileObject localFile = fsManager.resolveFile("path/to/local/dir/file.txt");

localFile.copyFrom(remoteFile, Selectors.SELECT_SELF);
System.out.println("File downloaded successfully");

三、使用 Spring Integration 连接 SFTP

Spring Integration 提供了一个强大的框架，用于与各种外部系统进行集成，包括 SFTP。

3.1、添加依赖

首先，添加 Spring Integration SFTP 依赖：

Maven:

<dependency>

    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-sftp</artifactId>
    <version>5.4.7</version>
</dependency>

Gradle:

implementation 'org.springframework.integration:spring-integration-sftp:5.4.7'

3.2、配置 Spring Integration

接下来，配置 Spring Integration 以连接到 SFTP 服务器：

XML 配置:

<int-sftp:session-factory id="sftpSessionFactory"

                          host="sftp.example.com"
                          port="22"
                          user="username"
                          password="password"/>
<int-sftp:inbound-channel-adapter id="sftpInbound"
                                  session-factory="sftpSessionFactory"
                                  remote-directory="/path/to/remote/dir"
                                  local-directory="file:/path/to/local/dir"
                                  auto-create-local-directory="true"
                                  delete-remote-files="false"
                                  channel="sftpChannel"/>
<int:channel id="sftpChannel"/>

3.3、文件操作

通过 Spring Integration 配置后，可以自动执行文件操作：

上传文件:

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway;
import org.springframework.messaging.Message;
import org.springframework.messaging.support.MessageBuilder;
public class SFTPService {
    @Autowired
    private AbstractRemoteFileOutboundGateway sftpGateway;
    public void uploadFile(String localFilePath, String remoteDir) {
        Message<String> message = MessageBuilder.withPayload(localFilePath)
                                                .setHeader("remoteDirectory", remoteDir)
                                                .build();
        sftpGateway.send(message);
        System.out.println("File uploaded successfully");
    }
}

下载文件:

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway;
import org.springframework.messaging.Message;
import org.springframework.messaging.support.MessageBuilder;
public class SFTPService {
    @Autowired
    private AbstractRemoteFileOutboundGateway sftpGateway;
    public void downloadFile(String remoteFilePath, String localDir) {
        Message<String> message = MessageBuilder.withPayload(remoteFilePath)
                                                .setHeader("localDirectory", localDir)
                                                .build();
        sftpGateway.send(message);
        System.out.println("File downloaded successfully");
    }
}

四、总结

通过本文，我们详细介绍了使用 JSch 库、Apache Commons VFS 库、Spring Integration 框架这几种方式在 Java 中连接 SFTP 服务器的方法。每种方法都有其优缺点，选择适合你项目需求的实现方式至关重要。

JSch 库简单直接，适合小型项目或简单的 SFTP 操作；Apache Commons VFS提供了文件系统抽象，便于处理各种文件系统；Spring Integration功能强大，适合复杂的企业级应用。希望本文能对你有所帮助，祝你在项目中顺利实现 SFTP 连接和操作。

相关问答FAQs：

1. 如何使用Java连接SFTP服务器？
使用Java连接SFTP服务器需要使用到第三方库，比如JSch。以下是连接SFTP服务器的基本步骤：

• 导入JSch库到你的Java项目中。
• 使用JSch创建一个Session对象，设置连接的主机名、用户名和密码。
• 调用Session的connect()方法建立与SFTP服务器的连接。
• 使用Session打开一个ChannelSftp对象。
• 使用ChannelSftp对象可以进行SFTP操作，比如上传文件、下载文件等。
• 完成操作后，记得关闭ChannelSftp和Session。

2. 如何在Java中上传文件到SFTP服务器？
在Java中上传文件到SFTP服务器可以通过以下步骤实现：

• 建立与SFTP服务器的连接，参考上述的连接步骤。
• 使用ChannelSftp对象的put()方法将本地文件上传到SFTP服务器上指定的路径。

3. 如何在Java中下载SFTP服务器上的文件？
在Java中下载SFTP服务器上的文件可以按照以下步骤进行：

• 建立与SFTP服务器的连接，参考上述的连接步骤。
• 使用ChannelSftp对象的get()方法将SFTP服务器上指定路径的文件下载到本地指定的路径。