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

C# - Source Generator를 적용한 XmlCodeGenerator

Source Generator를 사용하면,

C# - Source Generator 소개
; https://www.sysnet.pe.kr/2/0/12223

예전에 만들어 둔 XmlCodeGenerator를,

Visual Studio 확장으로 XmlCodeGenerator 제작하는 방법
; https://www.sysnet.pe.kr/2/0/1518

Visual Studio Gallery - XmlCodeGenerator
; http://visualstudiogallery.msdn.microsoft.com/20163975-c675-4f1c-986f-d2489136469d

Visual Studio 도구가 아닌, 프로젝트 내에서의 참조로 해결할 수 있습니다. 하는 김에 지금 업데이트를 해볼까요? ^^ 간단하게 기존 XmlCodeGenerator 솔루션에,

stjeong / XmlCodeGenerator
; https://github.com/stjeong/XmlCodeGenerator

.NET Standard Library 유형의 XmlSrcGenerator 프로젝트를 추가하고, ISourceGenerator로서 동작하기 위한 패키지 참조를 한 후,

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

기존의 XML + XSLT 처리를 담당하는 코드를 추가만 하면 끝입니다.

[Generator]
public class SourceCodeGenerator : ISourceGenerator
{
    static Dictionary<string, XslCompiledTransform> xsltDict = new Dictionary<string, XslCompiledTransform>();
    internal const string DefaultXslFileName = "default.xslt";

    public void Execute(SourceGeneratorContext context)
    {
        string fileNamespace = context.Compilation.GlobalNamespace.GetNamespaceMembers().First().ToDisplayString();

        foreach (AdditionalText item in context.AdditionalFiles)
        {
            if (item.Path.EndsWith(".xml", StringComparison.OrdinalIgnoreCase) == false)
            {
                continue;
            }

            string baseFolder = Path.GetDirectoryName(item.Path);

            string txt = GenerateCode(item.Path, fileNamespace, baseFolder);
            string fileName = Path.GetFileNameWithoutExtension(item.Path) + ".partial.xml";

            context.AddSource(fileName, SourceText.From(txt, Encoding.UTF8));
        }
    }

    // ...[생략]....
}




일단, 저런 식으로 개발된 Source Generator를 사용하는 측에서 보면, 참조 후에 수작업으로 다음의 항목을 csproj에 추가해야 하는데 다소 불편한 점이 있습니다.

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

이러한 불편을 덜어줄 수 있는 것이 바로 "Analyzer"로서 NuGet에 등록하는 것입니다. 실제로 제가 다음의 NuGet repo에 XmlSrcGenerator를 등록해 두었으니,

XmlSrcGenerator
; https://www.nuget.org/packages/XmlSrcGenerator/

사용하는 측에서는 해당 패키지를 참조하고,

Install-Package XmlSrcGenerator -Version 1.0.5

XML과 XSLT 파일을 추가한 후 다음과 같이 XML 파일에 대해 Build Action을 "C# analyzer additional file"로 설정해 주면,

xml_code_gen_1.png

컴파일 시에, XML + XSLT로 출력된 소스 코드를 포함시켜 빌드를 완성하게 됩니다. (첨부 파일은 위의 예제 프로젝트를 포함합니다.)




참고로, Build Action을 "C# analyzer additional file"로 설정해 주면, SourceGeneratorContext의 AdditionalFiles로 열람할 수 있습니다.

using Microsoft.CodeAnalysis;
using System;

namespace XmlCodeGenerator
{
    public class SourceCodeGenerator : ISourceGenerator
    {
        public void Execute(SourceGeneratorContext context)
        {
            foreach (AdditionalText item in context.AdditionalFiles)
            {
                // "C# analyzer additional file"로 설정된 파일 열거
            }
        }

        public void Initialize(InitializationContext context)
        {
        }
    }
}




그나저나, XmlCodeGenerator처럼 Visual Studio의 확장으로 개발하는 것이 좋을까요? XmlSrcGenerator처럼 Analyzer로서 개발하는 것이 좋을까요? 사실, 도구로서 개발하는 것은 너무 불편합니다. VS Extension을 개발해 보신 분들이라면, 참조한 어셈블리 중 Microsoft.VisualStudio.Shell.11.0, Microsoft.VisualStudio.Shell.Interop.8.0 등에서의 버전 번호가 아주 지긋지긋하게 느껴졌을 것입니다. ^^ 이러한 VS.NET IDE의 버전 의존성이 Analyzer로서 개발하면 없어진다는 것 자체가 장점입니다.

게다가, 소스 코드 생성을 하려면 VS.NET IDE 내에서만 가능하다는 것도 도구로 개발했을 때의 단점입니다. Analyzer로서 동작하면 Visual Studio Code뿐만 아니라 명령행 빌드에서까지 자유롭게 소스 코드 생성을 할 수 있으므로 범용성이 향상됩니다.




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

[연관 글]


donaricano-btn



[최초 등록일: ]
[최종 수정일: 6/30/2021

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

비밀번호

댓글 쓴 사람
 




[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12839정성태9/15/2021227.NET Framework: 1118. C# 10 - (17) 제네릭 타입의 특성 적용파일 다운로드1
12838정성태9/13/2021228.NET Framework: 1117. C# - Task에 전달한 Action, Func 유형에 따라 달라지는 async/await 비동기 처리 [2]파일 다운로드1
12837정성태9/11/2021132VC++: 151. Golang - fmt.Errorf, errors.Is, errors.As 설명
12836정성태9/10/202188Linux: 45. 리눅스 - 실행 중인 다른 프로그램의 출력을 확인하는 방법
12835정성태9/7/2021160.NET Framework: 1116. C# 10 - (16) CallerArgumentExpression 특성 추가파일 다운로드1
12834정성태9/7/202183오류 유형: 762. Visual Studio 2019 Build Tools - 'C:\Program' is not recognized as an internal or external command, operable program or batch file.
12833정성태9/6/2021146VC++: 150. Golang - TCP client/server echo 예제 코드파일 다운로드1
12832정성태9/6/202185VC++: 149. Golang - 인터페이스 포인터가 의미 있을까요?
12831정성태9/6/2021119VC++: 148. Golang - 채널에 따른 다중 작업 처리파일 다운로드1
12830정성태9/6/202184오류 유형: 761. Internet Explorer에서 파일 다운로드 시 "Your current security settings do not allow this file to be downloaded." 오류
12829정성태9/5/2021211.NET Framework: 1115. C# 10 - (15) 구조체 타입에 기본 생성자 정의 가능파일 다운로드1
12828정성태9/4/2021198.NET Framework: 1114. C# 10 - (14) 단일 파일 내에 적용되는 namespace 선언파일 다운로드1
12827정성태9/4/2021114스크립트: 27. 파이썬 - 웹 페이지 데이터 수집을 위한 scrapy Crawler 사용법 요약
12826정성태9/3/2021170.NET Framework: 1113. C# 10 - (13) 문자열 보간 성능 개선파일 다운로드1
12825정성태9/3/202171개발 환경 구성: 603. GoLand - WSL 환경과 연동
12824정성태9/2/2021151오류 유형: 760. 파이썬 tensorflow - Dst tensor is not initialized. 오류 메시지
12823정성태9/2/2021164스크립트: 26. 파이썬 - PyCharm을 이용한 fork 디버그 방법
12822정성태9/1/202198오류 유형: 759. 파이썬 tensorflow - ValueError: Shapes (...) and (...) are incompatible
12821정성태9/1/2021150.NET Framework: 1112. C# - .NET 6부터 공개된 ISpanFormattable 사용법
12820정성태9/1/202187VC++: 147. Golang - try/catch에 대응하는 panic/recover파일 다운로드1
12819정성태8/31/2021185.NET Framework: 1111. C# - FormattableString 타입
12818정성태8/31/2021119Windows: 198. 윈도우 - 작업 관리자에서 (tensorflow 등으로 인한) GPU 연산 부하 보는 방법
12817정성태8/31/202178스크립트: 25. 파이썬 - 윈도우 환경에서 directml을 이용한 tensorflow의 AMD GPU 사용 방법
12816정성태8/30/2021336스크립트: 24. 파이썬 - tensorflow 2.6 NVidia GPU 사용 방법 [2]
12815정성태8/30/2021199개발 환경 구성: 602. WSL 2 - docker-desktop-data, docker-desktop (%LOCALAPPDATA%\Docker\wsl\data\ext4.vhdx) 파일을 다른 디렉터리로 옮기는 방법
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...