C# SFTP全面解析

一、SFTP介紹

SFTP(Secure File Transfer Protocol)是一種在不安全的網路中傳輸文件的加密協議。SFTP是基於SSH(Secure Shell)協議的，所以不僅包含了傳輸文件的功能，也支持加密登錄、遠程執行命令等功能。在C#中，我們可以使用ssh.net庫實現SFTP的各種操作。

二、SFTP連接

在使用ssh.net庫連接SFTP時，我們需要提供SFTP伺服器的地址、用戶名、密碼等信息。對於伺服器中存在的多個用戶，我們可以在SftpClient構造函數中傳入不同的用戶名和密碼來連接。在連接成功後，我們還需要調用SftpClient.Disconnect()方法來關閉連接。

    //引入ssh.net庫
    using Renci.SshNet;
    
    //創建SftpClient對象
    SftpClient sftp = new SftpClient("sftp.example.com", "username", "password");

    //連接SFTP伺服器
    sftp.Connect();

    //下載文件

    //關閉連接
    sftp.Disconnect();

三、SFTP上傳文件

在用ssh.net庫上傳文件到SFTP伺服器時，我們需要指定本地文件路徑和伺服器文件保存路徑。如果需要在上傳前創建目錄，則可以使用SftpClient.CreateDirectory()方法來創建目錄。

    //上傳文件
    using (var fileStream = new FileStream(@"C:\local\path\file.txt", FileMode.Open))
    {
        sftp.UploadFile(fileStream, "/remote/path/file.txt");
    }

四、SFTP下載文件

當需要從SFTP伺服器下載文件到本地時，我們可以使用SftpClient.DownloadFile()方法。該方法可以將遠程文件下載到本地指定的路徑中。如果需要首先創建本地目錄，則可以使用Directory.CreateDirectory()方法來創建目錄。

    //下載文件
    using (var fileStream = new FileStream(@"C:\local\path\file.txt", FileMode.Create))
    {
        sftp.DownloadFile("/remote/path/file.txt", fileStream);
    }

五、SFTP刪除文件

在ssh.net庫中，我們可以使用SftpClient.DeleteFile()方法來刪除SFTP伺服器中的文件。

    //刪除文件
    sftp.DeleteFile("/remote/path/file.txt");

六、SFTP重命名文件

SFTP伺服器中的文件名可以通過ssh.net庫提供的SftpClient.RenameFile()方法來修改。

    //重命名文件
    sftp.RenameFile("/remote/path/file.txt", "/remote/path/newfile.txt");

七、SFTP創建目錄

在ssh.net庫中，我們可以使用SftpClient.CreateDirectory()方法來創建SFTP伺服器中的目錄。

    //創建目錄
    sftp.CreateDirectory("/remote/path/newfolder");

八、SFTP刪除目錄

在ssh.net庫中，我們可以使用SftpClient.DeleteDirectory()方法來刪除SFTP伺服器中的目錄。該方法會刪除目錄及其下的所有文件。

    //刪除目錄
    sftp.DeleteDirectory("/remote/path/folder");

九、SFTP上傳大文件

如果需要上傳大文件，則可以使用SftpClient.BeginUploadFile()和SftpClient.EndUploadFile()方法來實現。BeginUploadFile()方法會返回一個以SftpUploadAsyncResult類型表示的非同步操作對象。該方法需要傳入本地文件路徑和伺服器文件保存路徑。EndUploadFile()方法需要傳入非同步操作對象，當非同步操作已完成時，該方法會將結果返回。

    //上傳大文件
    using (var fileStream = new FileStream(@"C:\local\path\file.txt", FileMode.Open))
    {
        var asyncResult = sftp.BeginUploadFile(fileStream, "/remote/path/file.txt");
        sftp.EndUploadFile(asyncResult);
    }

十、SFTP下載大文件

如果需要下載大文件，則可以使用SftpClient.BeginDownloadFile()和SftpClient.EndDownloadFile()方法來實現。BeginDownloadFile()方法會返回一個以SftpDownloadAsyncResult類型表示的非同步操作對象。該方法需要傳入遠程文件路徑和本地文件保存路徑。EndDownloadFile()方法需要傳入非同步操作對象，當非同步操作已完成時，該方法會將結果返回。

    //下載大文件
    using (var fileStream = new FileStream(@"C:\local\path\file.txt", FileMode.Create))
    {
        var asyncResult = sftp.BeginDownloadFile("/remote/path/file.txt", fileStream);
        sftp.EndDownloadFile(asyncResult);
    }

十一、SFTP異常處理

在使用ssh.net庫連接SFTP時，可能會出現各種異常。例如SftpPathNotFoundException、SshAuthenticationException、SftpPermissionDeniedException、SshException等。對於這些異常，我們可以使用try-catch語句來捕獲並處理。

    //異常處理
    try
    {
        //執行SFTP操作
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex.Message);
    }

十二、總結

通過以上的介紹，我們可以了解到ssh.net庫提供了豐富的API來實現SFTP的各種操作。我們可以通過連接SFTP伺服器、上傳、下載、刪除文件、創建、刪除目錄等操作來實現我們的需求。在實際開發中，我們需要注意進行異常處理，以保證程序的健壯性。