C# 9.0 – Specification – Init-only Setters

Í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!