Etiqueta: vb

Pues eso… para descargar ficheros de un sitio Web, hasta hoy usaba el método DownloadFile de la clase WebClient, pero ya estaba un poco harto del «warning» de que esa clase (y otras) estaban obsoletas y que era recomendable usar HttpClient, pero… no daba con un ejemplo (de código) práctico y, porque no, sencillo. Mire en varios sitios y de una forma u otra, se complicaba la cosa… hasta que me dio por mirar el contenido de la clase HttpClient en la documentación de .NET (esto me pasa por no fiarme de los ejemplos de la documentación de MS :-P).

Y aquí te muestro lo que he hecho, creo que de forma simple.

El código que te voy a mostrar descarga un fichero de un sitio Web y lo guarda de forma local. Como para este ejemplo he usado un fichero de texto (txt) que tengo alojado en mi sitio (www.elguille.info), en el código de ejemplo hago que se muestre con el Notepad, pero si lo que te descargas es otro tipo de fichero, ya sea una imagen, etc. tendrás que cambiar el código usado en «Process.Start«.

Este código usa async/await para la descarga y para guardarlo localmente. Pero resulta que Visual Basic no permite usar Async en el método Main (C# tampoco, al menos en las versiones anteriores a la 7.1), por tanto, el código de VB.NET es algo diferente al de C# (aparte de los puntos y comas), básicamente porque en VB el método Main no puede ser asíncrono, así que lo he solucionado haciendo una llamada a otro método desde Main y ese otro método si es asíncrono.
Este mismo paso intermedio tendrás que hacerlo si usas una versión de C# que no soporte que Main sea un método de tipo Task asíncrono. En realidad, tendrías que hacer otros cambios en el código de C#, ya que uso nuevas cosas que tampoco estaban en las versiones anteriores…

Básicamente lo que hace el código es crear una instancia «estática/compartida» de un nuevo objeto del tipo HttpClient y después usarlo en el código. Esto en este ejemplo concreto no es necesario, ya que una vez que se utilice ese objeto el programa prácticamente finaliza, pero… es lo que recomiendan: que solo se use una instancia en la aplicación.

Para la descarga, utilizo el método GetByteArrayAsync al que se le indica la dirección URL donde está el fichero en cuestión (o una página WEB si esa es la idea, la de descargar una página Web), ese método devuelve un array de tipo Byte, que usaremos para guardarlo en el fichero local, esto se consigue con WriteAsync de la clase FileStream, en cuyo constructor, entre otras cosas, indicaremos el path local.

El que haya usado GetByteArrayAsync es porque mi código original no descarga un contenido «normal» de tipo cadena, pero para el caso, también sirve. Y de esta forma podrás usar el método que he definido para esta tarea de descargar/guardar (DownloadFileAsync) para cualquier tipo de contenido.

Y ya, no me enrollo más y te muestro el código.

Nota:
Aunque sea más código, te muestro TODO el código, incluyendo las importaciones, etc.

El código de ejemplo para Visual Basic.NET

'--------------------------------------------------------------------------------
' Descargar un fichero de un sitio web usando HttpClient        (10/Feb/22 19.05)
'
' Ejemplo basado en:
' https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient
'
' (c) Guillermo Som (Guille), 2022
'--------------------------------------------------------------------------------
Imports System
Imports System.Diagnostics
Imports System.Threading.Tasks

Module Program

    ''' <summary>
    ''' El objeto HttpClient se recomiendo instanciarlo solo 1 vez en la aplicación.
    ''' </summary>
    Private ReadOnly ClienteHttp As New System.Net.Http.HttpClient()

    Sub Main(args As String())
        'Console.WriteLine("Hello World!")

        ' Como en VB no se puede esperar en Main,
        ' hacer el trabajo asíncrono en otro método y esperar a que se termine todo...
        descargar()

        Console.ReadLine()
    End Sub

    Private Async Sub descargar()
        Dim ficWeb = "https://www.elguille.info/pruebaGuille.txt"
        Dim ficLocal = "prueba.txt"

        Console.WriteLine("Descargando {0}...", ficWeb)

        Dim res = Await DownloadFileAsync(ficWeb, ficLocal)
        If res Then
            Console.WriteLine("Descarga completada.")

            ' Mostrar el contenido del fichero local.
            Process.Start("notepad", ficLocal)
        End If

        Console.WriteLine()
        Console.WriteLine("Pulsa INTRO para finalizar.")
    End Sub

    ''' <summary>
    ''' Descarga el fichero indicado (url) y lo guarda en el fichero destino (usando HttpClient).
    ''' </summary>
    ''' <param name="ficWeb">El fichero a descargar (de una dirección URL).</param>
    ''' <param name="ficDest">El fichero de destino, donde se guardará el descargado.</param>
    ''' <returns>True o false según haya tenido éxito la descarga o no.</returns>
    Public Async Function DownloadFileAsync(ficWeb As String, ficDest As String) As Task(Of Boolean)
        Try
            ' Simplificando la descarga.
            Dim contenido = Await ClienteHttp.GetByteArrayAsync(ficWeb)
            ' Si se ha podido descargar.
            If contenido IsNot Nothing AndAlso contenido.Length > 0 Then
                ' Guardarlo en el fichero de destino.
                ' Si el fichero destino existe, se sobreescribe.
                Using fs As New System.IO.FileStream(ficDest, System.IO.FileMode.Create,
                                                              System.IO.FileAccess.Write,
                                                              System.IO.FileShare.None)
                    Await fs.WriteAsync(contenido.AsMemory(0, contenido.Length))
                End Using
            Else
                Console.WriteLine("No se ha podido descargar.")
                Return False
            End If
        Catch ex As Exception
            ' Se ha producido un error al descargar o guardar.
            Console.WriteLine("Error: {0}", ex.Message)
            Return False
        End Try

        Return True
    End Function

End Module

El código de ejemplo para C#

//--------------------------------------------------------------------------------
// Descargar un fichero de un sitio web usando HttpClient        (10/Feb/22 19.25)
//
// Ejemplo basado en:
// https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient
//
// (c) Guillermo Som (Guille), 2022
//--------------------------------------------------------------------------------

using System;
using System.Diagnostics;
using System.Threading.Tasks;

namespace Descargar_Fichero_con_HttpClient_CS
{
    class Program
    {
        /// <summary>
        /// El objeto HttpClient se recomiendo instanciarlo solo 1 vez en la aplicación.
        /// </summary>
        private readonly static System.Net.Http.HttpClient ClienteHttp = new();

        // En C# 7.1 y superior se puede usar Main como Task y async.
        static async Task Main(string[] args)
        {
            //Console.WriteLine("Hello World!");

            var ficWeb = "https://www.elguille.info/pruebaGuille.txt";
            var ficLocal = "prueba.txt";

            Console.WriteLine("Descargando {0}...", ficWeb);

            var res = await DownloadFileAsync(ficWeb, ficLocal);
            if (res)
            {
                Console.WriteLine("Descarga completada.");

                // Mostrar el contenido del fichero local.
                Process.Start("notepad", ficLocal);
            }

            Console.WriteLine();
            Console.WriteLine("Pulsa INTRO para finalizar.");



            // Las versiones de C# anteriores a 7.1 no pueden esperar en Main,
            // por tanto, el código anterior ponerlo en un método y llamarlo desde aquí
            // y esperar a que se termine todo...
            //descargar();

            Console.ReadLine();
        }

        /// <summary>
        /// Descarga el fichero indicado (url) y lo guarda en el fichero destino (usando HttpClient).
        /// </summary>
        /// <param name="ficWeb">El fichero a descargar (de una dirección URL).</param>
        /// <param name="ficDest">El fichero de destino, donde se guardará el descargado.</param>
        /// <returns>True o false según haya tenido éxito la descarga o no.</returns>
        public async static Task<bool> DownloadFileAsync(string ficWeb, string ficDest)
        {
            try
            {
                // Simplificando la descarga.
                var contenido = await ClienteHttp.GetByteArrayAsync(ficWeb);
                // Si se ha podido descargar.
                if (contenido != null && contenido.Length > 0)
                {
                    // Guardarlo en el fichero de destino.
                    // Si el fichero destino existe, se sobreescribe.
                    using System.IO.FileStream fs = new(ficDest, System.IO.FileMode.Create, 
                                                                 System.IO.FileAccess.Write, 
                                                                 System.IO.FileShare.None);
                    await fs.WriteAsync(contenido.AsMemory(0, contenido.Length));
                }
                else
                {
                    Console.WriteLine("No se ha podido descargar.");
                    return false;
                }
            }
            catch (Exception ex)
            {
                // Se ha producido un error al descargar o guardar.
                Console.WriteLine("Error: {0}", ex.Message);
                return false;
            }

            return true;
        }
    }
}

Y esto es todo… recuerda pulsar en el botoncito ese de PayPal si así lo crees conveniente 😉

Nos vemos.
Guillermo

P.S.
El código lo puedes ver/descargar del repositorio de GitHub que he creado para este caso.