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服务器、上传、下载、删除文件、创建、删除目录等操作来实现我们的需求。在实际开发中，我们需要注意进行异常处理，以保证程序的健壮性。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/227317.html