Jorge Serrano
  • Home

Uso de yield en C#, ese pequeño desconocido

  • By jorge
  • Dic-21-2019
  • .NET Core 3.0, C#, C# 7.3, C# 8.0
  • 2 Comments.

La palabra clave contextual yield (no palabra reservada) tiene un uso y significado muy concreto en C#.

Nota: puedes acceder a la lista de palabras clave contextuales de C# en este enlace

El proceso de trabajo con yield es muy simple y al mismo tiempo muy beneficioso, sin embargo, es un gran desconocido por muchos programadores de C# y está infrautilizado.
Quizás porque su funcionamiento es algo extraño.

Espero que con esta entrada quede mucho más claro cómo funciona y nos aclare sus ventajas.

Con yield estaremos indicando que el get, método u operador que accede al mismo, es un iterador.
De esta forma, devolveremos cada valor de la iteración de uno en uno a través de return yield.
La función que contiene cada return yield, debe devolver un objeto que implemente la interfaz IEnumerable<object>.

Para acceder a sus elementos, bastará con hacerlo dentro de un bucle foreach y llamando al método o bien accediendo a ellos a través de una consulta LINQ.
En cada iteración del bucle foreach llamamos al método tal y como indico.
Al ejecutarse return yield dentro del método, se devuelve el valor de la expresión y se guarda internamente la localización del código que ejecutaba la iteración, de manera tal que la siguiente iteración o llamada al método pasa directamente al elemento siguiente.

En el caso de que queramos detener la iteración, bastará con indicar yield break.

Veamos el uso de yield con un sencillo ejemplo que ayudará a comprender mejor su uso.

Imaginemos el siguiente código de nuestro método encargado de devolver el nombre de los doce meses del año en un idioma concreto.

private static IEnumerable GetMonthNames(string culture)
{
    for (int i = 0; i < 12; i++)
        yield return new DateTime(2020, i + 1, 1)
            .ToString("MMMM", CultureInfo.CreateSpecificCulture(culture));
}

Ahora imaginemos la parte del código que se encarga de iterar por los elementos que devuelve el método y que irá mostrando en pantalla uno a uno.

foreach (var monthName in GetMonthNames("en"))
    Console.WriteLine($"{monthName}");

También podríamos utilizar LINQ para recorrer los elementos y obtener aquellos que siguen la lógica de LINQ establecida.
Imaginemos por ejemplo que queremos obtener aquellos meses que empiezan por la letra «M».
Nuestro código quedaría de la siguiente forma en ese caso:

foreach (var monthName in GetMonthNames("en").Cast<string>().Where(q => q.StartsWith("M")))
    Console.WriteLine($"{monthName}");

Cabe recordar también, que el método puede ser llamado en cualquier momento como lo hacemos siempre con un método que devolviera una colección sin atender a cada uno de los resultados devueltos en yield, por lo que podríamos hacer algo parecido a:

var monthNames = GetMonthNames("es");

monthNames será en este caso de tipo IEnumerable.

Como podemos apreciar en los ejemplos que hemos visto, lo que hacemos es utilizar un bucle foreach para recorrer todos los elementos que nos devuelva el método GetMonthNames.
En cada iteración llamaremos al método que irá devolviendo uno a uno los elementos pedidos hasta que finalice el bucle dentro del método.

De esta forma, con yield podremos ejecutar o realizar acciones adicionales con cada uno de los elementos sin tener que esperar a que el método se termine de ejecutar y devolver todos los elementos que contendría la colección tal y como normalmente utilizamos las colecciones en nuestras aplicaciones.

Una ventaja adicional de usar yield es que nos evitaremos la creación de colecciones temporales o variables adicionales para ir recopilando y creando un conjunto de resultados.
Pero hay más ventajas de usar yield como el hecho de ir obteniendo la respuesta de cada valor antes de que todos sus valores hayan sido devueltos y por lo tanto, podemos ir realizando acciones o tareas adicionales por cada uno.

Espero que por un lado, haya desmitificado un poco yield, y por otro lado haya podido valorar las ventajas que su uso puede darnos en determinados contextos.

Como información extra, te invito a visitar la entrada que publiqué hace algunos meses respecto a Asynchronous Streams dónde se usa la interfaz IAsyncEnumerable<T>.

Happy Coding!

Comments

2 Responsesso far

  1. Andrea Santisteban dice:
    1 octubre, 2020 a las 10:22 pm

    Acerca de «También podríamos utilizar LINQ para recorrer los elementos y obtener aquellos que siguen la lógica de LINQ establecida.»

    using System.Linq;
    ….
    ‘IEnumerable’ does not contain a definition for ‘Where’

    ¿?

    Responder
  2. jorge dice:
    3 octubre, 2020 a las 6:34 am

    Hola Andrea

    Aunque siempre preparo bien todo lo que subo, el código efectivamente, tenía un typo que ya he corregido. O:-)

    foreach (var monthName in GetMonthNames(«en»).Where(q => q.StartsWith(«M»)))
    Console.WriteLine($»{monthName}»);

    Debería ser:

    foreach (var monthName in GetMonthNames(«en»).Cast<string>().Where(q => q.StartsWith(«M»)))
    Console.WriteLine($»{monthName}»);

    No obstante, el código anterior:

    foreach (var monthName in GetMonthNames(«en»).Where(q => q.StartsWith(«M»)))
    Console.WriteLine($»{monthName}»);

    También es válido si la función que usaba de ejemplo fuera (devolviendo un IEnumerable<string> en lugar de un IEnumerable):

    private static IEnumerable<string> GetMonthNames(string culture)
    {
    for (int i = 0; i < 12; i++)
    yield return new DateTime(2020, i + 1, 1)
    .ToString("MMMM", CultureInfo.CreateSpecificCulture(culture));
    }

    En algún momento, o mis dedos han cambiado algo, o la parte <string> me la ha quitado el corrector del blog, que a veces lo hace, y no me he dado cuenta.

    Gracias por comentar,

    Jorge

    Responder

Deja un comentario Cancelar respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

← Previous Post Next Post →

Jorge Serrano

MVP Reconnect


¡Subscríbete a mi canal!
YouTube

Donaciones
Donation

Entradas recientes

  • Go – Arrays
  • Go – Operators
  • Go – Constants
  • Go – Tipos de Datos
  • Go – Variables
  • Hello Go-rld!
  • Introducción a Go o Golang
  • JSON Patch en ASP.NET Core 5 Web API
  • Null Checking en C#
  • ¿Porqué mi página web por defecto de ASP.NET Core no se vé en mi Azure Web App y me da un 404?

Categorías

  • .NET 5
  • .NET Core
  • .NET Core 3.0
  • .NET Core 3.1
  • .NET Framework 2.0
  • .NET Framework 3.0
  • .NET Framework 3.5
  • .NET Framework 4.0
  • .NET Framework 4.5
  • .NET Framework 4.6
  • .NET Framework 4.7
  • .NET Framework 4.8
  • .NET Standard 2.0
  • .NET Standard 2.1
  • AMQP
  • Android
  • Angular
  • API REST
  • Apple
  • Apple iOS
  • Apple macOs
  • Arquitectura
  • ASP.NET
  • ASP.NET Core
  • ASP.NET Core 3
  • ASP.NET Core 5
  • AWS
  • Azure App Service
  • Azure Application Insights
  • Azure Cosmos DB
  • Azure Database Migration Service
  • Azure Databricks
  • Azure DevOps
  • Azure Event Grid
  • Azure Functions
  • Azure IoT
  • Azure Portal
  • Azure PowerShell
  • Azure Queue Storage
  • Azure SQL
  • Azure Storage
  • Azure Virtual Datacenter
  • Azure WebApps
  • Big Data
  • Bing
  • Blazor
  • Blog
  • Bots
  • C#
  • C# 7.0
  • C# 7.1
  • C# 7.2
  • C# 7.3
  • C# 8.0
  • C# 9.0
  • Channel 9
  • Codeplex
  • Codespaces
  • Containers
  • Debugging
  • DevOps
  • Docker
  • Electron
  • Entity Framework
  • Entity Framework Core
  • Entity Framework Core 3.0
  • Entity Framework Core 5
  • Eventos
  • F#
  • FaaS
  • FeatureFlags
  • FeatureToggles
  • Feeds
  • Fluent Assertions
  • General
  • GIMP
  • Git
  • GitHub
  • Go
  • Google
  • Google Analytics
  • Gradle
  • gRPC
  • GSA
  • Historia de la Informática
  • HoloLens
  • HtmlAgilityPack
  • IdentityServer4
  • Inkscape
  • Ionic
  • iOS
  • IoT
  • Java
  • JavaScript
  • JDBC
  • JSON
  • Kubernetes
  • Lenguajes de Programación
  • Libros y Cursos
  • LINQ
  • Linux
  • LiteDB
  • Machine Learning
  • macOS
  • Microservices
  • Microsoft
  • Microsoft .NET Framework 4.5
  • Microsoft 365
  • Microsoft Azure
  • Microsoft Build
  • Microsoft Ignite
  • Microsoft Learn
  • Microsoft Orleans
  • Microsoft Surface Go
  • Microsoft Teams
  • ML.NET
  • MQTT
  • MRO
  • MS-DOS
  • MsCoders Madrid
  • MVP
  • NancyFx
  • Node.js
  • NoSQL
  • NuGet
  • NUnit
  • OData
  • ODP.NET Core
  • Office 2007
  • Office 2010
  • Office 2013
  • Office 2016
  • Office 2019
  • Office 365
  • Open Source
  • Open XML SDK
  • Opinión
  • Orchard CMS
  • OT
  • PaaS
  • Patterns
  • PdfSharpCore
  • Performance
  • PHP
  • Postman
  • Power BI
  • PowerShell
  • PowerShell Core
  • Productividad
  • Project Server 2019
  • R
  • Rendimiento
  • Scala
  • Scraper
  • Security
  • Serverless
  • Service Fabric
  • SharePoint Server 2019
  • SignalR
  • Sin categoría
  • Sistemas Distribuidos
  • Skype
  • Skype for Business Server 2019
  • Small Basic Online
  • SQL Server 2005
  • SQL Server 2008
  • SQL Server 2012
  • SQL Server 2014
  • SQL Server 2016
  • SQL Server 2017
  • SQL Server 2019
  • STOMP
  • Swagger
  • Testing
  • TFS 2017
  • TFS 2018
  • Tools
  • TypeScript
  • Unity
  • UWP
  • UX
  • Visio
  • Visual Basic
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013
  • Visual Studio 2015
  • Visual Studio 2017
  • Visual Studio 2017 for Mac
  • Visual Studio 2019
  • Visual Studio 2019 for Mac
  • Visual Studio App Center
  • Visual Studio Code
  • Visual Studio IntelliCode
  • Visual Studio Live Share
  • Visual Studio Live Share Audio
  • Visual Studio Online
  • VS Anywhere
  • Vue.js
  • Web API
  • WebAssembly
  • WinDbg
  • Windows
  • Windows 10
  • Windows Compatibility Pack
  • Windows Phone 10
  • Windows Phone 7
  • Windows Phone 8
  • Windows Server 2008
  • Windows Server 2012
  • Windows Server 2016
  • Windows Server 2019
  • Windows Service
  • WinForms
  • WinUI
  • WPF
  • Xamarin
  • Xbox
  • Xcode
  • Xiaomi Mi Band 2
  • xUnit
  • YAML

Archivos

  • enero 2021
  • diciembre 2020
  • noviembre 2020
  • octubre 2020
  • septiembre 2020
  • agosto 2020
  • julio 2020
  • junio 2020
  • mayo 2020
  • abril 2020
  • marzo 2020
  • febrero 2020
  • enero 2020
  • diciembre 2019
  • noviembre 2019
  • octubre 2019
  • septiembre 2019
  • agosto 2019
  • julio 2019
  • junio 2019
  • mayo 2019
  • abril 2019
  • marzo 2019
  • febrero 2019
  • enero 2019
  • diciembre 2018
  • noviembre 2018
  • octubre 2018
  • septiembre 2018
  • agosto 2018
  • julio 2018
  • junio 2018
  • mayo 2018
  • abril 2018
  • marzo 2018
  • febrero 2018
  • enero 2018
  • diciembre 2017
  • noviembre 2017
  • octubre 2017
  • septiembre 2017
  • agosto 2017
  • julio 2017
  • junio 2017
  • febrero 2015
  • octubre 2014
  • junio 2014
  • marzo 2014
  • febrero 2014
  • enero 2014
  • diciembre 2013
  • septiembre 2013
  • agosto 2013
  • julio 2013
  • junio 2013
  • abril 2013
  • febrero 2013
  • enero 2013
  • diciembre 2012
  • noviembre 2012
  • septiembre 2012
  • agosto 2012
  • junio 2012
  • mayo 2012
  • abril 2012
  • marzo 2012
  • febrero 2012
  • enero 2012
  • diciembre 2011
  • noviembre 2011
  • octubre 2011
  • septiembre 2011
  • agosto 2011
  • julio 2011
  • junio 2011
  • mayo 2011
  • abril 2011
  • marzo 2011
  • enero 2011
  • diciembre 2010
  • noviembre 2010
  • octubre 2010
  • septiembre 2010
  • agosto 2010
  • julio 2010
  • junio 2010
  • mayo 2010
  • abril 2010
  • marzo 2010
  • febrero 2010
  • enero 2010
  • diciembre 2009
  • noviembre 2009
  • octubre 2009
  • septiembre 2009
  • agosto 2009
  • julio 2009
  • junio 2009
  • mayo 2009
  • abril 2009
  • marzo 2009
  • febrero 2009
  • enero 2009
  • diciembre 2008
  • noviembre 2008
  • octubre 2008
  • septiembre 2008
  • agosto 2008
  • julio 2008
  • junio 2008
  • mayo 2008
  • abril 2008
  • marzo 2008
  • febrero 2008
  • enero 2008
  • diciembre 2007
  • noviembre 2007
  • octubre 2007
  • septiembre 2007
  • agosto 2007
  • julio 2007
  • junio 2007
  • mayo 2007
  • abril 2007
  • marzo 2007
  • febrero 2007
  • enero 2007
  • diciembre 2006
  • noviembre 2006
  • octubre 2006
  • septiembre 2006
  • agosto 2006
  • julio 2006
  • junio 2006
  • mayo 2006
About This Site

A cras tincidunt, ut tellus et. Gravida scel ipsum sed iaculis, nunc non nam. Placerat sed phase llus, purus purus elit.

Archives Widget
  • January 2010
  • December 2009
  • November 2009
  • October 2009
Categories
  • Entertainment
  • Technology
  • Sports & Recreation
  • Jobs & Lifestyle
Search
  • twitter

Powered by WordPress  |  Business Directory by InkThemes.

This site uses cookies: Find out more.