sftpjava – Java 中的 SFTP 庫

一、概述

sftpjava 是一款免費的 Java SFTP 庫，允許開發人員使用 SFTP 協議在遠程服務器上上傳、下載和管理文件。該庫包含了許多功能豐富的 API，可以輕鬆地實現上傳、下載、刪除和重命名文件等操作。

二、使用 sftpjava 進行 SFTP 操作

使用 sftpjava 進行 SFTP 操作非常簡單。下面是一個使用 sftpjava 實現從遠程服務器下載文件的示例代碼：

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Properties;
import com.sftp.SFTPClient;
import com.sftp.SFTPException;

public class SftpDownloadExample {
    public static void main(String[] args) {
        String host = "host";
        String username = "username";
        String password = "password";
        String remoteFile = "/path/to/remote/file";
        String localFile = "C:\\path\\to\\local\\file";
        
        Properties config = new Properties();
        config.put("StrictHostKeyChecking", "no");
        
        try {
            SFTPClient sftp = new SFTPClient(host, username, password, config);
            OutputStream os = new FileOutputStream(new File(localFile));
            sftp.get(remoteFile, os);
            sftp.disconnect();
        } catch (SFTPException | IOException e) {
            e.printStackTrace();
        }
    }
}

在這個例子中，我們創建了一個 SFTPClient 對象並指定了目標主機、用戶名和密碼。我們還傳遞了一些配置信息，如不檢查主機密鑰等。接下來，我們使用 SFTPClient 對象的 get() 方法從遠程服務器下載文件到本地文件系統。

三、操作 SFTP 文件

sftpjava 提供了多種方法來操作 SFTP 文件。例如，你可以使用 put() 方法將本地文件上傳到遠程服務器，使用 delete() 方法刪除遠程文件，使用 rename() 方法重命名遠程文件等。

下面是一個將本地文件上傳到遠程服務器並將其重命名的示例：

import java.io.File;
import java.io.IOException;
import java.util.Properties;
import com.sftp.SFTPClient;
import com.sftp.SFTPException;

public class SftpUploadExample {
    public static void main(String[] args) {
        String host = "host";
        String username = "username";
        String password = "password";
        String localFile = "C:\\path\\to\\local\\file";
        String remoteFile = "/path/to/remote/file-renamed";
        
        Properties config = new Properties();
        config.put("StrictHostKeyChecking", "no");
        
        try {
            SFTPClient sftp = new SFTPClient(host, username, password, config);
            sftp.put(localFile, remoteFile);
            sftp.rename(remoteFile, "/path/to/remote/file");
            sftp.disconnect();
        } catch (SFTPException | IOException e) {
            e.printStackTrace();
        }
    }
}

在本例中，我們首先創建了一個 SFTPClient 對象並指定了目標主機、用戶名和密碼。我們上傳了本地文件並將其重命名為 “file-renamed”。接下來，我們使用 rename() 方法將遠程文件重命名為 “/path/to/remote/file”。

四、處理 SFTP 異常

在使用 sftpjava 時，可能會遇到一些 SFTP 相關的異常。下面是一個示例代碼，演示了如何處理其中一種異常 – SFTPException：

import java.util.Properties;
import com.sftp.SFTPClient;
import com.sftp.SFTPException;

public class SftpExceptionHandlingExample {
    public static void main(String[] args) {
        String host = "host";
        String username = "username";
        String password = "password";
        String remoteFile = "/path/to/remote/file";
        
        Properties config = new Properties();
        config.put("StrictHostKeyChecking", "no");
        
        try {
            SFTPClient sftp = new SFTPClient(host, username, password, config);
            sftp.get(remoteFile, System.out);
            sftp.disconnect();
        } catch (SFTPException e) {
            switch (e.getCode()) {
                case SFTPException.ERR_NO_SUCH_FILE:
                    System.out.println("遠程文件不存在");
                    break;
                case SFTPException.ERR_AUTH_FAILURE:
                    System.out.println("認證失敗");
                    break;
                case SFTPException.ERR_UNKNOWN:
                default:
                    System.out.println("未知錯誤");
                    break;
            }
        }
    }
}

在這個例子中，我們首先創建了一個 SFTPClient 對象並指定了目標主機、用戶名和密碼。我們嘗試使用 get() 方法從遠程服務器下載文件。如果下載時出現 SFTPException 異常，則我們根據異常代碼打印不同的錯誤消息。

五、總結

本文介紹了 sftpjava 庫，一款免費的 Java SFTP 庫。通過本文，你可以了解到如何使用 sftpjava 進行 SFTP 操作、如何操作 SFTP 文件以及如何處理 SFTP 異常。希望這篇文章能對你有所幫助！