快捷導(dǎo)航

Java實(shí)現(xiàn)SFTP文件上傳的詳細(xì)教程與代碼解析

更新時(shí)間：2025年05月21日 09:40:49 作者：遙不可及~~斌

在現(xiàn)代軟件開發(fā)中,文件傳輸是一個(gè)常見的需求,尤其是在需要將文件上傳到遠(yuǎn)程服務(wù)器時(shí),本文將詳細(xì)介紹如何使用Java實(shí)現(xiàn)SFTP文件上傳,需要的可以參考一下

在現(xiàn)代軟件開發(fā)中，文件傳輸是一個(gè)常見的需求，尤其是在需要將文件上傳到遠(yuǎn)程服務(wù)器時(shí)。SFTP（SSH文件傳輸協(xié)議）是一種安全的文件傳輸協(xié)議，廣泛用于在客戶端和服務(wù)器之間傳輸文件。本文將詳細(xì)介紹如何使用Java實(shí)現(xiàn)SFTP文件上傳，并提供完整的代碼示例。

1. 什么是SFTP

SFTP（SSH File Transfer Protocol）是一種基于SSH協(xié)議的文件傳輸協(xié)議。與FTP不同，SFTP通過加密的SSH連接傳輸文件，確保了數(shù)據(jù)傳輸?shù)陌踩?。SFTP通常用于需要安全傳輸文件的場景，如上傳日志文件、備份數(shù)據(jù)等。

2. 使用JSch庫實(shí)現(xiàn)SFTP

在Java中，我們可以使用JSch庫來實(shí)現(xiàn)SFTP文件上傳。JSch是一個(gè)純Java實(shí)現(xiàn)的SSH2庫，支持SFTP、SCP、端口轉(zhuǎn)發(fā)等功能。本文將使用JSch來實(shí)現(xiàn)SFTP文件上傳。

3. 實(shí)現(xiàn)步驟

3.1 添加依賴

首先，我們需要在項(xiàng)目中添加JSch庫的依賴。如果你使用的是Maven項(xiàng)目，可以在pom.xml中添加以下依賴：

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

3.2 創(chuàng)建SFTP工具類

接下來，我們創(chuàng)建一個(gè)SftpUploadUtil工具類，用于封裝SFTP連接、文件上傳、下載和刪除等操作。以下是完整的代碼實(shí)現(xiàn)：

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服務(wù)器
     * @param host SFTP服務(wù)器主機(jī)名
     * @param port SFTP服務(wù)器端口
     * @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服務(wù)器
     * @param localFilePath 本地文件路徑
     * @param remoteFilePath 遠(yuǎn)程文件路徑
     * @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服務(wù)器下載文件
     * @param remoteFilePath 遠(yuǎn)程文件路徑
     * @param localFilePath 本地文件路徑
     * @throws Exception 如果下載失敗
     */
    public void downloadFile(String remoteFilePath, String localFilePath) throws Exception {
        channel.get(remoteFilePath, localFilePath);
    }

    /**
     * 刪除SFTP服務(wù)器上的文件
     * @param remoteFilePath 遠(yuǎn)程文件路徑
     * @throws SftpException 如果刪除失敗
     */
    public void deleteFile(String remoteFilePath) throws SftpException {
        channel.rm(remoteFilePath);
    }

    /**
     * 在SFTP服務(wù)器上創(chuàng)建遠(yuǎn)程目錄
     * @param path 遠(yuǎn)程目錄路徑
     * @throws SftpException 如果創(chuàng)建失敗
     */
    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服務(wù)器的連接
     */
    public void disconnect() {
        if (channel != null) {
            channel.disconnect();
        }
        if (session != null) {
            session.disconnect();
        }
    }
}

3.3 代碼解析

connect方法：用于連接到SFTP服務(wù)器。通過JSch庫創(chuàng)建一個(gè)SSH會(huì)話，并打開一個(gè)SFTP通道。

uploadFile方法：用于將本地文件上傳到SFTP服務(wù)器。如果遠(yuǎn)程目錄不存在，會(huì)自動(dòng)創(chuàng)建目錄。

downloadFile方法：用于從SFTP服務(wù)器下載文件到本地。

deleteFile方法：用于刪除SFTP服務(wù)器上的文件。

createRemoteDirectory方法：用于在SFTP服務(wù)器上創(chuàng)建遠(yuǎn)程目錄。

disconnect方法：用于斷開與SFTP服務(wù)器的連接。

3.4 使用示例

以下是一個(gè)簡單的使用示例，展示如何上傳文件到SFTP服務(wù)器：

public class SftpExample {
    public static void main(String[] args) {
        SftpUploadUtil sftpUtil = new SftpUploadUtil();
        try {
            // 連接到SFTP服務(wù)器
            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();
        }
    }
}