Download file tramite protocollo SFTP in C#

Nel post di oggi vedremo come effettuare il Download file tramite protocollo SFTP in C# utilizzando la libreria WinSCP.
Trovate la parte di configurazione del progetto, con il codice che si occupa di effettuare la connessione con il server SFTP, a questo link.

Download file tramite protocollo SFTP in C#

Implementazione

Il download dei file presenti sul server verrà effettuato utilizzando un metodo dell’oggetto TransferOperationResult() appartenente all’assembly WinSCP.
Ecco il codice completo da inserire nel file Program.cs presente nel progetto. La parte fino alla riga Console.WriteLine(“Successful connection”); si occupa di effettuare la connessione con il server. Subito dopo ci sono le istruzioni che si occupano di effettuare il download dei file.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WinSCP;

namespace SFTP_Test
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                SessionOptions sessionOptions = new SessionOptions();
                sessionOptions.Protocol = Protocol.Sftp;
                sessionOptions.HostName = "ftp.host.com";
                sessionOptions.UserName = "userName";
                sessionOptions.Password = "p4ssw0rd";
                sessionOptions.GiveUpSecurityAndAcceptAnySshHostKey = true;

                using (Session session = new Session())
                {
                    // Connect
                    session.Open(sessionOptions);

                    Console.WriteLine("Successful connection");

                    // Download files
                    TransferOptions downloadOptions = new TransferOptions();
                    downloadOptions.TransferMode = TransferMode.Binary;

                    TransferOperationResult downloadResult;
                    downloadResult = session.GetFiles("/RemoteDirectory/*", @"c:\file\download\", false, downloadOptions);

                    // Throw on any Download error
                    downloadResult.Check();

                    // Print Download results
                    foreach (TransferEventArgs transfer in downloadResult.Transfers)
                    {
                        Console.WriteLine("Download of {0} succeeded", transfer.FileName);
                    }
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine("Error: {0}", ex);
            }
            Console.ReadLine();
        }
    }
}

Panoramica del codice

Tramite le classi TransferOptions e TransferOperationResult effettuiamo il download dei file

// Download files
TransferOptions downloadOptions = new TransferOptions();
downloadOptions.TransferMode = TransferMode.Binary;

TransferOperationResult downloadResult;
downloadResult = session.GetFiles("/RemoteDirectory/*", @"c:\file\download\", false, downloadOptions);

N.B. /RemoteDirectory/* indica la cartella remota da cui di vuole effettuare il download.
Il simbolo * indica che vogliamo scaricare tutti i file presenti all’interno della directory, se si vuole effettuare il download di un singolo file di cui si conosce basta sostituirlo in questo modo:

downloadResult = session.GetFiles("/RemoteDirectory/NomeFile.estensione", @"c:\file\download\", false, downloadOptions);

Subito dopo, tramite il ciclo foreach, cicliamo e visualizziamo sulla console l’elenco dei file scaricati

// Print Download results
foreach (TransferEventArgs transfer in downloadResult.Transfers)
{
  Console.WriteLine("Download of {0} succeeded", transfer.FileName);
}

Ora non ci resta che testare se il codice funziona correttamente cliccando sul tasto Avvia dell’IDE.
Se non ci sono errori vedremo, nella console di Windows, l’esito e l’elenco dei file appena scaricati.

Trovate le altre implementazioni della gestione dei file tramite protocollo SFTP in C# a questo link.
Per maggiori informazioni sulla libreria WinSCP vi rimando al sito ufficiale raggiungibile qui.

A presto 😉