Microsoft MVP성태의 닷넷 이야기
.NET Framework: 908. C# - Source Generator 소개 [링크 복사], [링크+제목 복사]
조회: 2425
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

C# - Source Generator 소개

다음과 같은 소식이 있군요. ^^

Introducing C# Source Generators
; https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/

위의 글에서도 잘 설명하고 있지만, 그대로 따라 해 보면서 한글로 다시 소개를 하겠습니다. ^^ 참고로, 저 글을 쓸 당시에는 비주얼 스튜디오에서 지원하지 않았지만, 현재 (16.6.1) 버전에서는 지원하므로 별도의 Preview 버전을 설치하지 않아도 무방합니다. (또한 위의 글에 따르면 .NET 5 Preview도 필요하다는데 제가 테스트한 바로는 .NET Core 3.1.2 환경에서 잘 동작했습니다.)




Source Generator가 뭔지는 위의 글에 포함된 그림에서 잘 설명하고 있습니다.

cs_src_gen_1.png

그러니까, 컴파일 시점에 개발자가 임의대로 다시 소스 코드를 구성해 (단, 기존 소스 코드의 변경은 불가능하지만) 끼워 넣을 수 있는 여지를 준 것입니다. 말로만 하면 심심하니 실습을 해보겠습니다.

우선, 콘솔 프로젝트를 하나 만들고 아래의 예제 코드를 입력합니다.

using System;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            HelloWorldGenerated.HelloWorld.SayHello();
        }
    }
}

당연히, 위의 단계까지는 빌드하면 "error CS0103: The name 'HelloWorldGenerated' does not exist in the current context" 오류가 발생합니다. 이제부터 할 일은, 컴파일 시에 HelloWorldGenerated.HelloWorld 타입을 담는 소스 코드를 끼워 넣으면 되는데, 이 작업을 일종의 plug-in처럼 처리하게 됩니다. 이를 위해 ".NET Standard Library" 유형의 프로젝트를 생성하고 다음과 같이 .csproj 파일을 수정합니다.

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="3.6.0" PrivateAssets="all" />
    <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.0.0" PrivateAssets="all" />
  </ItemGroup>

</Project>

또는 NuGet을 통해 패키지 참조를 해도 됩니다.

Install-Package Microsoft.CodeAnalysis.Analyzers -Version 3.0.0
Install-Package Microsoft.CodeAnalysis.CSharp.Workspaces -Version 3.6.0

이후 ISourceGenerator 인터페이스를 상속받아 "Generator" 특성이 붙은 타입을 정의하면,

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Text;
using System;
using System.Text;

namespace HelloGenerator
{
    [Generator]
    public class MySourceGenerator : ISourceGenerator
    {
        public void Execute(SourceGeneratorContext context)
        {
            // begin creating the source we'll inject into the users compilation
            var sourceBuilder = new StringBuilder(@"
using System;
namespace HelloWorldGenerated
{
    public static class HelloWorld
    {
        public static void SayHello() 
        {
            Console.WriteLine(""Hello from generated code!"");
            Console.WriteLine(""The following syntax trees existed in the compilation that created this program:"");
");

            // using the context, get a list of syntax trees in the users compilation
            var syntaxTrees = context.Compilation.SyntaxTrees;

            // add the filepath of each tree to the class we're building
            foreach (SyntaxTree tree in syntaxTrees)
            {
                sourceBuilder.AppendLine($@"Console.WriteLine(@"" - {tree.FilePath}"");");
            }

            // finish creating the source to inject
            sourceBuilder.Append(@"
        }
    }
}");

            // inject the created source into the users compilation
            context.AddSource("helloWorldGenerator", SourceText.From(sourceBuilder.ToString(), Encoding.UTF8));
        }

        public void Initialize(InitializationContext context)
        {
            // No initialization required for this one
        }
    }
}

Roslyn의 컴파일 단계에 참여할 수 있는 plug-in이 완성됩니다. 남은 작업은, 위의 plug-in을 사용할 첫 번째 콘솔 프로젝트에 참조 추가를 하고, Preview 단계의 C# 컴파일러를 사용하도록 지정하면 되는데,

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <LangVersion>preview</LangVersion>
  </PropertyGroup>

  <ItemGroup>
    <ProjectReference Include="..\HelloGenerator\HelloGenerator.csproj" />
  </ItemGroup>

</Project>

특별히, plug-in이라는 점을 명시하기 위해 OutputItemType을 Analyzer로 설정하고, 또한 실제 실행 시 필요한 어셈블리는 아니므로 ReferenceOutputAssembly를 false로 지정해 줍니다.

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <LangVersion>preview</LangVersion>
  </PropertyGroup>

  <ItemGroup>
    <ProjectReference Include="..\HelloGenerator\HelloGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
  </ItemGroup>

</Project>

이렇게 하고 빌드하면, 컴파일 시점에 ISourceGenerator.Execute 메서드가 호출되고 그로 인해 HelloWorldGenerated.HelloWorld 타입이 정의되어 함께 빌드에 참여하게 되므로 예제 콘솔 프로젝트가 정상적으로 빌드가 됩니다.

그래서 예제 코드를 실행하면 다음과 같은 식의 출력을 볼 수 있습니다.

Hello from generated code!
The following syntax trees existed in the compilation that created this program:
 - D:\temp\ConsoleApp1\ConsoleApp1\Program.cs
 - D:\temp\ConsoleApp1\ConsoleApp1\obj\Debug\netcoreapp3.1\.NETCoreApp,Version=v3.1.AssemblyAttributes.cs
 - D:\temp\ConsoleApp1\ConsoleApp1\obj\Debug\netcoreapp3.1\ConsoleApp1.AssemblyInfo.cs

결과를 보면 알 수 있겠지만, 이러한 출력 결과는 일반적인 C#의 기존 코딩 방법으로는 할 수 없는 작업물입니다.

(첨부 파일은 이 글의 완전한 예제 프로젝트를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]


donaricano-btn



[최초 등록일: ]
[최종 수정일: 6/10/2020 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 쓴 사람
 



2020-07-13 05시32분
T4(TextTemplate) 와 비교해봤을 때 궁금한 점이 있습니다. 자동생성된 코드를 디버깅할 일이 있으면 T4같은 경우는 실행했을 때 tt 파일로 생성되는 cs 파일을 찾아 확인할 수 있는데요. SourceGenerator에서는 ReferenceOutputAssembly="true" 하여 생성되는 dll 을 decompile 하는 방법 밖에는 없는지요?
kernel
2020-07-13 06시46분
[kernel] 추후 제공할 예정이라고 하네요. ^^;
[손님]
2020-08-26 02시11분
New C# Source Generator Samples
 - CSV Generator
 - Mustache Generator
; https://devblogs.microsoft.com/dotnet/new-c-source-generator-samples/
정성태
2021-01-28 10시26분
정성태
2021-03-03 02시10분
Visual Studio 2019 16.9 버전부터 솔루션 탐색기의 프로젝트 노드에서 "Analyzers" 하위에 "Source Generator로 생성된 소스 코드 목록을 보여줍니다.
정성태
2021-05-28 11시30분
Visual Studio 16.10 버전부터 "Launch" 항목에 "Roslyn Component"가 추가되어 Source Generator 개발에 대한 디버거 지원이 가능해졌습니다.


Visual Studio 2019 version 16.10 Release Notes
 - .NET Productivity
; https://docs.microsoft.com/en-us/visualstudio/releases/2019/release-notes#NETProductivity
정성태

[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12688정성태6/24/202138.NET Framework: 1073. C# - JSON 역/직렬화 시 리플렉션 손실을 없애는 JsonSrcGen파일 다운로드1
12687정성태6/22/202136오류 유형: 729. Invalid data: Invalid artifact, java se app service only supports .jar artifact
12686정성태6/21/202152Java: 22. Azure - 자바(Java)로 만드는 Web App Service
12685정성태6/21/202158Java: 21. Azure Web App Service에 배포된 Java 프로세스의 메모리 및 힙(Heap) 덤프 뜨는 방법
12684정성태6/19/202148오류 유형: 728. Visual Studio 2022부터 DTE.get_Properties 속성 접근 시 System.MissingMethodException 예외 발생
12683정성태6/18/202165VS.NET IDE: 166. Visual Studio 2022 - Windows Forms 프로젝트의 x86 DLL 컨트롤이 Designer에서 오류가 발생하는 문제파일 다운로드1
12682정성태6/18/202179VS.NET IDE: 165. Visual Studio 2022를 위한 Extension 마이그레이션
12681정성태6/18/202154오류 유형: 727. .NET 2.0 ~ 3.5 + x64 환경에서 System.EnterpriseServices 참조 시 CS8012 경고
12680정성태6/18/202140오류 유형: 726. python2.7.exe 실행 시 0xc000007b 오류
12679정성태6/18/202197COM 개체 관련: 23. CoInitializeSecurity의 전역 설정을 재정의하는 CoSetProxyBlanket 함수 사용법파일 다운로드1
12678정성태6/17/202182.NET Framework: 1072. C# - CoCreateInstance 관련 Inteop 오류 정리파일 다운로드1
12677정성태6/17/202176VC++: 144. 역공학을 통한 lxssmanager.dll의 ILxssSession 사용법 분석파일 다운로드1
12676정성태6/16/2021108VC++: 143. ionescu007/lxss github repo에 공개된 lxssmanager.dll의 CLSID_LxssUserSession/IID_ILxssSession 사용법파일 다운로드1
12675정성태6/16/202154Java: 20. maven package 명령어 결과물로 (war가 아닌) jar 생성 방법
12674정성태6/15/202194VC++: 142. DEFINE_GUID 사용법
12673정성태6/15/202157Java: 19. IntelliJ - 자바(Java)로 만드는 Web App을 Tomcat에서 실행하는 방법
12672정성태6/15/202148오류 유형: 725. IntelliJ에서 Java webapp 실행 시 "Address localhost:1099 is already in use" 오류
12671정성태6/15/202164오류 유형: 724. Tomcat 실행 시 Failed to initialize connector [Connector[HTTP/1.1-8080]] 오류
12670정성태6/13/202169.NET Framework: 1071. DLL Surrogate를 이용한 Out-of-process COM 개체에서의 CoInitializeSecurity 문제파일 다운로드1
12669정성태6/11/2021160.NET Framework: 1070. 사용자 정의 GetHashCode 메서드 구현은 C# 9.0의 record 또는 리팩터링에 맡기세요.
12668정성태6/11/2021175.NET Framework: 1069. C# - DLL Surrogate를 이용한 Out-of-process COM 개체 제작파일 다운로드2
12667정성태6/10/202199.NET Framework: 1068. COM+ 서버 응용 프로그램을 이용해 CoInitializeSecurity 제약 해결파일 다운로드1
12666정성태6/10/202178.NET Framework: 1067. 별도 DLL에 포함된 타입을 STAThread Main 메서드에서 사용하는 경우 CoInitializeSecurity 자동 호출파일 다운로드1
12665정성태6/9/2021146.NET Framework: 1066. Wslhub.Sdk 사용으로 알아보는 CoInitializeSecurity 사용 제약파일 다운로드1
12664정성태6/9/2021102오류 유형: 723. COM+ PIA 참조 시 "This operation failed because the QueryInterface call on the COM component" 오류
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...