SSH.NET SFTP递归获取目录和文件列表

时间:2012-11-26 20:46:45

标签: c# .net sftp ssh.net

我使用Renci.SshNet库通过使用SFTP递归获取文件和目录列表。我能够连接SFTP站点,但我不知道如何在C#中递归获取目录和文件列表。我没有找到任何有用的例子。

有人试过这个吗?如果是这样,你可以发布一些关于如何递归获取这些文件和文件夹的示例代码。

谢谢,
Prav

5 个答案:

答案 0 :(得分:12)

这个库有一些怪癖会使这个递归列表变得棘手,因为ChangeDirectoryListDirectory之间的交互不能像你期望的那样工作。

以下列出/ home目录中的文件,而不是列出/(root)目录中的文件:

sftp.ChangeDirectory("home");
sftp.ListDirectory("").Select (s => s.FullName);

以下工作并返回SftpPathNotFoundException:

sftp.ChangeDirectory("home");
sftp.ListDirectory("home").Select (s => s.FullName);

以下是列出/ home目录中文件的正确方法

sftp.ChangeDirectory("/");
sftp.ListDirectory("home").Select (s => s.FullName);

如果你问我,这真是太疯狂了。除非在此方法的参数中指定文件夹,否则使用ChangeDirectory方法设置默认目录不会影响ListDirectory方法。好像应该为此编写一个bug。

因此,当您编写递归函数时,您必须设置一次默认目录,然后在迭代文件夹时更改ListDirectory调用中的目录。该列表返回可枚举的SftpFiles。然后可以单独检查这些IsDirectory == true。请注意,该列表还会返回...条目(即目录)。如果您想避免无限循环,您将要跳过这些。 : - )

编辑2/23/2018

我正在审核我的一些旧答案,并且想为上面的答案道歉并提供以下工作代码。请注意,此示例不需要ChangeDirectory,因为它使用Fullname ListDirectory

void Main()
{
    using (var client = new Renci.SshNet.SftpClient("sftp.host.com", "user", "password"))
    {
        var files = new List<String>();
        client.Connect();
        ListDirectory(client, ".", ref files);
        client.Disconnect();
        files.Dump();
    }
}

void ListDirectory(SftpClient client, String dirName, ref List<String> files)
{
    foreach (var entry in client.ListDirectory(dirName))
    {

        if (entry.IsDirectory)
        {
            ListDirectory(client, entry.FullName, ref files);
        }
        else
        {
            files.Add(entry.FullName);
        }
    }
}

答案 1 :(得分:3)

试试这个:

var filePaths = client.ListDirectory(client.WorkingDirectory);

答案 2 :(得分:1)

我使用递归实现了这一点。像这样创建了一个类TransportResponse

 public class TransportResponse
{
    public string directoryName { get; set; }
    public string fileName { get; set; }
    public DateTime fileTimeStamp { get; set; }
    public MemoryStream fileStream { get; set; }
    public List<TransportResponse> lstTransportResponse { get; set; }
}

我创建了一个TransportResponse类列表。如果directoryName不为null,它将包含一个相同类的列表,该列表将该目录中的文件作为MemoryStream(这可以根据您的用例进行更改)

List<TransportResponse> lstResponse = new List<TransportResponse>();
using (var client = new SftpClient(connectionInfo))
  {
          try
          {
                    Console.WriteLine("Connecting to " + connectionInfo.Host + " ...");
                    client.Connect();
                    Console.WriteLine("Connected to " + connectionInfo.Host + " ...");
           }
           catch (Exception ex)
           {
                    Console.WriteLine("Could not connect to "+ connectionInfo.Host +" server. Exception Details: " + ex.Message);
           }
           if (client.IsConnected)
           {
                    var files = client.ListDirectory(transport.SourceFolder);
                    lstResponse = downloadFilesInDirectory(files, client);
                    client.Disconnect();
            }
            else
            {
                    Console.WriteLine("Could not download files from "+ transport.TransportIdentifier +" because client was not connected.");
             }
   }



private static List<TransportResponse> downloadFilesInDirectory(IEnumerable<SftpFile> files, SftpClient client)
    {
        List<TransportResponse> lstResponse = new List<TransportResponse>();
        foreach (var file in files)
        {
            if (!file.IsDirectory)
            {
                if (file.Name != "." && file.Name != "..")
                {
                    if (!TransportDAL.checkFileExists(file.Name, file.LastWriteTime))
                    {
                        using (MemoryStream fs = new MemoryStream())
                        {
                            try
                            {
                                Console.WriteLine("Reading " + file.Name + "...");
                                client.DownloadFile(file.FullName, fs);
                                fs.Seek(0, SeekOrigin.Begin);
                                lstResponse.Add(new TransportResponse { fileName = file.Name, fileTimeStamp = file.LastWriteTime, fileStream = new MemoryStream(fs.GetBuffer()) });
                            }
                            catch(Exception ex)
                            {
                                Console.WriteLine("Error reading File. Exception Details: " + ex.Message);
                            }
                        }
                    }
                    else
                    {
                        Console.WriteLine("File was downloaded previously");
                    }
                }
            }
            else
            {
                if (file.Name != "." && file.Name != "..")
                {
                    lstResponse.Add(new TransportResponse { directoryName = file.Name,lstTransportResponse = downloadFilesInDirectory(client.ListDirectory(file.Name), client) });
                }                
            }
        }

        return lstResponse;
    }

希望这会有所帮助。感谢

答案 3 :(得分:0)

@Carlos Bos

  

这个库有一些怪癖使这个递归列表变得棘手   因为ChangeDirectory和ListDirectory之间的交互   不要像你期望的那样工作。

正确

当ChangeDirectory()参数为&#34;。&#34;

时,它运行良好

但如果你这样做

SftpClient sftp ...;
sftp.ChangeDirectory("some_folder");
//get file list
List<SftpFile> fileList = sftp.ListDirectory("some_folder").ToList();

然后有一个断言,因为ListDirectory()调用需要 &#34; some_folder / some_folder&#34;

我使用的解决方法是在远程上传/重命名为&#34; some_folder&#34;之前保存和恢复当前目录,并且您需要在操作之前列出该文件夹(例如,查看该文件已存在)

string working_directory = sftp.WorkingDirectory;
sftp.ChangeDirectory("some_folder");
sftp.RenameFile("name", "new_name");
sftp.ChangeDirectory(working_directory);

检查文件是否存在,此调用是否足够

sftp.Exists(path)

或者如果您想添加其他一些条件,例如区分大小写

 public FileExistence checkFileExists(string folder, string fileName)
    {
      //get file list
      List<SftpFile> fileList = sftp.ListDirectory(folder).ToList();

      if (fileList == null)
      {
        return FileExistence.UNCONFIRMED;
      }

      foreach (SftpFile f in fileList)
      {
        Console.WriteLine(f.ToString());
        //a not case sensitive comparison is made
        if (f.IsRegularFile && f.Name.ToLower() == fileName.ToLower())
        {
          return FileExistence.EXISTS;
        }
      }

      //if not found in traversal , it does not exist
      return FileExistence.DOES_NOT_EXIST;
    }

其中FileExistence是

public enum FileExistence
    {
      EXISTS,
      DOES_NOT_EXIST,
      UNCONFIRMED
    };

答案 4 :(得分:0)

这是一堂完整的课。这是.netcore 2.1 Http触发功能应用程序(v2)

我想摆脱所有以'。'开头的目录,因为我的sftp服务器具有.cache文件夹和带有密钥的.ssh文件夹。同样也不想处理“。”这样的文件夹名称。或“ ..”

我最终要做的是将SftpFile投影到我可以使用的类型中,并将其返回给调用方(在这种情况下,它将是一个逻辑应用程序)。然后,我将该对象传递给sproc,并使用OPENJSON建立我的监视表。这基本上是创建SFTP处理队列的第一步,该队列会将文件从SFTP文件夹移到Data Lake(现在是blob,直到我想出更好的东西为止)。

我使用.WorkingDirectory的原因是因为我创建了一个主目录为'/ home'的用户。这使我可以遍历所有用户文件夹。我的应用程序不需要以特定的文件夹为起点,可以说是用户“ root”。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Extensions.Logging;
using Renci.SshNet;
using Renci.SshNet.Sftp;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace SFTPFileMonitor
{
    public class GetListOfFiles
    {
        [FunctionName("GetListOfFiles")]
        public async Task<IActionResult> RunAsync([HttpTrigger(AuthorizationLevel.Anonymous, "get")] HttpRequest req, ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            List<SftpFile> zFiles;
            int fileCount;
            decimal totalSizeGB;
            long totalSizeBytes;

            using (SftpClient sftpClient = new SftpClient("hostname", "username", "password"))
            {
                sftpClient.Connect();
                zFiles = await GetFiles(sftpClient, sftpClient.WorkingDirectory, new List<SftpFile>());
                fileCount = zFiles.Count;
                totalSizeBytes = zFiles.Sum(l => l.Length);
                totalSizeGB = BytesToGB(totalSizeBytes);
            }

            return new OkObjectResult(new { fileCount, totalSizeBytes, totalSizeGB, zFiles });
        }
        private async Task<List<SftpFile>> GetFiles(SftpClient sftpClient, string directory, List<SftpFile> files)
        {
            foreach (SftpFile sftpFile in sftpClient.ListDirectory(directory))
            {
                if (sftpFile.Name.StartsWith('.')) { continue; }

                if (sftpFile.IsDirectory)
                {
                    await GetFiles(sftpClient, sftpFile.FullName, files);
                }
                else
                {
                    files.Add(sftpFile);
                }
            }
            return files;
        }
        private decimal BytesToGB(long bytes)
        {
            return Convert.ToDecimal(bytes) / 1024 / 1024 / 1024;
        }
    }
}