Trả lại 'IList' vs 'ICollection' vs 'Bộ sưu tập'

Tôi bối rối về loại bộ sưu tập mà tôi nên trả về từ các phương thức và thuộc tính API công khai của mình.

Các bộ sưu tập mà tôi có trong tâm trí là IList, ICollectionvà Collection.

Việc trả lại một trong những loại này luôn được ưu tiên hơn những loại khác hay nó phụ thuộc vào tình hình cụ thể?

Nói chung, bạn nên trả về một kiểu càng chung chung càng tốt, tức là một kiểu biết vừa đủ dữ liệu trả về mà người tiêu dùng cần sử dụng. Bằng cách đó, bạn có nhiều quyền tự do hơn để thay đổi việc triển khai API mà không vi phạm mã đang sử dụng nó.

Cũng xem xét IEnumerable<T>giao diện như kiểu trả lại. Nếu kết quả chỉ được lặp lại, người tiêu dùng không cần nhiều hơn thế.

ICollection<T>là một giao diện đó cho thấy nhiều ngữ nghĩa bộ sưu tập như Add(), Remove(), và Count.

Collection<T>là một triển khai cụ thể của ICollection<T>giao diện.

IList<T>về cơ bản là một ICollection<T>với quyền truy cập dựa trên thứ tự ngẫu nhiên.

Trong trường hợp này, bạn nên quyết định xem kết quả của mình có yêu cầu ngữ nghĩa danh sách như lập chỉ mục dựa trên thứ tự (sau đó sử dụng IList<T>) hay không hoặc bạn chỉ cần trả về một "túi" kết quả không có thứ tự (sau đó sử dụng ICollection<T>).

Sự khác biệt chính giữa IList<T>và ICollection<T>là IList<T>cho phép bạn truy cập các phần tử thông qua một chỉ mục. IList<T>mô tả các kiểu giống mảng. Các phần tử trong một ICollection<T>chỉ có thể được truy cập thông qua phép liệt kê. Cả hai đều cho phép chèn và xóa các phần tử.

Nếu bạn chỉ cần liệt kê một bộ sưu tập, thì IEnumerable<T>bạn nên chọn. Nó có hai lợi thế so với những cái khác:

1. Nó không cho phép các thay đổi đối với bộ sưu tập (nhưng không cho phép các phần tử, nếu chúng thuộc loại tham chiếu).

2. Nó cho phép nhiều nguồn nhất có thể, bao gồm cả các bảng liệt kê được tạo theo thuật toán và hoàn toàn không phải là bộ sưu tập.

Collection<T>là một lớp cơ sở chủ yếu hữu ích cho những người triển khai các tập hợp. Nếu bạn hiển thị nó trong các giao diện (API), nhiều bộ sưu tập hữu ích không bắt nguồn từ nó sẽ bị loại trừ.

Một nhược điểm IList<T>là mảng thực hiện nó nhưng không cho phép bạn thêm hoặc bớt các mục (tức là bạn không thể thay đổi độ dài mảng). Một ngoại lệ sẽ được ném ra nếu bạn gọi IList<T>.Add(item)một mảng. Tình hình phần nào được xoa dịu vì IList<T>có thuộc tính Boolean IsReadOnlymà bạn có thể kiểm tra trước khi thử làm như vậy. Nhưng trong mắt tôi, đây vẫn là một lỗ hổng thiết kế trong thư viện . Do đó, tôi sử dụng List<T>trực tiếp, khi khả năng thêm hoặc bớt các mục được yêu cầu.

IList<T>là giao diện cơ sở cho tất cả các danh sách chung. Vì nó là một bộ sưu tập có thứ tự, nên việc triển khai có thể quyết định thứ tự, từ thứ tự đã sắp xếp đến thứ tự chèn. Hơn nữa, Ilistcó thuộc tính Item cho phép các phương thức đọc và chỉnh sửa các mục trong danh sách dựa trên chỉ mục của chúng. Điều này giúp bạn có thể chèn, xóa một giá trị vào / khỏi danh sách tại một chỉ mục vị trí.

Ngoài ra IList<T> : ICollection<T>, tất cả các phương pháp từ ICollection<T>cũng có sẵn ở đây để thực hiện.

ICollection<T>là giao diện cơ sở cho tất cả các tập hợp chung. Nó xác định kích thước, điều tra viên và phương pháp đồng bộ hóa. Bạn có thể thêm hoặc xóa một mục vào một bộ sưu tập nhưng bạn không thể chọn vị trí nó xảy ra do không có thuộc tính chỉ mục.

Collection<T>cung cấp một thực hiện cho IList<T>, IListvà IReadOnlyList<T>.

Nếu bạn sử dụng loại giao diện hẹp hơn, chẳng hạn như ICollection<T>thay vì IList<T>, bạn sẽ bảo vệ mã của mình khỏi những thay đổi vi phạm. Nếu bạn sử dụng một loại giao diện rộng hơn chẳng hạn IList<T>, bạn có nhiều nguy cơ bị phá vỡ các thay đổi mã hơn.

Trích dẫn từ một nguồn ,

ICollection, ICollection<T>: Bạn muốn sửa đổi bộ sưu tập hoặc bạn quan tâm đến kích thước của nó. IList, IList<T>: Bạn muốn sửa đổi bộ sưu tập và bạn quan tâm đến thứ tự và / hoặc vị trí của các phần tử trong bộ sưu tập.

Trả lại một loại giao diện chung chung hơn, vì vậy (thiếu thông tin thêm về trường hợp sử dụng cụ thể của bạn) tôi muốn hướng tới điều đó. Nếu bạn muốn hiển thị hỗ trợ lập chỉ mục, hãy chọn IList<T>, nếu không ICollection<T>sẽ đủ. Cuối cùng, nếu bạn muốn chỉ ra rằng các kiểu trả về chỉ được đọc, hãy chọn IEnumerable<T>.

Và, trong trường hợp bạn chưa đọc nó trước đây, Brad Abrams và Krzysztof Cwalina đã viết một cuốn sách tuyệt vời có tiêu đề "Hướng dẫn thiết kế khung: Quy ước, thành ngữ và mẫu cho thư viện .NET có thể tái sử dụng" (bạn có thể tải xuống bản tóm tắt từ đây ).

Có một số chủ đề xuất phát từ câu hỏi này:

• giao diện so với các lớp
• lớp cụ thể nào, từ một số lớp giống nhau, tập hợp, danh sách, mảng?
• Các lớp chung so với tập hợp con ("generics")

Bạn có thể muốn nhấn mạnh rằng API hướng đối tượng của nó

giao diện so với các lớp

Nếu bạn không có nhiều kinh nghiệm với các giao diện, tôi khuyên bạn nên theo học. Tôi thấy rất nhiều lần các nhà phát triển chuyển sang giao diện, ngay cả khi nó không phải là hoàn toàn khác.

Và, hãy chấm dứt việc thiết kế giao diện kém, thay vào đó là một thiết kế lớp tốt, nhân tiện, cuối cùng có thể được chuyển sang một thiết kế giao diện tốt ...

Bạn sẽ thấy rất nhiều giao diện trong API, nhưng đừng vội sử dụng nó, nếu bạn không cần.

Cuối cùng, bạn sẽ học cách áp dụng các giao diện vào mã của mình.

lớp cụ thể nào, từ một số lớp giống nhau, tập hợp, danh sách, mảng?

Có một số lớp trong c # (dotnet) có thể được hoán đổi cho nhau. Như đã đề cập, nếu bạn cần thứ gì đó từ một lớp cụ thể hơn, chẳng hạn như "CanBeSortedClass", thì hãy làm cho nó rõ ràng trong API của bạn.

Người dùng API của bạn có thực sự cần biết rằng lớp của bạn có thể được sắp xếp hay áp dụng một số định dạng cho các phần tử không? Sau đó sử dụng "CanBeSortedClass" hoặc "ElementsCanBePaintedClass", nếu không thì sử dụng "GenericBrandClass".

Nếu không, hãy sử dụng một lớp tổng quát hơn.

Các lớp tập hợp chung so với tập hợp con ("generics")

Bạn sẽ thấy rằng có những lớp chứa các phần tử khác và bạn có thể chỉ định rằng tất cả các phần tử phải thuộc một loại cụ thể.

Bộ sưu tập Chung là những lớp mà bạn có thể sử dụng cùng một bộ sưu tập, cho một số ứng dụng mã, mà không cần phải tạo một bộ sưu tập mới, cho mỗi loại subitem mới, như sau: Bộ sưu tập .

Người dùng API của bạn có cần một loại rất cụ thể, giống nhau cho tất cả các phần tử không?

Sử dụng một cái gì đó như List<WashingtonApple>.

Người dùng API của bạn có cần một số loại liên quan không?

Vạch trần List<Fruit>cho API của bạn, và sử dụng List<Orange> List<Banana>, List<Strawberry>trong nội bộ, nơi Orange, Bananavà Strawberrylà hậu duệ từ Fruit.

Người dùng API của bạn có cần một bộ sưu tập kiểu chung không?

Sử dụng List, nơi có object(các) mục.

Chúc mừng.