ReadOnlyCollection atau IEnumerable untuk mengekspos koleksi anggota?

Apakah ada alasan untuk mengekspos koleksi internal sebagai ReadOnlyCollection daripada IEnumerable jika kode panggilan hanya mengulang koleksi?

class Bar
{
    private ICollection<Foo> foos;

    // Which one is to be preferred?
    public IEnumerable<Foo> Foos { ... }
    public ReadOnlyCollection<Foo> Foos { ... }
}


// Calling code:

foreach (var f in bar.Foos)
    DoSomething(f);

Seperti yang saya lihat, IEnumerable adalah bagian dari antarmuka ReadOnlyCollection dan tidak memungkinkan pengguna untuk mengubah koleksi. Jadi jika antarmuka IEnumberable sudah cukup maka itulah yang akan digunakan. Apakah itu cara yang tepat untuk menalarinya atau apakah saya melewatkan sesuatu?

Terima kasih / Erik

Solusi yang lebih modern

Kecuali jika Anda memerlukan koleksi internal yang dapat diubah, Anda dapat menggunakan System.Collections.Immutablepaket, mengubah jenis bidang Anda menjadi koleksi yang tidak dapat diubah, dan kemudian mengeksposnya secara langsung - dengan asumsi Fooitu sendiri tidak dapat diubah, tentu saja.

Jawaban yang diperbarui untuk menjawab pertanyaan secara lebih langsung

Apakah ada alasan untuk mengekspos koleksi internal sebagai ReadOnlyCollection daripada IEnumerable jika kode panggilan hanya mengulang koleksi?

Itu tergantung pada seberapa besar Anda mempercayai kode panggilan. Jika Anda memegang kendali penuh atas semua yang akan memanggil anggota ini dan Anda menjamin bahwa kode tidak akan pernah digunakan:

ICollection<Foo> evil = (ICollection<Foo>) bar.Foos;
evil.Add(...);

Maka pasti, tidak ada salahnya jika Anda langsung mengembalikan koleksinya. Saya biasanya mencoba menjadi sedikit lebih paranoid dari itu.

Demikian juga, seperti yang Anda katakan: jika Anda hanya perlu IEnumerable<T> , lalu mengapa mengikatkan diri Anda pada sesuatu yang lebih kuat?

Jawaban asli

Jika Anda menggunakan .NET 3.5, Anda dapat menghindari membuat salinan dan menghindari transmisi sederhana dengan menggunakan panggilan sederhana ke Lewati:

public IEnumerable<Foo> Foos {
    get { return foos.Skip(0); }
}

(Ada banyak opsi lain untuk membungkus secara sepele - hal yang menyenangkan tentang Skip over Select / Where adalah bahwa tidak ada delegasi yang dieksekusi tanpa tujuan untuk setiap iterasi.)

Jika Anda tidak menggunakan .NET 3.5 Anda dapat menulis pembungkus yang sangat sederhana untuk melakukan hal yang sama:

public static IEnumerable<T> Wrapper<T>(IEnumerable<T> source)
{
    foreach (T element in source)
    {
        yield return element;
    }
}

Jika Anda hanya perlu mengulang melalui koleksi:

foreach (Foo f in bar.Foos)

maka mengembalikan IEnumerable sudah cukup.

Jika Anda membutuhkan akses acak ke item:

Foo f = bar.Foos[17];

lalu bungkus dalam ReadOnlyCollection .

Jika Anda melakukan ini maka tidak ada yang menghentikan pemanggil Anda mentransmisikan IEnumerable kembali ke ICollection dan kemudian memodifikasinya. ReadOnlyCollection menghilangkan kemungkinan ini, meskipun masih memungkinkan untuk mengakses koleksi yang dapat ditulis melalui refleksi. Jika koleksinya kecil maka cara yang aman dan mudah untuk mengatasi masalah ini adalah dengan mengembalikan salinannya.

Saya menghindari penggunaan ReadOnlyCollection sebanyak mungkin, ini sebenarnya jauh lebih lambat daripada hanya menggunakan Daftar biasa. Lihat contoh ini:

List<int> intList = new List<int>();
        //Use a ReadOnlyCollection around the List
        System.Collections.ObjectModel.ReadOnlyCollection<int> mValue = new System.Collections.ObjectModel.ReadOnlyCollection<int>(intList);

        for (int i = 0; i < 100000000; i++)
        {
            intList.Add(i);
        }
        long result = 0;

        //Use normal foreach on the ReadOnlyCollection
        TimeSpan lStart = new TimeSpan(System.DateTime.Now.Ticks);
        foreach (int i in mValue)
            result += i;
        TimeSpan lEnd = new TimeSpan(System.DateTime.Now.Ticks);
        MessageBox.Show("Speed(ms): " + (lEnd.TotalMilliseconds - lStart.TotalMilliseconds).ToString());
        MessageBox.Show("Result: " + result.ToString());

        //use <list>.ForEach
        lStart = new TimeSpan(System.DateTime.Now.Ticks);
        result = 0;
        intList.ForEach(delegate(int i) { result += i; });
        lEnd = new TimeSpan(System.DateTime.Now.Ticks);
        MessageBox.Show("Speed(ms): " + (lEnd.TotalMilliseconds - lStart.TotalMilliseconds).ToString());
        MessageBox.Show("Result: " + result.ToString());

Terkadang Anda mungkin ingin menggunakan antarmuka, mungkin karena Anda ingin mengejek koleksi selama pengujian unit. Silakan lihat entri blog saya untuk menambahkan antarmuka Anda sendiri ke ReadonlyCollection dengan menggunakan adaptor.