使用Java实现SFTP文件上传：详细教程与代码解析

遥不可及~~斌

已于 2025-03-17 00:26:08 修改

阅读量709

点赞数 3

文章标签： java

于 2025-03-17 00:17:59 首次发布

本文链接：https://blog.csdn.net/qq_42763903/article/details/146304453

版权

使用Java实现SFTP文件上传：详细教程与代码解析

在现代软件开发中，文件传输是一个常见的需求，尤其是在需要将文件上传到远程服务器时。SFTP（SSH文件传输协议）是一种安全的文件传输协议，广泛用于在客户端和服务器之间传输文件。本文将详细介绍如何使用Java实现SFTP文件上传，并提供完整的代码示例。

1. 什么是SFTP？

SFTP（SSH File Transfer Protocol）是一种基于SSH协议的文件传输协议。与FTP不同，SFTP通过加密的SSH连接传输文件，确保了数据传输的安全性。SFTP通常用于需要安全传输文件的场景，如上传日志文件、备份数据等。

2. 使用JSch库实现SFTP

在Java中，我们可以使用JSch库来实现SFTP文件上传。JSch是一个纯Java实现的SSH2库，支持SFTP、SCP、端口转发等功能。本文将使用JSch来实现SFTP文件上传。

3. 实现步骤

3.1 添加依赖

首先，我们需要在项目中添加JSch库的依赖。如果你使用的是Maven项目，可以在pom.xml中添加以下依赖：

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

3.2 创建SFTP工具类

接下来，我们创建一个SftpUploadUtil工具类，用于封装SFTP连接、文件上传、下载和删除等操作。以下是完整的代码实现：

package com.example.demo.util;

import com.jcraft.jsch.*;
import java.io.File;
import java.io.FileInputStream;
import java.util.Properties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SftpUploadUtil {
    private static final Logger logger = LoggerFactory.getLogger(SftpUploadUtil.class);

    private Session session;
    private ChannelSftp channel;

    /**
     * 连接到SFTP服务器
     * @param host SFTP服务器主机名
     * @param port SFTP服务器端口
     * @param username 用户名
     * @param password 密码
     * @throws JSchException 如果连接失败
     */
    public void connect(String host, int port, String username, String password) throws JSchException {
        JSch jsch = new JSch();
        session = jsch.getSession(username, host, port);
        session.setPassword(password);

        Properties config = new Properties();
        config.put("StrictHostKeyChecking", "no");
        session.setConfig(config);

        session.connect();
        channel = (ChannelSftp) session.openChannel("sftp");
        channel.connect();
    }

    /**
     * 上传文件到SFTP服务器
     * @param localFilePath 本地文件路径
     * @param remoteFilePath 远程文件路径
     * @throws Exception 如果上传失败
     */
    public void uploadFile(String localFilePath, String remoteFilePath) throws Exception {
        File localFile = new File(localFilePath);
        String remoteDir = remoteFilePath.substring(0, remoteFilePath.lastIndexOf('/'));
        try {
            channel.cd(remoteDir);
        } catch (SftpException e) {
            logger.info("Creating remote directory: {}", remoteDir);
            createRemoteDirectory(remoteDir);
        }
        try (FileInputStream fis = new FileInputStream(localFile)) {
            channel.put(fis, remoteFilePath);
        }
    }

    /**
     * 从SFTP服务器下载文件
     * @param remoteFilePath 远程文件路径
     * @param localFilePath 本地文件路径
     * @throws Exception 如果下载失败
     */
    public void downloadFile(String remoteFilePath, String localFilePath) throws Exception {
        channel.get(remoteFilePath, localFilePath);
    }

    /**
     * 删除SFTP服务器上的文件
     * @param remoteFilePath 远程文件路径
     * @throws SftpException 如果删除失败
     */
    public void deleteFile(String remoteFilePath) throws SftpException {
        channel.rm(remoteFilePath);
    }

    /**
     * 在SFTP服务器上创建远程目录
     * @param path 远程目录路径
     * @throws SftpException 如果创建失败
     */
    private void createRemoteDirectory(String path) throws SftpException {
        String[] folders = path.split("/");
        StringBuilder currentPath = new StringBuilder();
        for (String folder : folders) {
            if (!folder.isEmpty()) {
                currentPath.append("/").append(folder);
                try {
                    channel.cd(currentPath.toString());
                } catch (SftpException e) {
                    channel.mkdir(currentPath.toString());
                    logger.info("Created directory: {}", currentPath.toString());
                }
            }
        }
    }

    /**
     * 断开与SFTP服务器的连接
     */
    public void disconnect() {
        if (channel != null) {
            channel.disconnect();
        }
        if (session != null) {
            session.disconnect();
        }
    }
}

3.3 代码解析

connect方法：用于连接到SFTP服务器。通过JSch库创建一个SSH会话，并打开一个SFTP通道。
uploadFile方法：用于将本地文件上传到SFTP服务器。如果远程目录不存在，会自动创建目录。
downloadFile方法：用于从SFTP服务器下载文件到本地。
deleteFile方法：用于删除SFTP服务器上的文件。
createRemoteDirectory方法：用于在SFTP服务器上创建远程目录。
disconnect方法：用于断开与SFTP服务器的连接。

3.4 使用示例

以下是一个简单的使用示例，展示如何上传文件到SFTP服务器：

public class SftpExample {
    public static void main(String[] args) {
        SftpUploadUtil sftpUtil = new SftpUploadUtil();
        try {
            // 连接到SFTP服务器
            sftpUtil.connect("sftp.example.com", 22, "username", "password");

            // 上传文件
            sftpUtil.uploadFile("/path/to/local/file.txt", "/path/to/remote/file.txt");

            // 下载文件
            sftpUtil.downloadFile("/path/to/remote/file.txt", "/path/to/local/downloaded_file.txt");

            // 删除文件
            sftpUtil.deleteFile("/path/to/remote/file.txt");

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 断开连接
            sftpUtil.disconnect();
        }
    }
}