Archivo de la etiqueta: await

Lo que estoy maquinando sobre expresiones lambda (métodos anónimos), programación asíncrona (tareas en otros hilos), cancelación de tareas, Parallel.For, consultas LINQ, DataGridView virtual y más, tanto para C# como para Visual Basic

Pues eso… ¡peasso de título! y seguramente se me olvidará algo, por eso he puesto al final «y más». Pero la idea que tengo en mente hoy 24 de febrero de 2022 (con la guerra de Ucrania fresquita, aunque es algo que, lamentablemente no es tan fresca y que ya viene de largo), es explicarte en una serie de posts o entradas en el blog todo lo indicado en el título.

Sobre las expresiones lambda o métodos anónimos, he pensado en ponerte un par de videos que Héctor de León publicó a principios del año pasado en su canal de YouTube (HDELEON.NET), pero como el código que él utiliza es para C# .NET, te mostraré también el equivalente para VB.NET así, si eres de los que utilizan C# lo puedas entender mejor. Todo esto contando con que él me autorice mostrar su código de C# y el equivalente (en la medida de lo posible) de Visual Basic para punto NET.
Actualización de las 17:33: Autorización que ya me ha dado 😉 ¡Gracias Héctor!

En cuanto a la programación asíncrona, te explicaré cómo crear tareas en otros hilos (principalmente con Task.Run) y el uso de async y await. Esas tareas se lanzarán o se procesarán también en el hilo principal de una aplicación de tipo Windows Forms (todo el código creado para .NET Core versiones 5 y/o 6) de forma que sepas qué cosas debes saber para el uso de controles, etc. entre hilos, cosa que solucionaré con InvokeRequired y la llamada a un delegado mediante Invoke. Por supuesto verás cómo definir delegados y cómo usarlos en el código.
Con todo esto verás cómo acceder a parte del código que se ejecuta en el hilo principal (el creado para mostrar el formulario de inicio) desde otro hilo (o tarea).

También verás cómo cancelar esas tareas y cómo controlarlas, todo ellos mediante el uso de objetos CancellationTokenSource y CancellationToken (tanto en su forma normal y anulable). Y lo que debes hacer para comprobar en el código cuando se ha cancelado y cómo tratar esa cancelación, algo que harás pasándole a la tarea (Task) el objeto de tipo CancellationToken.

Y como algunas de las tareas (ya sean asíncronas o no) puede que tenga que acceder a objetos de una colección, verás algunos casos de cómo usar Parallel.For para repartir en tareas el proceso de comprobación del contenido de esa colección.

La mayoría de las cosas que se hará en el código de ejemplo requerirá de las expresiones lambda (o métodos anónimos) y su uso en expresiones de LINQ. Ya sabes: Where, Any, Select, etc.

Por último, parte del código de ejemplo lo haré usando un control DataGridView y en ese caso te mostraré cómo crearlo para usar una caché con los datos que manejará y todo ello usando el modo virtual de ese control, de esa forma, al menos en mi caso, he logrado agilizar (sobre todo acelerar) mostrar los datos en ese grid (o cuadrícula). La caché usada estará preparada para el tipo de datos que voy a usar en ese ejemplo.

Todo esto, lo iré publicando poco a poco, entre otras cosas, porque lo estoy usando en una aplicación que utiliza datos o tipos muy concretos. Si te sirve de algo, es una aplicación que estoy migrando de MS-DOS a Windows, y la mayoría de los datos los obtiene de ficheros de texto… ¡Sí, así de vieja es! 🙂
Pero haré que el código acceda a colecciones de datos más simples, que en principio no se obtendrá de una base de datos, pero no descarto que también haga alguna modificación para acceder a una base de datos, y si es remota, mejor. Pero eso ya lo veré en su momento.

Bueno, te dejo por ahora y ya iré poniendo cosas… seguramente pondré los enlaces en este mismo post, pero si se me olvida hacerlo… pues… ¡busca en fechas posteriores al 24 de febrero de 2022! 😉

Y ya sabes… si me quieres invitar a un cafelillo o refresco virtual, puedes usar el enlace de DONAR con PayPal. Gracias de antemano.

Nos vemos.
Guillermo

Descargar ficheros de un sitio WEB usando HttpClient (ejemplos para VB.NET y C#)

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.

Como usar GetFileFromApplicationUriAsync (para que no se te cuelgue la aplicación)

 

Pues eso… que este post iba a ser una especie de declaración de «mi» incapacidad a la hora de trabajar de forma asíncrona con los ficheros de una aplicación de Windows Store, y al final será una especie de truco o consejo de cómo hacer las cosas con todo esto de el acceso a ficheros de forma asíncrona (la única que conozco para Windows Store).

Y la solución no es porque «yo» haya dado con la respuesta, bueno, un poco sí, ya que si no hago un par de búsquedas en Google lo mismo no hubiese dado con la respuesta.

Y digo «un par» de búsquedas por no decir tres, ya que es complicado algunas veces encontrar respuestas, sobre todo porque la mayoría de las preguntas con respuestas están en inglés y después porque no sabes con certeza cómo «plantear» la búsqueda…

Y lo curioso es que al tercer intento con esto: «GetFileFromApplicationUriAsync don’t» es cuando ha salido la respuesta, y precisamente en el primer lugar:

 

getfilefromapplicationuriasync don t  Buscar con Google

 

Y eso que en la búsqueda anterior lo puse un poco más concreto, en fin… estos buscadores y/o los usuarios de los mismos… ¡habrá que apañarlos! 😉

 

Te explico de qué va la cosa:

Estoy haciendo una aplicación para Windows 8 (Windows Store) en la que quiero mostrar el contenido de unos ficheros de textos. Para ello estoy usando una versión adaptada del tipo de proyecto Split App en el que todo el contenido está basado en «bindings», pero ese no es el problema, el problema es que en la clase SampleDataSource estoy haciendo una serie de cambios para que se adapte a lo que yo quiero, y como el texto a mostrar es bastante grande como para «pegarlo» en la propia clase (tal como hacen en el proyecto de ejemplo) me puse a crear un código que leyera el contenido del fichero y lo asignara adecuadamente a una propiedad de la clase usada como «binding» que es la que muestra el texto final.

Así que… se me ocurrió usar este código (y algún otro con distintas pruebas):

 

Dim ficUri = New Uri("ms-appx:///contenido/" & fic)

' aquí se queda colgado (algunas veces)
' las veces que pasa de aquí es en modo debug y haciendo un break
' (pero no siempre)
Dim file = Await StorageFile.GetFileFromApplicationUriAsync(ficUri)

' Aquí también se para, y pasa si hay un breakpoint
Dim sf = Await file.OpenStreamForReadAsync

Using sr As New StreamReader(sf, Encoding.UTF8, True)
    sBody = sr.ReadToEnd()
End Using

Return sBody


 

Y tal como comento en los comentarios (valga la redundancia) cuando estaba en funcionamiento «natural» no pasaba de ahí y se quedaba colgada la aplicación.

Ya estaba por desistir cuando me ha dado el punto de buscar en Google ya que suponía que no sería cosa mía y que seguramente a alguien más le habrá ocurrido… ¡y así es!

Nota: antes de buscar en Google ya busqué información en la documentación de Visual Studio, pero no encontré nada, aparte de los ejemplos triviales que suelen poner que que dan por hecho de que prácticamente te lo sabes todo, todo, todo… en fin…

No me voy a enrollar más de la cuenta y te pongo el código correcto para hacer esa tarea de leer un fichero de forma asíncrona y que no se quede colgada la aplicación de Windows Store.

 

También te pondré el enlace a esa pregunta y un artículo del autor de la respuesta donde explica porqué pasa eso, no, mejor dicho: «porqué nos pasa eso a los principiantes» del acceso asíncrono, o eso he entendido yo de este párrafo:

«I think it’s the most-asked question by async newcomers once they’ve learned the basics.»

Y tiene razón ya que reconozco que soy un newcomer en esto de el acceso asíncrono, al menos para los ficheros en el directorio de la aplicación, ya que antes he estado accediendo de forma asíncrona a otros ficheros (del Local storage) y ha funcionado… en fin…

 

Dim ficUri = New Uri("ms-appx:///contenido/" & fic)

Dim file = Await StorageFile.GetFileFromApplicationUriAsync(ficUri).AsTask().ConfigureAwait(False)

Dim sf = Await file.OpenStreamForReadAsync().ConfigureAwait(False)

Using sr As New StreamReader(sf, Encoding.UTF8, True)
    sBody = sr.ReadToEnd()
End Using


Return sBody

 

Como puedes ver, la solución es agregar .AsTask().ConfigureAwait(False) al final del método GetFileFromApplicationUriAsync que es el que se encarga de obtener el fichero desde el directorio de la aplicación, y de ConfigureAwait(False) al método OpenStreamForReadAsync que es el que se encarga de convertir dicho fichero en un Stream de lectura.

 

La explicación del porqué del uso de esos métodos está en el comentario que hizo Nito al preguntarle el «buscador de respuestas» porqué era necesario hacer eso:

(te lo pego en inglés que la traducción automática como que no me convence)

Explanation is quite simple: when you use task.Result ortask.Wait() on GUI thread in conjunction with await keyword you’re causing deadlock. This happens because after awaiting code is resumed on the same context it was invoked (in your case – GUI thread). And because GUI thread currently waiting for task to complete (via Result or Wait()) deadlock arises and code after await keyword will never be invoked. ConfigureAwait(false)specifies that current context can be ignored and thus allows your code to complete successfully. More details on this here: http://nitoprograms.blogspot.com/2012/07/dont-block-on-async-code.html

 

Este es el enlace a la pregunta/respuesta esa que te comentaba y este otro es al artículo de Nito Programming.

 

Espero que te sea de utilidad.

 

Nos vemos.

Guillermo