속성 디자인
참고 항목
이 콘텐츠는 Pearson Education, Inc.의 허가를 받아 프레임워크 디자인 지침: 재사용 가능한 .NET 라이브러리에 대한 규칙, 관용어 및 패턴, 2판에서 재인쇄되었습니다. 이 버전은 2008년에 출판되었으며 이후 3판에서 완전히 개정되었습니다. 이 페이지의 정보 중 일부는 최신 정보가 아닐 수 있습니다.
속성은 기술적으로 메서드와 매우 유사하지만 사용 시나리오 측면에서는 전혀 다릅니다. 속성은 스마트 필드로 표시되어야 합니다. 속성에는 필드의 호출 구문과 메서드의 유연성이 있습니다.
✔️ 호출자가 속성의 값을 변경할 수 없어야 하는 경우 가져오기 전용 속성을 만드세요.
속성의 형식이 변경 가능한 참조 형식이면 속성이 가져오기 전용인 경우에도 속성 값을 변경할 수 있습니다.
❌ 설정 전용 속성 또는 setter의 접근성이 getter보다 더 광범위한 속성을 제공하지 마세요.
예를 들어 퍼블릭 setter 및 보호된 getter가 있는 속성을 사용하지 마세요.
속성 getter를 제공할 수 없는 경우 대신 메서드로 기능을 구현하세요. 메서드 이름을 Set으로 시작하고 속성의 이름을 지정한 항목을 사용하는 것이 좋습니다. 예를 들어 AppDomain에는 CachePath라는 설정 전용 속성 대신 SetCachePath라는 메서드가 있습니다.
✔️ 모든 속성에 적절한 기본값을 제공하여 기본값으로 인해 보안 허점이나 매우 비효율적인 코드가 생성되지 않도록 하세요.
✔️ 개체의 상태가 일시적으로 잘못되게 되더라도 속성을 원하는 순서대로 설정할 수 있도록 하세요.
일반적으로 동일한 개체에서 다른 속성의 값을 지정하면 한 속성의 일부 값이 잘못될 수 있는 지점에서 둘 이상의 속성이 서로 관련될 수 있습니다. 이러한 경우 잘못된 상태에서 발생한 예외는 서로 관련된 속성이 실제로 개체에서 함께 사용될 때까지 연기되어야 합니다.
✔️ 속성 setter에서 예외가 throw되는 경우 이전 값을 유지하세요.
❌ 속성 getter에서 예외를 throw하면 안 됩니다.
속성 getter는 간단한 작업이어야 하며 사전 조건이 없어야 합니다. getter에서 예외가 throw될 수 있으면 메서드로 다시 디자인해야 할 수 있습니다. 인수 유효성 검사의 결과로 예외가 예상되는 인덱서에는 이 규칙이 적용되지 않습니다.
인덱싱된 속성 디자인
인덱싱된 속성은 매개 변수를 포함할 수 있고 배열 인덱싱과 유사한 특수 구문으로 호출할 수 있는 특수 속성입니다.
인덱싱된 속성을 일반적으로 인덱서라고 합니다. 인덱서는 논리 컬렉션의 항목에 대한 액세스 권한을 제공하는 API에서만 사용해야 합니다. 예를 들어 문자열은 문자의 컬렉션이며 System.String의 인덱서는 해당 문자에 액세스하기 위해 추가되었습니다.
✔️ 내부 배열에 저장된 데이터에 대한 액세스 권한을 제공하려면 인덱서를 사용하는 것이 좋습니다.
✔️ 항목의 컬렉션을 나타내는 형식에서 인덱서를 제공하는 것이 좋습니다.
❌ 둘 이상의 매개 변수가 있는 인덱싱된 속성을 사용하면 안 됩니다.
여러 매개 변수가 필요한 디자인에서는 속성이 실제로 논리 컬렉션에 대한 접근자를 나타내는지를 확인해야 합니다. 그렇지 않은 경우 메서드를 대신 사용합니다. 메서드 이름은 Get 또는 Set으로 시작하는 것이 좋습니다.
❌System.Int32, System.Int64, System.String, System.Object 또는 열거형 이외의 매개 변수 형식을 사용하는 인덱서는 사용하면 안 됩니다.
다른 형식의 매개 변수가 필요한 디자인에서는 API가 실제로 논리 컬렉션에 대한 접근자를 나타내는지를 강력히 다시 평가해야 합니다. 그렇지 않은 경우 메서드를 사용하세요. 메서드 이름은 Get 또는 Set으로 시작하는 것이 좋습니다.
✔️ 명백하게 더 좋은 이름(예: System.String의 Chars[] 속성 참조)이 없는 경우 인덱싱된 속성에 이름 Item을 사용하세요.
C#에서는 인덱서 이름이 기본적으로 Item으로 지정됩니다. IndexerNameAttribute를 사용하여 이 이름을 사용자 지정할 수 있습니다.
❌ 의미 체계가 동일한 인덱서와 메서드를 둘 다 제공하지 마세요.
❌ 한 형식에서 오버로드된 인덱서 패밀리를 둘 이상 제공하지 마세요.
이 규칙은 C# 컴파일러에서 적용됩니다.
❌ 기본값이 아닌 인덱싱된 속성을 사용하지 마세요.
이 규칙은 C# 컴파일러에서 적용됩니다.
속성 변경 알림 이벤트
경우에 따라 속성 값의 변경을 사용자에게 알리는 이벤트를 제공하면 도움이 됩니다. 예를 들어 Text 속성 값이 변경된 후 System.Windows.Forms.Control에서 TextChanged 이벤트가 발생합니다.
✔️ 상위 수준 API(일반적으로 디자이너 구성 요소)에서 속성 값이 수정되면 변경 알림 이벤트를 발생시키는 것이 좋습니다.
개체의 속성이 변경될 때 사용자가 알아야 하는 좋은 시나리오가 있는 경우 개체는 속성에 대해 변경 알림 이벤트를 발생시켜야 합니다.
그러나 기본 형식이나 컬렉션과 같은 하위 수준 API에 대해 이러한 이벤트를 발생시키면 오버헤드가 될 가능성이 없습니다. 예를 들어 새 항목이 목록에 추가되고 Count 속성이 변경되면 List<T>에서 이러한 이벤트를 발생시키지 않습니다.
✔️ 속성 값이 외부의 힘에 의해 변경되는 경우에는 변경 알림 이벤트를 발생시키는 것이 좋습니다.
속성 값이 일부 외부의 힘(개체에서 메서드를 호출하는 것 이외의 방식)을 통해 변경되는 경우 이벤트 발생은 값이 변경되고 있고 변경되었음을 개발자에게 표시합니다. 좋은 예로 텍스트 상자 컨트롤의 Text 속성이 있습니다. 사용자가 TextBox에 텍스트를 입력하면 속성 값이 자동으로 변경됩니다.
Portions © 2005, 2009 Microsoft Corporation. All rights reserved.
Pearson Education, Inc의 동의로 재인쇄. 출처: Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition 작성자: Krzysztof Cwalina 및 Brad Abrams, 출판 정보: Oct 22, 2008 by Addison-Wesley Professional as part of the Microsoft Windows Development Series.