C# 12 - Interceptor (컴파일 시에 메서드 호출 재작성)
오늘(KST 2023-11-15) 공개된 C# 12 문서에는 이 기능이 아직 정식은 아니고 "experimental feature"에 해당한다고 합니다. 따라서 향후에는 변경/삭제될 수 있음을 감안해야 합니다.
현재 C# 12 정식 버전에 해당하는 내용으로 업데이트했지만 향후 바뀔 수 있으므로 구현 전에는 관련 문서를 참조하길 권장합니다.
아래와 같은 글이 있군요. ^^
.NET 8 Interceptors
; https://khalidabuhakmeh.com/dotnet-8-interceptors
제목으로 보면 마치 ".NET 8"과 연관이 있는 듯하지만, 실제로는
공식 문서에도 소개됐듯이 C# 12의 신규 기능입니다.
실습하려면, Visual Studio 17.7 preview 3부터 적용되었다고 나오므로 현재(2023-09-08) 시점의 정식 버전이 17.7.0이므로 역시 Visual Studio Preview 버전에서만 실행해 볼 수 있습니다.
자, 그럼 간단하게 테스트를 해볼까요? ^^
우선 사전 작업으로 특성 하나를 추가해야 합니다.
현재 Visual Studio 2022 Preview를 최신 버전으로 업데이트하면 "8.0.100-preview.7.23376.3" 버전의 .NET SDK가 설치되는데요, C# 12의 가로채기(intercept) 기술은 특성(Attribute)를 기반으로 동작하는 반면, 아직 8.0 Preview에는 관련 타입이 정의돼 있지 않아 다음과 같이 소스 코드에 명시적으로 추가를 해야 합니다.
namespace System.Runtime.CompilerServices;
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = false)]
public sealed class InterceptsLocationAttribute : Attribute
{
public InterceptsLocationAttribute(string filePath, int line, int character)
{
}
}
그다음, C# 콘솔 프로젝트를 하나 생성하고 csproj의
Features 속성에 InterceptorsPreview 값을 하나 추가합니다. InterceptorsPreviewNamespaces 속성에 InterceptsLocation 특성을 사용할 코드의 네임스페이스를 명시합니다.
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net7.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<Features>InterceptorsPreview</Features> <!-- .NET 7 ~ .NET 8.0.100-preview.6.23330.14 까지만 동작 -->
<InterceptorsPreviewNamespaces>$(InterceptorsPreviewNamespaces);ClassLib1.Experimental</InterceptorsPreviewNamespaces>
</PropertyGroup>
</Project>
준비는 이게 끝입니다. 다음은 일반적인 코딩을 하고,
using System.Runtime.CompilerServices;
namespace ConsoleApp2
{
internal class Program
{
static void Main(string[] args)
{
Program.ProgramMethod();
// |- 위의 "P" 위치가 9번째 줄, 21번째 칼럼에 위치
}
static void ProgramMethod()
{
Console.WriteLine("Program Method");
}
}
}
/* 현재 상태의 출력 결과:
Program Method
*/
위의 코드에서 우리가 가로채고 싶은 것은 "Program.ProgramMethod()" 호출입니다. 이를 위해 C# 12는 호출이 되는 대상 파일의 "절대 경로", "호출 라인", "호출 칼럼"의 정보를 정확하게 기입한 새로운 메서드를 정의할 수 있습니다.
namespace ClassLib1.Experimental; // csproj의 InterceptorsPreviewNamespaces 값에 추가했던 네임스페이스
class My
{
[InterceptsLocation("C:\\temp\\ConsoleApp1\\ConsoleApp2\\Program.cs", line: 9, character: 21)]
public static void MyMethod() => Console.WriteLine("My Method");
}
느낌이 오시나요? 말 그대로 InterceptsLocation에 지정한 파일, 라인, 칼럼의 메서드 호출을 재작성하겠다는 것입니다.
따라서 위의 코드를 실행하면 이제 출력은 "My Method"로 바뀝니다. 당연하겠지만, 만약 여러분이 Main 코드를 다음과 같이 바꾸기라도 하면,
static void Main(string[] args)
{
Console.WriteLine("TEST"); // 이 코드의 삽입으로 인해,
Program.ProgramMethod();
// |- 위의 "P" 위치가 10번째 줄, 21번째 칼럼에 위치
}
InterceptsLocation에 기록된 정보와 달라지므로 호출 코드는 재작성되지 않습니다. 따라서, 만약 가로챈 메서드가 있다면 기존 소스 코드를 바꿀 때 주의 깊게 InterceptsLocation 특성의 전달 값도 동기화시켜야 합니다.
혹시 위의 코드를 보고 나서 한 가지 의문이 생기지 않나요? ^^ 정적 메서드는 그렇게 외부 메서드로 뺼 수 있지만 인스턴스 메서드는 어떻게 재작성할 수 있을까요? 이에 대해서는 문서를 참고할 수 있는데요,
Interceptors
; https://github.com/dotnet/roslyn/blob/main/docs/features/interceptors.md
보시면, 인스턴스 메서드는 C#답게 ^^ 확장 메서드로 풀어내고 있습니다. 그렇다는 것은, public 멤버만 접근 가능한 상태로 코딩이 가능한 상황에서만 재작성할 수 있다는 것을 의미합니다.
그냥 보면, 뭐 이런 현실성 없는, 그다지 쓸만한 데가 마땅치 않은 메서드 재작성 기능이 있나... 싶을 텐데요, 제가 보기에도 일반적인 프로젝트에서 딱히 쓸 필요는 없어 보입니다.
단지, 이게 나름 의미 있는 사용처가 있는데요, 바로 "
소스 코드 생성기(Source Generator)"입니다.
Source Generator의 대표적인 한계가 바로 "기존 소스 코드의 변경은 불가능"하다는 점인데요, 바로 이 한계를 Interceptor가 (제한적이나마) 가능하게 해줍니다. 게다가 Source Generator의 특성상, 컴파일 시점에 구문 분석을 통해 대상 메서드의 정확한 파일/라인/칼럼 위치를 알 수 있으므로 위의 예제에서 My 클래스의 소스 코드는 원래 Source Generator 등이 생성해야 할 과제인 것입니다.
그런 관점에서 다시 보면, "소스 코드 변경"을 할 수 없는 Roslyn의 Plug-in 정책을 위반하지 않으면서도 나름대로의 확장을 가능하게 한 기특한 생각이라고 봐도 좋을 것입니다. ^^
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]