C# 컴파일러에서 해석하는 특성을 사용하여 호출자 정보 확인

  • 아티클

정보 특성을 사용하여 메서드 호출자에 대한 정보를 가져옵니다. 소스 코드 파일 경로, 소스 코드 줄 번호 및 호출자의 멤버 이름을 가져옵니다. 멤버 호출자 정보를 얻으려면 선택적 매개 변수에 적용되는 특성을 사용합니다. 각 선택적 매개 변수는 기본값을 지정합니다. 다음 표에서는 System.Runtime.CompilerServices 네임스페이스에 정의된 호출자 정보 특성을 보여줍니다.

attribute Description Type
CallerFilePathAttribute 호출자를 포함한 소스 파일의 전체 경로입니다. 전체 경로는 컴파일 시간의 경로입니다. String
CallerLineNumberAttribute 메서드가 호출되는 소스 파일의 줄 번호입니다. Integer
CallerMemberNameAttribute 호출자의 메서드 이름 또는 속성 이름입니다. String
CallerArgumentExpressionAttribute 인수 식의 문자열 표현입니다. String

이 정보는 추적 및 디버깅에 도움이 되며 진단 도구를 만들 수 있도록 지원합니다. 다음 예제에서는 호출자 정보 특성을 사용하는 방법을 보여 줍니다. TraceMessage 메서드에 대한 각 호출에서 선택적 매개 변수의 인수에 호출자 정보가 삽입됩니다.

public void DoProcessing()
{
    TraceMessage("Something happened.");
}

public void TraceMessage(string message,
        [CallerMemberName] string memberName = "",
        [CallerFilePath] string sourceFilePath = "",
        [CallerLineNumber] int sourceLineNumber = 0)
{
    Trace.WriteLine("message: " + message);
    Trace.WriteLine("member name: " + memberName);
    Trace.WriteLine("source file path: " + sourceFilePath);
    Trace.WriteLine("source line number: " + sourceLineNumber);
}

// Sample Output:
//  message: Something happened.
//  member name: DoProcessing
//  source file path: c:\Visual Studio Projects\CallerInfoCS\CallerInfoCS\Form1.cs
//  source line number: 31

각각의 선택적 매개 변수에 대한 명시적 기본값을 지정합니다. 선택적 매개 변수로 지정되지 않은 매개 변수에 호출자 정보 특성을 적용할 수 없습니다. 호출자 정보 특성은 매개 변수를 선택적 매개 변수로 만들지 못합니다. 대신, 이런 특성은 인수가 생략될 때 전달되는 기본값에 영향을 미칩니다. 호출자 정보 값은 컴파일 시간에 리터럴로 중간 언어(IL) 내로 내보냅니다. 예외에 대한 StackTrace 속성의 결과와 달리 결과가 난독화의 영향을 받지 않습니다. 선택적 인수를 명시적으로 제공하여 호출자 정보를 제어하거나 호출자 정보를 숨길 수 있습니다.

멤버 이름

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

  • 추적 및 진단 루틴 사용.
  • 데이터를 바인딩할 때 INotifyPropertyChanged 인터페이스 구현. 이 인터페이스를 사용하면 개체의 속성이 바인딩된 컨트롤에 속성이 변경되었음을 알릴 수 있습니다. 컨트롤은 업데이트된 정보를 표시할 수 있습니다. CallerMemberName 특성이 없으면 속성 이름을 리터럴로 지정해야 합니다.

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

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

인수 식

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

다음 예제에서는 인수가 유효하지 않은 경우 상세한 정보를 제공하는 방법을 보여 줍니다.

public static void ValidateArgument(string parameterName, bool condition, [CallerArgumentExpression("condition")] string? message=null)
{
    if (!condition)
    {
        throw new ArgumentException($"Argument failed validation: <{message}>", parameterName);
    }
}

다음 예제에서처럼 호출합니다.

public void Operation(Action func)
{
    Utilities.ValidateArgument(nameof(func), func is not null);
    func();
}

condition에 사용되는 식은 컴파일러가 message 인수에 삽입합니다. 개발자가 null 인수를 사용하여 Operation을 호출하면 ArgumentException에 다음 메시지가 저장됩니다.

Argument failed validation: <func is not null>

이 특성을 사용하여 더욱 상세한 정보를 제공하는 진단 유틸리티를 작성할 수 있습니다. 개발자는 무엇을 변경해야 하는지 더 빠르게 파악할 수 있습니다. CallerArgumentExpressionAttribute를 사용하여 어느 식이 확장 메서드의 수신자로 사용되었는지도 알아볼 수도 있습니다. 다음 메서드는 일정한 간격으로 시퀀스를 샘플링합니다. 시퀀스의 요소 수가 빈도보다 작은 경우 오류를 보고합니다.

public static IEnumerable<T> Sample<T>(this IEnumerable<T> sequence, int frequency, 
    [CallerArgumentExpression(nameof(sequence))] string? message = null)
{
    if (sequence.Count() < frequency)
        throw new ArgumentException($"Expression doesn't have enough elements: {message}", nameof(sequence));
    int i = 0;
    foreach (T item in sequence)
    {
        if (i++ % frequency == 0)
            yield return item;
    }
}

이전 예에서는 매개 변수 sequence에 대해 nameof 연산자를 사용했습니다. 해당 기능은 C# 11에서 사용할 수 있습니다. C# 11 이전에는 매개 변수 이름을 문자열로 입력해야 합니다. 이 메서드는 다음과 같이 호출합니다.

sample = Enumerable.Range(0, 10).Sample(100);

위 예제는 메시지가 다음과 같은 텍스트인 ArgumentException을 throw합니다.

Expression doesn't have enough elements: Enumerable.Range(0, 10) (Parameter 'sequence')

참고 항목