Microsoft MVP성태의 닷넷 이야기
.NET Framework: 909. C# - Source Generator를 적용한 XmlCodeGenerator [링크 복사], [링크+제목 복사],
조회: 19554
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 2개 있습니다.)
(시리즈 글이 4개 있습니다.)
.NET Framework: 908. C# - Source Generator 소개
; https://www.sysnet.pe.kr/2/0/12223

.NET Framework: 909. C# - Source Generator를 적용한 XmlCodeGenerator
; https://www.sysnet.pe.kr/2/0/12228

.NET Framework: 1167. C# -Version 1 Source Generator 실습
; https://www.sysnet.pe.kr/2/0/12985

.NET Framework: 1168.  C# -IIncrementalGenerator를 적용한 Version 2 Source Generator 실습
; https://www.sysnet.pe.kr/2/0/12986




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뿐만 아니라 명령행 빌드에서까지 자유롭게 소스 코드 생성을 할 수 있으므로 범용성이 향상됩니다.




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

[연관 글]






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

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

비밀번호

댓글 작성자
 




... 106  107  108  [109]  110  111  112  113  114  115  116  117  118  119  120  ...
NoWriterDateCnt.TitleFile(s)
11199정성태5/16/201721185.NET Framework: 657. CultureInfo.GetCultures가 반환하는 값
11198정성태5/10/201722678.NET Framework: 656. Windows Forms의 오류(Exception) 처리 방법에 대한 차이점 설명
11197정성태5/8/201719600개발 환경 구성: 315. VHD 파일의 최소 크기파일 다운로드1
11196정성태5/4/201720803오류 유형: 384. Msvm_ImageManagementService WMI 객체를 사용할 때 오류 상황 정리 [1]
11195정성태5/3/201721101.NET Framework: 655. .NET Framework 4.7 릴리스
11194정성태5/3/201723271오류 유형: 383. net use 명령어로 네트워크 드라이브 연결 시 "System error 67 has occurred." 오류 발생
11193정성태5/3/201721592Windows: 141. 설치된 Windows로부터 설치 이미지를 만드는 방법
11192정성태5/2/201722156Windows: 140. unattended.xml/autounattend.xml 파일을 마련하는 방법
11191정성태5/2/201722877Windows: 139. Dell Venue 8 Pro 태블릿에 USB를 이용한 윈도우 운영체제 설치 방법
11190정성태5/2/201728223Windows: 138. Windows 운영체제의 ISO 설치 파일에 미리 Device driver를 준비하는 방법
11189정성태5/2/201720238Windows: 137. Windows 7 USB/DVD DOWNLOAD TOOL로 98%에서 실패하는 경우
11188정성태4/27/201722704VC++: 118. Win32 HANDLE 자료형의 이모저모 [1]
11187정성태4/26/201723268개발 환경 구성: 314. C# - PowerPoint 확장 Add-in 만드는 방법 [1]파일 다운로드1
11186정성태4/24/201721051VS.NET IDE: 117. Visual Studio 확장(VSIX)을 이용해 사용자 매크로를 추가하는 방법 [1]파일 다운로드1
11185정성태4/22/201718977VS.NET IDE: 116. Visual Studio 확장(VSIX)을 이용해 사용자 메뉴 추가하는 방법 (2) - 동적 메뉴 구성파일 다운로드1
11184정성태4/21/201720621VS.NET IDE: 115. Visual Studio 확장(VSIX)을 이용해 사용자 메뉴 추가하는 방법파일 다운로드1
11183정성태4/19/201719472.NET Framework: 654. UWP 앱에서 FolderPicker 사용 시 유의 사항파일 다운로드1
11182정성태4/19/201723482개발 환경 구성: 313. Nuget Facebook 라이브러리를 이용해 ASP.NET 웹 폼과 로그인 연동하는 방법
11181정성태4/18/201720393개발 환경 구성: 312. Azure Web Role의 AppPool 실행 권한을 Local System으로 바꾸는 방법
11180정성태4/16/201723422Java: 18. Java의 Memory Mapped File 자원 반환이 안 되는 문제
11179정성태4/13/201716563기타: 64. SVG Converter 스토어 앱 개인정보 보호 정책 안내
11178정성태4/10/201718769개발 환경 구성: 311. COM+ 관리자의 DCOM 구성에 나오는 기준
11177정성태4/7/201719184.NET Framework: 653. C# 7 새로운 문법(1) - 더욱 편리해진 Out 변수 사용파일 다운로드1
11176정성태4/5/201716227VC++: 117. Visual Studio - ATL COM 개체를 단위 테스트 하는 방법
11175정성태4/5/201725919.NET Framework: 652. C# 개발자를 위한 C++ COM 객체의 기본 구현 방식 설명파일 다운로드1
11174정성태4/3/201719448VC++: 116. Visual Studio 단위 테스트 - Failed to set up the execution context to run the test
... 106  107  108  [109]  110  111  112  113  114  115  116  117  118  119  120  ...