C# -Version 1 Source Generator 실습
예전 글에서 "Soruce Generator"를 소개했는데요,
C# - Source Generator 소개
; https://www.sysnet.pe.kr/2/0/12223
C# - Source Generator를 적용한 XmlCodeGenerator
; https://www.sysnet.pe.kr/2/0/12228
그때와 살짝 달라진 면이 있어서 다시 정리를 했습니다.
실습을 위해 프로젝트(이 글에서는 "PropertySrcGenerator")를 다음과 같이 설정하고,
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<LangVersion>10.0</LangVersion>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.3" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.11.0" />
</ItemGroup>
</Project>
소스 생성기의 뼈대도 다음과 같이 구성하면 됩니다.
using Microsoft.CodeAnalysis;
namespace V1Generator
{
[Generator]
public class PropertySrcGenerator : ISourceGenerator
{
public void Initialize(GeneratorInitializationContext context)
{
}
public void Execute(GeneratorExecutionContext context)
{
}
}
}
자, 이 상태에서 우리가 하고 싶은 것은 사용자가 작성한 클래스가 "partial"이면서 "[AutoProp]" 속성을 적용했다면,
[AutoProp]
public partial class Book
{
string writer;
}
자동으로 그 클래스가 소유한 필드에 대해 다음과 같은 코드를 만들어 주는 것입니다.
partial class Book
{
string writer;
public string Writer
{
get => writer;
set => writer = value;
}
}
그리고 개발의 편의를 위해 Source Generator를 그때그때 동작을 확인하는 용도로 PropertySrcGenerator 프로젝트를 참조하는 예제 프로젝트를 하나 만들고,
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp3.1</TargetFramework>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\PropertySrcGenerator\PropertySrcGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
</ItemGroup>
</Project>
다음과 같이 코드를 추가합니다.
using System;
internal class Program
{
static void Main(string[] args)
{
Console.WriteLine("Hello World!");
}
}
[AutoProp]
public partial class Book
{
string writer = "";
}
자, 이제 여기서 첫 번째 목표가 나왔군요. 위의 코드가 오류 없이 컴파일되려면, 소스 코드 생성기에서 우선 AutoProp 특성을 사용자가 고정적으로 사용할 수 있게 만들어야 하는데요, 이를 위해 Initialize 단계에서 아래와 같은 코드를 포함하면 됩니다.
[Generator]
public class PropertySrcGenerator : ISourceGenerator
{
public const string AutoPropAttribute = @"
namespace System
{
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct)]
public class AutoPropAttribute : System.Attribute
{
}
}";
public void Initialize(GeneratorInitializationContext context)
{
context.RegisterForPostInitialization((ctx) =>
{
ctx.AddSource("AutoPropAttribute.g.cs", SourceText.From(AutoPropAttribute, Encoding.UTF8));
});
}
public void Execute(GeneratorExecutionContext context)
{
}
}
그다음, 사용자가 작성한 클래스의 필드에 대해 get/set 속성을 생성하는 코드를 만들어야 하는데요, 이것이 가능하게 만들려면 사용자가 만든 클래스가 우리가 원하는 조건에 맞는 코드인지를 먼저 판정을 할 수 있어야 합니다. 즉, "자동 생성할" 대상 클래스를 먼저 식별해야 하는데요, 이 작업을 구현하기 위한 2가지 선택이 있습니다.
첫 번째로, Execute 코드에 1) 대상 식별과 2) 소스 코드 생성을 모두 넣는 것입니다. 당연히 이렇게 하면 Execute 코드 작업이 무거워질 것입니다. 테스트를 해보시면 알겠지만, Execute 코드는 Visual Studio IDE가 소스 코드에 변경이 가해질 때마다 수시로 불리는 구조입니다. 의미인즉, Execute 코드에서 하는 일이 많을 수록 코드 편집 창의 반응 속도는 점점 악화될 수 있다는 것입니다. 그래서, 첫 번째 방식처럼 Execute에서 모든 작업을 담당하는 구조는
XmlSrcGenerator처럼 구문 분석이 필요 없는 경우에 적합합니다.
두 번째로, Initialize 단계에서 RegisterForSyntaxNotifications을 등록해 Visual Studio IDE가 코드 수정 중 발생하는 구문 분석 단계에서 콜백을 발생시켜 Execute 코드의 대상 식별 단계를 분리해 내는 것입니다. 방법도 어렵지 않은데, 단순히 ISyntaxReceiver를 구현한 클래스의 인스턴스 생성을 하는 델리게이트를 전달해 두면,
public void Initialize(GeneratorInitializationContext context)
{
context.RegisterForPostInitialization((ctx) =>
{
ctx.AddSource("AutoPropAttribute.g.cs", SourceText.From(AutoPropAttribute, Encoding.UTF8));
});
context.RegisterForSyntaxNotifications(() => new AutoPropSyntaxReceiver());
}
이후 비주얼 스튜디오는 코드 편집기에서 구문 분석을 수행할 때마다 콜백을 호출하므로,
class AutoPropSyntaxReceiver : ISyntaxReceiver
{
public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
{
}
}
단지 개발자는 OnVisitSyntaxNode에서 대상 코드가 자동 생성될 조건을 만족하는지 식별을 해주면 됩니다. 그리고, 이후 Execute 단계에서는 OnVisitSyntaxNode에서 식별해 두었던 노드 정보를 바탕으로 소스 코드만 생성해 주면 끝입니다.
정리해 보면 이렇게 뼈대를 구성할 수 있습니다.
// ...[생략]...
namespace V1Generator
{
[Generator]
public class PropertySrcGenerator : ISourceGenerator
{
// ...[생략]...
public void Initialize(GeneratorInitializationContext context)
{
// ...[생략]...
context.RegisterForSyntaxNotifications(() => new AutoPropSyntaxReceiver());
}
public void Execute(GeneratorExecutionContext context)
{
AutoPropSyntaxReceiver? recv = context.SyntaxReceiver as AutoPropSyntaxReceiver;
// 미리 대상 클래스를 식별해 보관해 두었던 AutoPropSyntaxReceiver.AutoPropClasses로부터 소스 코드 자동 생성
}
}
class AutoPropSyntaxReceiver : ISyntaxReceiver
{
public List AutoPropClasses = new List();
public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
{
// [AutoProp] 특성이 적용됐고, partial 클래스라면 AutoPropClasses 목록에 추가
}
}
}
간단하게 언급하긴 했지만, 구분 분석에 따른 자잘한 코드가 많아 생각보다 꽤 코딩 분량이 많아집니다. 아래는 위의 내용을 구현한 전체 소스 코드입니다.
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Text;
using PropertySrcGenerator;
using System.Text;
namespace V1Generator
{
[Generator]
public class PropertySrcGenerator : ISourceGenerator
{
public const string AutoPropAttribute = @"
namespace System
{
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct)]
public class AutoPropAttribute : System.Attribute
{
}
}";
public void Initialize(GeneratorInitializationContext context)
{
context.RegisterForPostInitialization((ctx) =>
{
ctx.AddSource("AutoPropAttribute.g.cs", SourceText.From(AutoPropAttribute, Encoding.UTF8));
});
context.RegisterForSyntaxNotifications(() => new AutoPropSyntaxReceiver());
}
public void Execute(GeneratorExecutionContext context)
{
AutoPropSyntaxReceiver? recv = context.SyntaxReceiver as AutoPropSyntaxReceiver;
if (recv == null)
{
return;
}
if (recv.AutoPropClasses.Count == 0)
{
return;
}
foreach (var cls in recv.AutoPropClasses)
{
List<AutoFieldInfo> fieldList = GetFieldList(context.Compilation, cls);
if (fieldList.Count == 0)
{
continue;
}
string clsNamespace = GetNamespace(context.Compilation, cls);
string src = GenerateSource(clsNamespace, cls.Identifier.ValueText, fieldList);
context.AddSource($"{cls.Identifier.ValueText}.g.cs", SourceText.From(src, Encoding.UTF8));
}
}
private string GetNamespace(Compilation compilation, ClassDeclarationSyntax cls)
{
var model = compilation.GetSemanticModel(cls.SyntaxTree);
foreach (NamespaceDeclarationSyntax ns in cls.Ancestors().OfType<NamespaceDeclarationSyntax>())
{
return ns.Name.ToString();
}
return "";
}
private string GenerateSource(string clsNamespace, string className, List<AutoFieldInfo> fieldList)
{
IndentText sb = new IndentText();
bool hasNamespace = string.IsNullOrEmpty(clsNamespace) == false;
if (hasNamespace)
{
sb.AppendLine($"namespace {clsNamespace}");
sb.AppendLine("{");
}
using (sb.Indent(hasNamespace))
{
sb.AppendLine(@$"partial class {className}");
sb.AppendLine("{");
using (sb.Indent())
{
sb.Append($"public {className}(", true);
int count = 0;
foreach (var field in fieldList)
{
sb.Append($"{(count == 0 ? "" : ", ")}{field.TypeName} {field.Identifier}");
count++;
}
sb.AppendLine(")", false);
sb.AppendLine("{");
using (sb.Indent())
{
foreach (var field in fieldList)
{
sb.AppendLine($"this.{field.Identifier} = {field.Identifier};");
}
}
sb.AppendLine("}");
foreach (var field in fieldList)
{
sb.AppendLine($"public {field.TypeName} {GetSafeFieldName(field.Identifier)} {{ get => {field.Identifier}; set => {field.Identifier} = value; }}");
}
}
sb.AppendLine("}");
}
if (string.IsNullOrEmpty(clsNamespace) == false)
{
sb.AppendLine("}");
}
return sb.ToString();
}
private string GetSafeFieldName(string identifier)
{
if (identifier[0] == '_')
{
return identifier.Substring(0);
}
if (char.IsLower(identifier[0]))
{
return identifier[0].ToString().ToUpper() + identifier.Substring(1);
}
return identifier.ToUpper();
}
private List<AutoFieldInfo> GetFieldList(Compilation compilation, ClassDeclarationSyntax cls)
{
List<AutoFieldInfo> fieldList = new List<AutoFieldInfo>();
var model = compilation.GetSemanticModel(cls.SyntaxTree);
foreach (FieldDeclarationSyntax field in cls.DescendantNodes().OfType<FieldDeclarationSyntax>())
{
foreach (var item in field.Declaration.Variables)
{
AutoFieldInfo info = new AutoFieldInfo
{
Identifier = item.Identifier.ValueText,
TypeName = field.Declaration.Type.ToString()
};
fieldList.Add(info);
}
}
return fieldList;
}
}
public struct AutoFieldInfo
{
public string Identifier;
public string TypeName;
}
class AutoPropSyntaxReceiver : ISyntaxReceiver
{
public List<ClassDeclarationSyntax> AutoPropClasses = new List<ClassDeclarationSyntax>();
public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
{
if (syntaxNode is not ClassDeclarationSyntax cds)
{
return;
}
foreach (var item in cds.AttributeLists)
{
foreach (var attr in item.Attributes)
{
string attrName = attr.Name.ToString();
switch (attrName)
{
case "AutoProp":
case "System.AutoProp":
case "AutoPropAttribute":
case "System.AutoPropAttribute":
foreach (var mod in cds.Modifiers)
{
if (mod.ValueText == "partial")
{
AutoPropClasses.Add(cds);
return;
}
}
break;
}
}
}
}
}
}
이렇게 해서 Source Generator의 Version 1 규약을 이용해 자동 소스 코드 생성을 해봤습니다. ^^
(이 글의 소스 생성기 프로젝트는
PropertySrcGenerator이고, 그것을 적용한 예제 프로젝트는
PropertySrcSample입니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]