IList <T> 대신 항상 IEnumerable <T>를 반환해야합니까?


98

항목 집합을 반환하는 DAL 또는 기타 코드를 작성할 때 항상 return 문을 작성해야합니다.

public IEnumerable<FooBar> GetRecentItems()

또는

public IList<FooBar> GetRecentItems()

현재 내 코드에서 가능한 한 IEnumerable을 사용하려고 시도했지만 이것이 최상의 방법인지 확실하지 않습니까? 내가하는 일에 대해 설명하면서 가장 일반적인 데이터 유형을 반환했기 때문에 옳은 것 같았지만 아마도 이것은 옳지 않을 것입니다.


1
당신이 묻는 것이 List <T> 또는 IList <T>입니까? 제목과 질문은 다른 것을 말합니다 ...
Fredrik Mörk 2009-07-02

가능한 한 사용자 인터페이스 IEnumerable 또는 Ilist instaead of concerete type.
Usman Masood

2
컬렉션을 List <T>로 반환합니다. I는 반환 할 필요가 표시되지 않습니다 IEnumberable <T> 당신은 목록 <T>에서 그것을 추출 할 수 있기 때문에
척 콘웨이


답변:


45

특정 인터페이스를 사용하는 이유에 따라 다릅니다.

예를 들어 IList<T>에는에없는 여러 메서드가 있습니다 IEnumerable<T>.

  • IndexOf(T item)
  • Insert(int index, T item)
  • RemoveAt(int index)

및 속성 :

  • T this[int index] { get; set; }

어떤 식 으로든 이러한 메소드가 필요하면 반드시을 반환하십시오 IList<T>.

또한 IEnumerable<T>결과를 사용 하는 메서드 가를 예상하는 IList<T>경우 필요한 변환을 고려하지 않아도 CLR이 저장되므로 컴파일 된 코드가 최적화됩니다.


2
@Jon FDG는 Collection <T> 또는 ReadOnlyCollection <T>를 컬렉션 유형의 반환 값으로 사용하는 것이 좋습니다.
Sam Saffron

"CLR을 저장합니다"라고 말했을 때 마지막 문장에서 의미하는 바가 명확하지 않습니다. IEnumerable 대 IList를 사용하여 무엇을 저장합니까? 더 명확하게 할 수 있습니까?
PositiveGuy

1
@CoffeeAddict이 답변이 나온 지 3 년이 지난 후 저는 당신이 옳다고 생각합니다. 마지막 부분은 모호합니다. IList <T>를 매개 변수로 예상하는 메서드가 IEnumerable <T>를 가져 오면 IEnumerable을 새 List <T> 또는 다른 IList <T> 구현 자에 수동으로 래핑해야하며 해당 작업은 다음에서 수행되지 않습니다. 당신을위한 CLR. 반대 -를 IEnumerable <T>를 기대하는 방법은 IList <T>를 받고는, 일부 언 박싱을해야하지만 돌이켜 보면 이유로 인해 사용은 IList <T> 구현을 IEnumerable <T>에 필요하지 않을 수도 있습니다.
존 Limjap

69

프레임 워크 디자인 지침에서는 호출자가 수정할 수있는 컬렉션을 반환해야 할 때 Collection 클래스를 사용 하거나 읽기 전용 컬렉션에 대해 ReadOnlyCollection 을 사용할 것을 권장합니다 .

이 간단한 선호되는 이유는 IListIList자신 만 여부를 읽으면 발신자에게 통보하지 않습니다.

대신를 반환 IEnumerable<T>하면 호출자가 수행하기 위해 특정 작업이 약간 까다로울 수 있습니다. 또한 더 이상 호출자에게 컬렉션을 수정할 수있는 유연성을 제공하지 않아도됩니다.

LINQ에는 몇 가지 트릭이 포함되어 있으며 수행되는 유형에 따라 특정 호출을 최적화합니다. 예를 들어를 수행 Count하고 기본 컬렉션이 List 인 경우 모든 요소를 ​​살펴 보지 않습니다.

개인적으로 ORM의 경우 아마도 Collection<T>반환 값으로 고수 할 것입니다 .


14
컬렉션에 대한 가이드 라인 DOS와 DONTs에 대한 자세한 목록이 포함되어 있습니다.
Chaquotay

27

일반적으로 가장 일반적인 것을 요구하고 가능한 가장 구체적인 것을 반환해야합니다. 따라서 매개 변수를 사용하는 메서드가 있고 IEnumerable에서 사용할 수있는 것만 실제로 필요한 경우 매개 변수 유형이되어야합니다. 메서드가 IList 또는 IEnumerable을 반환 할 수있는 경우 IList를 반환하는 것이 좋습니다. 이를 통해 가장 광범위한 소비자가 사용할 수 있습니다.

필요한 것은 느슨하고 제공하는 것은 명시하십시오.


1
나는 반대 결론에 이르렀다 : 특정 유형을 받아들이고 일반 유형을 반환해야한다는 것이다. 그러나 더 광범위하게 적용 가능한 방법이 더 제한된 방법보다 낫다는 것이 맞을 수 있습니다. 나는 이것에 대해 더 생각해야 할 것입니다.
Dave Cousineau 2011 년

3
일반 유형을 입력으로 받아들이는 이유는 구성 요소에서 최대한 많은 재사용을 얻기 위해 가능한 가장 광범위한 입력 범위로 작업 할 수 있다는 것입니다. 반면에 어떤 종류의 물건을 가지고 있는지 이미 정확히 알고 있기 때문에 마스킹 할 필요가 없습니다.
Mel

1
나는 더 일반적인 매개 변수를 갖는 것에 동의한다고 생각하지만 덜 일반적인 것을 반환하는 이유는 무엇입니까?
Dave Cousineau 2011 년

7
좋아요, 다른 방법으로 시도해 보겠습니다. 왜 정보를 버리겠습니까? IEnumerable <T> 결과에만 관심이 있다면 IList <T>라는 사실을 알면 어떤 식 으로든 상처를 입습니까? 아니요, 그렇지 않습니다. 어떤 경우에는 불필요한 정보가 될 수 있지만 해를 끼치 지 않습니다. 이제 이익을 위해. List 또는 IList를 반환하면 IEnumerable로는 알 수없는 컬렉션이 이미 검색되었음을 즉시 알 수 있습니다. 이것은 유용한 정보 일 수도 있고 아닐 수도 있지만 다시 한 번 정보를 버리는 이유는 무엇입니까? 무언가에 대한 추가 정보를 알고 있다면 전달하십시오.
Mel

돌이켜 보면 아무도 저에게 전화를 걸지 않았다는 사실에 놀랐습니다. IEnumerable WOULD가 이미 검색되었습니다. 그러나 IQueryable은 열거되지 않은 상태로 반환 될 수 있습니다. 따라서 더 나은 예는 IQueryable 대 IEnumerable을 반환하는 것입니다. 보다 구체적인 IQueryable을 반환하면 추가 구성이 가능하지만 IEnumerable을 반환하면 즉각적인 열거가 강제되고 메서드의 구성 가능성이 감소합니다.
Mel

23

조건에 따라서...

가장 적게 파생 된 유형 ( IEnumerable)을 반환하면 기본 구현을 트랙 아래로 변경할 수있는 여지가 가장 많습니다.

더 파생 된 유형 ( IList)을 반환하면 API 사용자에게 결과에 대한 더 많은 작업이 제공됩니다.

사용자가 필요로하는 모든 작업을 포함하는 가장 적게 파생 된 유형을 반환하는 것이 좋습니다. 기본적으로 정의하는 API의 컨텍스트에서 결과에 대해 어떤 작업이 의미가 있는지 먼저 결정해야합니다.


다른 방법에도 적용되므로 좋은 일반적인 대답.
user420667

1
이 답변이 매우 오래되었다는 것을 알고 있지만 문서와 모순되는 것 같습니다. "IDictionary <TKey, TValue> 인터페이스 나 IList <T> 인터페이스가 필요한 컬렉션의 요구 사항을 충족하지 않으면 다음에서 새 컬렉션 클래스를 파생합니다. 더 많은 유연성을 위해 ICollection <T> 인터페이스 대신 "이것은 파생 된 형식이 더 선호되어야 함을 의미하는 것 같습니다. ( msdn.microsoft.com/en-us/library/92t2ye13(v=vs.110).aspx ) \
DeborahK

11

한 가지 고려해야 할 점은 지연 실행 LINQ 문을 사용하여을 생성하는 경우 메서드에서 반환하기 전에 IEnumerable<T>호출 .ToList()하면 항목이 두 번 반복 될 수 있다는 것입니다. 한 번은 List를 만들고 한 번은 호출자가 반복 할 때입니다. , 필터링 또는 반환 값을 변환합니다. 가능한 경우 LINQ-to-Objects의 결과를해야 할 때까지 구체적인 목록이나 사전으로 변환하지 않는 것이 좋습니다. 내 호출자가 List를 필요로한다면, 그것은 하나의 쉬운 메서드 호출입니다.-나는 그들을 위해 결정을 내릴 필요가 없으며, 호출자가 foreach를 수행하는 경우에 내 코드를 약간 더 효율적으로 만듭니다.


@Joel Mueller, 나는 일반적으로 어쨌든 ToList ()를 호출합니다. 나는 일반적으로 IQueryable을 나머지 프로젝트에 노출하는 것을 좋아하지 않습니다.
KingNestor

4
나는 IQueryable이 일반적으로 그림에 들어 가지 않는 LINQ-to-Objects에 대해 더 많이 언급했습니다. 데이터베이스가 관련되면 ToList ()가 더 필요해집니다. 그렇지 않으면 반복하기 전에 연결을 닫을 위험이 있으므로 잘 작동하지 않습니다. 그러나 이것이 문제가되지 않는 경우 IQueryable을 숨기고 싶을 때 추가 반복을 강요하지 않고 IQueryable을 IEnumerable로 노출하는 것은 매우 쉽습니다.
Joel Mueller

9

List<T>반환 된 객체 수정 및 색인 별 액세스와 같은 더 많은 기능을 호출 코드에 제공합니다. 따라서 질문은 다음과 같이 요약됩니다. 애플리케이션의 특정 사용 사례에서 이러한 사용을 지원 하시겠습니까 (아마 새로 생성 된 컬렉션을 반환하여), 호출자의 편의를 위해-또는 모든 경우에 간단한 사례에 대한 속도를 원합니까? 호출자 요구 사항은 컬렉션을 반복하는 것이며 잘못 변경되는 등의 걱정없이 실제 기본 컬렉션에 대한 참조를 안전하게 반환 할 수 있습니까?

오직 당신 만이이 질문에 답할 수 있습니다. 그리고 당신의 호출자가 반환 값으로 무엇을하고 싶어하는지, 그리고 여기에서 성능이 얼마나 중요한지를 잘 이해해야 만 대답 할 수 있습니다 (복사 할 컬렉션의 크기, 이것이 병목 현상이 될 가능성, 기타).


"실제 기본 컬렉션에 대한 참조를 안전하게 반환하면 잘못 변경 될 염려가 없습니다."-IEnumerable <T>를 반환하더라도 단순히 List <T>로 다시 캐스팅하고 변경할 수는 없습니까?
Kobi

모든 IEnumarable <T>도 List <T> 인 것은 아닙니다. 반환 된 개체가 List <T>에서 상속 된 형식이 아니거나 IList <T>를 구현하는 경우 InvalidCastException이 발생합니다.
lowglider

2
List <T>에는 특정 구현에 묶여 있다는 문제가 있습니다. Collection <T> 또는 ReadOnlyCollection <T>가 선호됩니다
Sam Saffron

4

둘 중 하나를 사용할 수 있다고 생각하지만 각각 용도가 있습니다. 기본적으로 ListIEnumerable기능 이 있지만 요소 추가, 요소 제거

IEnumerable은 요소 계산에 효율적이지 않습니다.

컬렉션이 읽기 전용이거나 컬렉션의 수정이에 의해 제어되는 Parent경우 IListjust for 를 반환하는 Count것은 좋은 생각이 아닙니다.

Linq 에는 기본 유형이 인 경우 CLR 내부에 바로 가기 가 적용되는 Count()확장 메서드 가 있으므로 성능 차이는 무시할 수 있습니다.IEnumerable<T>.CountIList

일반적으로 나는 (의견) 당신이 다음 추가를 할 부모 클래스에 이러한 방법을 추가해야하는 경우 예를 들어, 그렇지 않으면 소비자가 다음의 원칙을 위반하는 모델 내에서 컬렉션을 관리하고, 수는 IEnumerable을 반환하는 더 나은 방법입니다 느낌 manufacturer.Models.Add(model)의 법을 위반 데메테르. 물론 이것은 지침 일 뿐이며 엄격하고 빠른 규칙은 아니지만 적용 가능성을 완전히 파악할 때까지 맹목적으로 따르는 것이 아예 따르지 않는 것보다 낫습니다.

public interface IManufacturer 
{
     IEnumerable<Model> Models {get;}
     void AddModel(Model model);
}

(참고 : nNHibernate를 사용하는 경우 다른 접근자를 사용하여 개인 IList에 매핑해야 할 수 있습니다.)


2

입력 매개 변수 대신 반환 값에 대해 이야기 할 때 그렇게 간단하지 않습니다. 입력 매개 변수 인 경우 수행해야 할 작업을 정확히 알고 있습니다. 따라서 컬렉션을 반복 할 수 있어야하는 경우 IEnumberable을 사용하고 추가하거나 제거해야하는 경우 IList를 사용합니다.

반환 값의 경우 더 어렵습니다. 발신자는 무엇을 기대합니까? IEnumerable을 반환하면 IList를 만들 수 있다는 사전 정보를 알 수 없습니다. 그러나 IList를 반환하면 그는 그것을 반복 할 수 있다는 것을 알게 될 것입니다. 따라서 호출자가 데이터로 무엇을 할 것인지 고려해야합니다. 호출자가 필요로 / 기대하는 기능은 반환 할 항목을 결정할 때 결정해야하는 사항입니다.


0

모두가 말했듯이 호출 레이어에서 기능 추가 / 제거를 원하지 않으면 디자인 전향에서 좋아하는 반복 및 기본 기능 만 제공하므로 IEnumerable에 투표합니다. IList를 반환하면 내 투표는 항상 반복되지만 주로 당신이 좋아하는 것과 그렇지 않은 것입니다. 성능 측면에서 나는 그들이 더 동일하다고 생각합니다.


0

외부 코드에서 계산하지 않는 경우 항상 IEnumerable을 반환하는 것이 좋습니다. 왜냐하면 나중에 반복기 논리 를 생성 하고 메모리 리소스를 절약 하기 위해 (외부 코드 영향없이) 구현을 변경할 수 있기 때문입니다 (매우 좋은 언어 기능). ).

그러나 항목 개수가 필요한 경우 IEnumerable과 IList- ICollection 사이에 또 ​​다른 레이어가 있다는 것을 잊지 마십시오 .


0

지금까지 다른 사람이 제안하지 않은 것을 알았을 때 여기에서 약간 벗어 났을 수 있습니다.하지만 왜 반환하지 (I)Collection<T>않습니까?

내가 기억하는 바로 는 구현을 추상화하기 때문에 Collection<T>선호되는 반환 유형이었습니다 List<T>. 그들은 모두를 구현 IEnumerable하지만 그 작업에는 너무 낮은 수준으로 들립니다.


0

둘 중 하나를 사용할 수 있다고 생각하지만 각각 용도가 있습니다. 기본적으로 ListIEnumerable기능 이 있지만 요소 추가, 요소 제거

IEnumerable 요소를 계산하거나 컬렉션의 특정 요소를 가져 오는 데 효율적이지 않습니다.

List 특정 요소를 찾고, 요소를 쉽게 추가하거나 제거 할 수있는 이상적인 컬렉션입니다.

일반적으로 List더 많은 유연성을 제공하므로 가능한 한 사용하려고 합니다.

List<FooBar> getRecentItems() 대신 사용 IList<FooBar> GetRecentItems()


0

일반적인 규칙은 불필요한 작업을 피하고 발신자에게 더 많은 옵션을 제공하기 위해 더 구체적인 클래스를 사용하여 반환하는 것입니다.

즉, 다음 사람이 작성할 코드보다 앞에있는 코드를 고려하는 것이 더 중요하다고 생각합니다. 이는 이미 존재하는 코드에 대해 가정을 할 수 있기 때문입니다.

인터페이스의 IEnumerable에서 컬렉션으로 UP을 이동하면 작동하고, 컬렉션에서 IEnumerable로 이동하면 기존 코드가 손상됩니다.

이러한 의견이 모두 상충되는 것처럼 보이면 결정이 주관적이기 때문입니다.


0

TL; DR; - 요약

  • 사내 소프트웨어를 개발하는 경우 특정 유형 (Like List 반환 값 )을 사용하고 컬렉션의 경우에도 입력 매개 변수에는 가장 일반적인 유형을 사용하십시오.
  • 메서드가 재배포 가능한 라이브러리의 공용 API의 일부인 경우 구체적인 컬렉션 형식 대신 인터페이스를 사용하여 반환 값과 입력 매개 변수를 모두 도입하십시오.
  • 메서드가 읽기 전용 컬렉션을 반환하는 경우 IReadOnlyList또는 IReadOnlyCollection반환 값 형식으로 사용하여 표시합니다 .

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.