Jorge Serrano
  • Home

C# 9.0 – Specification – Init-only Setters

  • By jorge
  • Sep-28-2020
  • .NET 5, C# 9.0
  • 1 Comment.

Índice general – C# 9.0 – Specification

A colación de un comentario que me hizo Eduard Tomás acerca de esta entrada, te recomiendo leer después la entrada Algunas particularidades respecto a la inicialización y validación en setters que publiqué días después para aclarar algunas cosas a tener en consideración respecto a inicialización y validación dentro de una clase.

Introducción

Una de las características añadidas en C# 9 tiene que ver con la inmutabilidad de un objeto, y en concreto con la inmutabilidad de aquellas propiedades que consideramos claves dentro del objeto.

Pero antes de entrar a detallar cómo funciona y para qué sirve, vamos a hacer un repaso rápido de una típica clase Person en C#, y cómo desde nuestra aplicación de consola podríamos trabajar con ella.

Nuestra clase Person bien podría estar compuesta por dos propiedades, Name para indicar el nombre de la persona, e IsMarried para indicar si la persona está casada o no.

public class Person
{
    public string Name { get; set; }
    public bool IsMarried { get; set; }
}

Y la parte de código de nuestra aplicación de consola podría quedar de la siguiente forma:

public class Program
{
    public static void Main()
    {
        var person = new Person
        {
            Name = "Peter",
            IsMarried = false
        };
        
        Console.WriteLine(person.Name); // Peter
        person.Name = "Peter Johnson";
        Console.WriteLine(person.Name); // Peter Johnson
    }
}

Conclusiones que podemos extraer de nuestro código

  • Que en cualquier momento, podemos modificar el valor de Name tal y como podemos ver.
  • Que lo anterior significa que nuestro objeto es mutable, es decir, una vez creado podemos cambiar su estado.

Seguramente alguien se pregunte que eso ya se podía hacer indicando la propiedad como private, es decir, de esta manera:

public class Person
{
    public string Name { get; private set; }
    public bool IsMarried { get; set; }
}

De hecho, haciéndolo así y modificando el valor de la propiedad Name, obtendremos un error de compilación:

error CS0272: The property or indexer 'Person.Name' cannot be used in this context 
because the set accessor is inaccessible

Pero haciéndolo así, se debe forzar la inicialización de esas propiedades en el constructor.
Sino, el siguiente código:

var person = new Person
{
    Name = "Peter",
    IsMarried = false
};

Dará el mismo error anterior que indicaba anteriormente:

error CS0272: The property or indexer 'Person.Name' cannot be used in this context 
because the set accessor is inaccessible

Init-only

Y aquí, es donde entra en juego init-only.

Esta nueva característica de la especificación C# 9 tiene como propósito, establecer la inmutabilidad de las propiedades que forman parte de nuestro objeto en su inicialización, que para ello usaremos el inicializador init en nuestra propiedad, y que de esta forma, podremos indicar que nuestra propiedad actuará como de sólo lectura.

Para ello, utilizaremos en las propiedades la palabra reservada init en lugar de set.

Reutilizando el ejemplo anterior, el código de nuestra clase Person quedará ahora de la siguiente forma:

public class Person
{
    public string Name { get; init; }
    public bool IsMarried { get; set; }
}

Y la inicialización anterior que en el caso de private dentro del set daba un problema de compilación, puede usarse ahora sin problemas:

var person = new Person
{
    Name = "Peter",
    IsMarried = false
};

Sin embargo, seguiremos teniendo un problema a la hora de querer modificar el valor de la propiedad, es decir, el siguiente código, dará un problema:

Console.WriteLine(person.Name); // Peter
person.Name = "Peter Johnson";
Console.WriteLine(person.Name); // Peter Johnson

El error que el compilador nos devolverá será:

error CS8852: Init-only property or indexer 'Person.Name' can only be assigned in an object 
initializer, or on 'this' or 'base' in an instance constructor or an 'init' accessor.

Por lo que el comportamiento que tendrá nuestra propiedad Name será el de una propiedad de sólo lectura, inmutable e inicializable a la hora de crear nuestro objeto.

Validando nuestras propiedades marcadas como init pero no inicializadas

Y aquí surge una pregunta o una situación que a la hora de desarrollar nuestras aplicaciones podemos plantearnos.

¿Cómo fuerzo o chequeo que se inicializa las propiedades que marco como init?

Por que claro, si yo escribo el siguiente código:

var person = new Person
{
    IsMarried = false
};

No me «entero» que Name no ha sido inicializada, y si me interesa «forzar» que la inicialización sea completada, me interesaría validar que ésta se ha realizado tal y cómo espero.

Recordemos que estamos trabajando con propiedades, y que el get y el set (en este caso init) puede ser tratado de forma simple (como he mostrado) o compleja con lógica de código dentro, así que la solución pasa por poner algo de lógica dentro.

Pero pongamos en contexto que añadir lógica en nuestros getters y setters requiere casi siempre, la declaración de una variable privada (normalmente de sólo lectura) para guardar en ella (set) el valor que recibimos en la propiedad, y devolviendo ese valor (get).

Dicho de otra forma, un posible ejemplo en nuestro código de demostración podría bien ser el siguiente que fuerza una excepción en el caso de que el getter devuelva o contenga un valor no esperado que debiera haber sido inicializado:

public class Person
{
    private readonly string _name;
    
    public string Name 
    { 
        get => (_name ?? throw new ArgumentNullException(nameof(Name))); 
        init => _name = value; 
    }
    public bool IsMarried { get; set; }
}

De esta sencilla manera, forzaremos a inicializar nuestro objeto de forma correcta.

Es decir, el siguiente código:

var person = new Person
{
    IsMarried = false
};

No nos devolverá un error en tiempo de compilación, pero sí de ejecución a la hora de acceder a la propiedad Name (si accedemos a ella):

Value cannot be null. (Parameter 'Name')

Igualmente, también podemos forzar una excepción en la inicialización si el valor que damos a la propiedad no es el esperado.

Es decir, podríamos modificar nuestra clase de esta forma:

public class Person
{
    private readonly string _name;
    
    public string Name 
    { 
        get => (_name ?? throw new ArgumentNullException(nameof(Name))); 
        init => _name = (String.IsNullOrWhiteSpace(value) ? throw new ArgumentNullException(nameof(Name)) : value); 
    }
    public bool IsMarried { get; set; }
}

Así, al inicializar con un valor que está fuera de rango o no es el que esperamos, devuelva una excepción al inicializarlo.

Así que este código:

var person = new Person
{
    Name = String.Empty,
    Age = 20
}

Tampoco nos devolverá un error en tiempo de compilación, pero sí en tiempo de ejecución a la hora no de acceder a la propiedad Name, sino al inicializar la propiedad:

Value cannot be null. (Parameter 'Name')

Recordemos que init sólo será llamada al inicializar la propiedad, por lo que poner cierta lógica dentro del setter está permitido.

Cómo vemos, trabajar con la inmutabilidad de nuestras propiedades es realmente sencillo gracias a init, sin embargo, ésto requiere que se repita esta operativa por cada propiedad que tenga en mi objeto.

En sí, no está mal, pero imaginemos por un momento que tenemos una clase con veinte propiedades, y que todas deben ser, de acuerdo a nuestros requisitos, inmutables.
Deberemos repetir esta forma de hacer las cosas por cada una de esas propiedades.

¿Existe alguna forma de trabajar con objetos inmutables de un sólo golpe en todo nuestro objeto?.
Quizás Records, incluido en la especificación de C# 9 también, sea lo que buscamos…

Happy Coding!

Comments

One Responseso far

  1. etomas dice:
    3 octubre, 2020 a las 11:40 am

    Buenas!

    Uf, no me gusta nada lo de lanzar una excepción en el getter para forzar a inicializar el objeto.

    Hay una manera mejor y diseñada para ello: los constructores!

    Saludos!

    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.