호출자 정보(Visual Basic)

  • 아티클

호출자 정보 특성을 사용하여 메서드 호출자에 대한 정보를 얻을 수 있습니다. 소스 코드 파일 경로, 소스 코드 줄 번호 및 호출자의 멤버 이름을 얻을 수 있습니다. 이 정보는 추적, 디버깅 및 진단 도구를 만드는 데 도움이 됩니다.

이 정보를 얻으려면 각각 기본값이 있는 선택적 매개 변수에 적용되는 특성을 사용합니다. 다음 표에서는 System.Runtime.CompilerServices 네임스페이스에 정의된 호출자 정보 특성을 보여줍니다.

attribute Description Type
CallerFilePathAttribute 호출자를 포함한 소스 파일의 전체 경로입니다. 컴파일 시간의 파일 경로입니다. String
CallerLineNumberAttribute 메서드가 호출되는 소스 파일의 줄 번호입니다. Integer
CallerMemberNameAttribute 호출자의 메서드 또는 속성 이름입니다. 이 항목의 뒷부분에 있는 멤버 이름을 참조하세요. String
CallerArgumentExpressionAttribute 인수에 대해 호출자가 사용하는 식입니다. 이 항목의 뒷부분에 호출자 식을 참조하세요. String

예시

다음 예제에서는 호출자 정보 특성을 사용하는 방법을 보여줍니다. TraceMessage 메서드에 대한 각 호출에서 호출자 정보는 선택적 매개 변수에 대한 인수로 대체됩니다.

Private Sub DoProcessing()  
    TraceMessage("Something happened.")  
End Sub  
  
Public Sub TraceMessage(message As String,  
        <System.Runtime.CompilerServices.CallerMemberName> Optional memberName As String = Nothing,  
        <System.Runtime.CompilerServices.CallerFilePath> Optional sourcefilePath As String = Nothing,  
        <System.Runtime.CompilerServices.CallerLineNumber()> Optional sourceLineNumber As Integer = 0)  
  
    System.Diagnostics.Trace.WriteLine("message: " & message)  
    System.Diagnostics.Trace.WriteLine("member name: " & memberName)  
    System.Diagnostics.Trace.WriteLine("source file path: " & sourcefilePath)  
    System.Diagnostics.Trace.WriteLine("source line number: " & sourceLineNumber)  
End Sub  
  
' Sample output:  
'   message: Something happened.  
'   member name: DoProcessing  
'   source file path: C:\Users\username\Documents\Visual Studio 2012\Projects\CallerInfoVB\CallerInfoVB\Form1.vb  
'   source line number: 15

설명

각각의 선택적 매개 변수에 대한 명시적 기본값을 지정해야 합니다. 선택적으로 지정되지 않은 매개 변수에 호출자 정보 특성을 적용할 수 없습니다.

호출자 정보 특성은 매개 변수를 선택적 매개 변수로 만들지 못합니다. 대신, 이런 특성은 인수가 생략될 때 전달되는 기본값에 영향을 미칩니다.

호출자 정보 값은 컴파일 시간에 리터럴로 중간 언어(IL) 내로 내보내집니다. 예외에 대한 StackTrace 속성의 결과와 달리 결과가 난독화의 영향을 받지 않습니다.

선택적 인수를 명시적으로 제공하여 호출자 정보를 제어하거나 호출자 정보를 숨길 수 있습니다.

멤버 이름

CallerMemberName 특성을 사용하여 멤버 이름을 호출된 메서드에 대한 String 인수로 지정하는 것을 피할 수 있습니다. 이 기술을 사용하여 이름 바꾸기 리팩터링이 String 값을 변경하지 못하는 문제를 피합니다. 이 이점은 다음 작업에 특히 유용합니다.

  • 추적 및 진단 루틴 사용.

  • 데이터를 바인딩할 때 INotifyPropertyChanged 인터페이스 구현. 이 인터페이스에서는 컨트롤에서 업데이트된 정보를 표시할 수 있도록 바운드 컨트롤의 속성이 변경되었음을 알리는 개체의 속성을 사용할 수 있습니다. CallerMemberName 특성이 없으면 속성 이름을 리터럴로 지정해야 합니다.

아래 차트는 CallerMemberName 특성을 사용할 때 반환되는 멤버 이름을 보여줍니다.

호출 발생 범위 멤버 이름 결과
메서드, 속성 또는 이벤트 호출에서 시작한 메서드, 속성 또는 이벤트의 이름입니다.
생성자 ".ctor" 문자열
정적 생성자 ".cctor" 문자열
Destructor "Finalize" 문자열
사용자 정의 연산자 또는 변환 멤버에 대해 생성되는 이름입니다(예: "op_Addition").
특성 생성자 특성이 적용되는 멤버의 이름입니다. 특성이 멤버 내에 있는 어떤 요소인 경우(예: 매개 변수, 반환 값 또는 제네릭 형식 매개 변수) 이 결과는 그 요소와 관련된 멤버의 이름입니다.
포함하는 멤버가 없음(예: 어셈블리 수준 또는 형식에 적용되는 특성) 선택적 매개 변수의 기본값입니다.

호출자 식

인수에 사용되는 식을 캡처하려는 경우 System.Runtime.CompilerServices.CallerArgumentExpressionAttribute을 사용합니다. 진단 라이브러리의 경우 인수로 전달된 식에 관한 상세한 정보를 제공해야 할 수 있습니다. 매개 변수 이름 외에도 진단을 트리거한 식을 제공하면 개발자가 진단을 트리거한 조건에 대해 더 자세히 알아볼 수 있습니다. 이 추가 정보가 제공되면 수정이 그만큼 쉬워집니다. 다음 메서드는 CallerArgumentExpressionAttribute을 사용하여 반드시 True가 되는 조건을 표시합니다.

Public Shared Sub ValidateArgument(ByVal parameterName As String,
ByVal condition As Boolean,
<CallerArgumentExpression("condition")> ByVal Optional message As String? = Nothing)
    If Not condition Then
        Throw New ArgumentException($"Argument failed validation: <{message}>", parameterName)
    End If
End Sub

참고 항목