DependencyObject의 안전한 생성자 패턴

아티클
05/04/2023

일반적으로 클래스 생성자는 가상 메서드나 대리자와 같은 콜백을 호출하면 안 됩니다. 이는 생성자는 파생 클래스에 대한 생성자의 기본 초기화로 호출될 수 있기 때문입니다. 특정 개체의 불완전한 초기화 상태에서 가상 항목이 입력될 수 있습니다. 하지만 속성 시스템 자체는 내부적으로 콜백을 종속성 속성 시스템의 일부로 호출하고 표시합니다. 확인 과정에서 발생하는 콜백은 SetValue 호출을 통해 종속성 속성 값을 설정하는 것과 같은 간단한 작업에 포함될 수 있습니다. 이런 이유로 생성자 본문에서 종속성 속성 값을 설정할 때 주의해야 합니다. 형식이 기본 클래스로 사용될 경우 문제가 발생할 수 있습니다. 여기서 설명되는 종속성 속성 상태 및 고유 콜백과 관련된 특정 문제를 피하는 DependencyObject 생성자를 구현할 수 있는 특정 패턴이 있습니다.

속성 시스템 가상 메서드

종속성 속성을 설정하는 SetValue 호출을 계산하는 동안 다음 가상 메서드 또는 콜백이 잠재적으로 호출됩니다. ValidateValueCallback, PropertyChangedCallback, CoerceValueCallback, OnPropertyChanged. 이러한 각 가상 메서드 또는 콜백은 Windows Presentation Foundation(WPF) 속성 시스템 및 종속성 속성의 다양성을 확장하기 위한 특정 목적으로 사용됩니다. 이러한 가상 항목을 사용하여 속성 값 확인을 사용자 지정하는 방법에 대한 자세한 내용은 종속성 속성 콜백 및 유효성 검사를 참조하세요.

FXCop 규칙 적용과 속성 시스템 가상 비교

Microsoft 도구 FXCop를 빌드 프로세스에 사용하고 기본 생성자를 호출하는 특정 WPF 프레임워크 클래스에서 파생시키거나 파생 클래스에서 자체 종속성 속성을 구현할 경우 특정 FXCop 규칙 위반이 발생할 수 있습니다. 이 위반에 대한 이름 문자열은 다음과 같습니다.

DoNotCallOverridableMethodsInConstructors

이 규칙은 FXCop에 대해 설정된 기본 공용 규칙의 일부입니다. 이 규칙은 최종적으로 종속성 속성 시스템 가상 메서드를 호출하는 종속성 속성 시스템을 통한 추적을 보고할 수 있습니다. 이 규칙 위반은 이 항목에 설명된 권장 생성자 패턴을 따른 후에도 계속 표시될 수 있으므로 FXCop 규칙 집합 구성에서 해당 규칙을 사용하지 않도록 설정하거나 억제해야 할 수 있습니다.

대부분 문제는 기존 클래스를 사용하지 않고 클래스를 파생시킬 경우 발생함

이 규칙을 통해 보고된 문제는 생성 시퀀스에서 가상 메서드를 사용하여 구현하는 클래스가 파생될 때 발생합니다. 클래스를 봉인할 경우 또는 클래스가 파생되지 않는지 알거나 파생되지 않도록 하는 경우에는 여기에 설명된 고려 사항과 FXCop 규칙을 유발한 문제가 적용되지 않습니다. 하지만 기본 클래스로 사용되도록 클래스를 작성할 경우(예: 템플릿 또는 확장 가능한 컨트롤 라이브러리 집합을 만들 경우) 여기서 권장된 생성자에 대한 패턴을 따라야 합니다.

기본 생성자는 콜백을 통해 요청된 모든 값을 초기화해야 함

해당 값 중 일부가 매개 변수 있는 생성자의 매개 변수를 통해 “실제” 값으로 채워질 경우에도 클래스 재정의 또는 콜백(속성 시스템 가상 항목 섹션의 목록에 있는 콜백)에서 사용되는 모든 인스턴스 멤버는 클래스 매개 변수 없는 생성자에서 초기화되어야 합니다.

다음 예제 코드(및 이후 예제)는 이 규칙을 위반하고 문제를 설명하는 의사 C# 예제입니다.

public class MyClass : DependencyObject  
{  
    public MyClass() {}  
    public MyClass(object toSetWobble)  
        : this()  
    {  
        Wobble = toSetWobble; //this is backed by a DependencyProperty  
        _myList = new ArrayList();    // this line should be in the default ctor  
    }  
    public static readonly DependencyProperty WobbleProperty =
        DependencyProperty.Register("Wobble", typeof(object), typeof(MyClass));  
    public object Wobble  
    {  
        get { return GetValue(WobbleProperty); }  
        set { SetValue(WobbleProperty, value); }  
    }  
    protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)  
    {  
        int count = _myList.Count;    // null-reference exception  
    }  
    private ArrayList _myList;  
}

애플리케이션 코드가 new MyClass(objectvalue)를 호출하면 매개 변수 없는 생성자 및 기본 클래스 생성자가 호출됩니다. 그 다음에 소유 MyClassDependencyObject에서 가상 메서드 OnPropertyChanged를 호출하는 Property1 = object1이 설정됩니다. 재정의는 아직 초기화되지 않은 _myList를 참조합니다.

이러한 문제를 피하는 한 가지 방법은 콜백이 기타 종속성 속성만 사용하고 각 종속성 속성에 설정된 기본값을 등록된 메타데이터로 포함하는지 확인하는 것입니다.

안전한 생성자 패턴

클래스가 기본 클래스로 사용될 경우 불완전한 초기화의 위험을 피하려면 다음 패턴을 따릅니다.

기본 초기화를 호출하는 매개 변수 없는 생성자

기본 기본값을 호출하는 다음 생성자를 구현합니다.

public MyClass : SomeBaseClass {  
    public MyClass() : base() {  
        // ALL class initialization, including initial defaults for
        // possible values that other ctors specify or that callbacks need.  
    }  
}

기본 시그니처와 일치하지 않는 기본값이 아닌(편의) 생성자

이러한 생성자가 매개 변수를 사용하여 초기화에서 종속성 속성을 설정할 경우 먼저 초기화를 위해 자체 클래스 매개 변수 없는 생성자를 호출하고 매개 변수를 사용하여 종속성 속성을 설정합니다. 이러한 속성은 클래스에서 정의된 종속성 속성이거나 기본 클래스에서 상속된 종속성 속성일 수 있지만 두 경우 중 하나에는 다음 패턴을 사용합니다.

public MyClass : SomeBaseClass {  
    public MyClass(object toSetProperty1) : this() {  
        // Class initialization NOT done by default.  
        // Then, set properties to values as passed in ctor parameters.  
        Property1 = toSetProperty1;  
    }  
}

기본 시그니처와 일치하는 기본값이 아닌(편의) 생성자

같은 매개 변수화를 사용하여 기본 생성자를 호출하는 대신 다시 자체 클래스의 매개 변수 없는 생성자를 호출합니다. 기본 이니셜라이저를 호출하지 마세요. 대신에 this()를 호출해야 합니다. 그 다음에 전달된 매개 변수를 관련 속성을 설정하기 위한 값으로 사용하여 원래 생성자 동작을 재현합니다. 특정 매개 변수가 설정해야 하는 속성을 결정하는 과정의 지침으로 원래 기본 생성자 문서를 사용합니다.

public MyClass : SomeBaseClass {  
    public MyClass(object toSetProperty1) : this() {  
        // Class initialization NOT done by default.  
        // Then, set properties to values as passed in ctor parameters.  
        Property1 = toSetProperty1;  
    }  
}

모든 시그니처와 일치해야 함

기본 형식에 여러 시그니처가 포함되는 경우 추가 속성을 설정하기 전에 클래스 매개 변수 없는 생성자 호출의 권장 패턴을 사용하는 자체적인 생성자 구현과 모든 가능한 시그니처를 의도적으로 일치시켜야 합니다.

SetValue를 사용하여 종속성 속성 설정

이러한 동일한 패턴은 속성 설정 편의를 위한 래퍼가 없는 속성을 설정할 경우 적용되고, SetValue을 사용하여 값을 설정합니다. 생성자 매개 변수를 통해 전달되는 SetValue에 대한 호출은 초기화를 위해 클래스의 기본 생성자도 호출해야 합니다.

다음을 통해 공유