Best practice Restituzione dell'oggetto di sola lettura

Oltre alla risposta di @ Jesse, che è la soluzione migliore per le collezioni: l'idea generale è di progettare la tua interfaccia pubblica di A in modo che restituisca solo

• tipi di valori (come int, double, struct)

• oggetti immutabili (come "string" o classi definite dall'utente che offrono solo metodi di sola lettura, proprio come la tua classe A)

• (solo se necessario): copie di oggetti, come dimostra la tua "Opzione B"

IEnumerable<immutable_type_here> è immutabile da solo, quindi questo è solo un caso speciale di quanto sopra.

Si noti inoltre che si dovrebbe programmare su interfacce e, in generale, ciò che si desidera restituire da tale proprietà è un IEnumerable<string> . Un List<string> è un po 'un no-no perché è generalmente mutabile e andrò così lontano per dire che ReadOnlyCollection<string> come implementatore di ICollection<string> sembra violare il Principio di sostituzione di Liskov.

Ho riscontrato un problema simile un po 'indietro e di seguito c'era la mia soluzione, ma funziona davvero solo se controlli anche la libreria:

Inizia con la tua classe A

public class A
{
    private int _n;
    public int N
    {
        get { return _n; }
        set { _n = value; }
    }
}

Quindi ricava un'interfaccia da questo con solo la porzione get delle proprietà (e qualsiasi metodo di lettura) e hai un attrezzo che

public interface IReadOnlyA
{
    public int N { get; }
}
public class A : IReadOnlyA
{
    private int _n;
    public int N
    {
        get { return _n; }
        set { _n = value; }
    }
}

Ovviamente, quando vuoi usare la versione di sola lettura, è sufficiente un cast semplice. Questo è esattamente ciò che la soluzione C è, in realtà, ma ho pensato di offrire il metodo con cui l'ho raggiunto

Per chiunque trovi questa domanda e sia ancora interessato alla risposta, ora c'è un'altra opzione che espone ImmutableArray<T> . Questi sono alcuni punti per cui penso che sia meglio di IEnumerable<T> o ReadOnlyCollection<T> :

• afferma chiaramente che è immutabile (API espressiva)
• afferma chiaramente che la raccolta è già stata formata (in altre parole non è inizializzata pigramente ed è OK per itarlo ripetutamente più volte)
• se il conteggio degli elementi è noto, non nasconde che knowlegde come IEnumerable<T> fa
• poiché il client non sa quale sia l'implementazione di IEnumerable o IReadOnlyCollect lui / lei non può presumere che non cambi mai (in altre parole non è garantito che gli elementi di una collezione non siano stati modificati mentre si fa riferimento a quella raccolta rimane invariata)

Anche se APi ha bisogno di notificare al client le modifiche nella collezione, esporrò un evento come membro separato.

Tieni presente che non sto dicendo che IEnumerable<T> non sia valido in generale. Lo userei ancora quando si passa la raccolta come argomento o si restituisce una raccolta inizializzata pigramente (in questo caso particolare ha senso nascondere il conteggio degli oggetti perché non è ancora noto).