Microsoft MVP성태의 닷넷 이야기
.NET Framework: 909. C# - Source Generator를 적용한 XmlCodeGenerator [링크 복사], [링크+제목 복사]
조회: 1960
글쓴 사람
정성태 (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

비밀번호

댓글 쓴 사람
 




... 16  17  18  19  20  21  22  23  24  25  26  27  28  29  [30]  ...
NoWriterDateCnt.TitleFile(s)
12111정성태1/12/20203377디버깅 기술: 155. C# - KernelMemoryIO 드라이버를 이용해 실행 프로그램을 숨기는 방법(DKOM: Direct Kernel Object Modification) [12]
12110정성태1/11/20202826디버깅 기술: 154. Patch Guard로 인해 블루 스크린(BSOD)가 발생하는 사례 [5]파일 다운로드1
12109정성태1/10/20202315오류 유형: 588. Driver 프로젝트 빌드 오류 - Inf2Cat error -2: "Inf2Cat, signability test failed."
12108정성태1/10/20202104오류 유형: 587. Kernel Driver 시작 시 127(The specified procedure could not be found.) 오류 메시지 발생
12107정성태1/10/20202279.NET Framework: 877. C# - 프로세스의 모든 핸들을 열람 - 두 번째 이야기
12106정성태1/8/20202913VC++: 136. C++ - OSR Driver Loader와 같은 Legacy 커널 드라이버 설치 프로그램 제작 [1]
12105정성태1/8/20202351디버깅 기술: 153. C# - PEB를 조작해 로드된 DLL을 숨기는 방법
12104정성태1/7/20202583DDK: 9. 커널 메모리를 읽고 쓰는 NT Legacy driver와 C# 클라이언트 프로그램 [4]
12103정성태1/7/20204168DDK: 8. Visual Studio 2019 + WDK Legacy Driver 제작- Hello World 예제 [1]파일 다운로드2
12102정성태1/6/20202816디버깅 기술: 152. User 권한(Ring 3)의 프로그램에서 _ETHREAD 주소(및 커널 메모리를 읽을 수 있다면 _EPROCESS 주소) 구하는 방법
12101정성태1/5/20202370.NET Framework: 876. C# - PEB(Process Environment Block)를 통해 로드된 모듈 목록 열람
12100정성태1/3/20201992.NET Framework: 875. .NET 3.5 이하에서 IntPtr.Add 사용
12099정성태1/3/20202573디버깅 기술: 151. Windows 10 - Process Explorer로 확인한 Handle 정보를 windbg에서 조회
12098정성태1/2/20202459.NET Framework: 874. C# - 커널 구조체의 Offset 값을 하드 코딩하지 않고 사용하는 방법 [3]
12097정성태1/2/20201967디버깅 기술: 150. windbg - Wow64, x86, x64에서의 커널 구조체(예: TEB) 구조체 확인
12096정성태12/30/20192355디버깅 기술: 149. C# - DbgEng.dll을 이용한 간단한 디버거 제작
12095정성태12/27/20192689VC++: 135. C++ - string_view의 동작 방식
12094정성태12/26/20192428.NET Framework: 873. C# - 코드를 통해 PDB 심벌 파일 다운로드 방법
12093정성태12/26/20192819.NET Framework: 872. C# - 로딩된 Native DLL의 export 함수 목록 출력파일 다운로드1
12092정성태12/25/20192544디버깅 기술: 148. cdb.exe를 이용해 (ntdll.dll 등에 정의된) 커널 구조체 출력하는 방법
12091정성태12/25/20193576디버깅 기술: 147. pdb 파일을 다운로드하기 위한 symchk.exe 실행에 필요한 최소 파일 [1]
12090정성태12/24/20192414.NET Framework: 871. .NET AnyCPU로 빌드된 PE 헤더의 로딩 전/후 차이점
12089정성태12/23/20192399디버깅 기술: 146. gflags와 _CrtIsMemoryBlock을 이용한 Heap 메모리 손상 여부 체크
12088정성태12/23/20192213Linux: 28. Linux - 윈도우의 "Run as different user" 기능을 shell에서 실행하는 방법
12087정성태12/21/20192149디버깅 기술: 145. windbg/sos - Dictionary의 entries 배열 내용을 모두 덤프하는 방법 (do_hashtable.py) [1]
12086정성태12/20/20192809디버깅 기술: 144. windbg - Marshal.FreeHGlobal에서 발생한 덤프 분석 사례
... 16  17  18  19  20  21  22  23  24  25  26  27  28  29  [30]  ...