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

비밀번호

댓글 작성자
 




... [181]  182  183  184  185  186  187  188  189  190  191  192  193  194  195  ...
NoWriterDateCnt.TitleFile(s)
458정성태2/12/200721810.NET Framework: 81. LINQ 개발 환경 설정 [1]
457정성태2/8/200726274.NET Framework: 80. LINQ 관련 용어 정리 및 리소스 소개 [2]
456정성태2/6/200724537Windows: 22. 가상화에 대해서.
455정성태2/4/200719364오류 유형: 25. 원격 데스크톱 환경에서의 Virtual Server 관리 환경 제어
454정성태2/4/200716890오류 유형: 24. VPC에서의 Vista 네트워킹 문제
509손대성6/24/200718982    답변글 오류 유형: 24.1. [답변]: 오류 유형 : 23. VPC 에서의 Vista 네트워킹 문제
453정성태2/4/200725050개발 환경 구성: 21. 서버 측 SoapExtension을 클라이언트에 알리고 싶다
452정성태1/31/200724776VC++: 31. 비스타에서 VS.NET 2005로 COM 프로젝트 빌드시 오류 [2]
451정성태1/31/200723929Windows: 21. Preview Handler 소개
450정성태1/30/200732222VS.NET IDE: 43. .NET에서의 필수 무결성 제어 조절하는 방법 - Manifest 파일 이용파일 다운로드2
449정성태2/4/200729034Windows: 20. UAC 이모저모 [2]
448정성태1/28/200724717Windows: 19. 3가지 유형의 가젯 프로그램
447정성태1/27/200721878Windows: 18. 비스타 도구 - 사양 정보 및 도구(Performance Information and Tools)
446정성태1/27/200730842VC++: 30. 필수 무결성 제어를 조절하는 방법(2) - 직접 코딩파일 다운로드1
445정성태2/8/200729405VC++: 29. 필수 무결성 제어를 조절하는 방법(1) - Manifest 파일 이용파일 다운로드2
444정성태1/27/200722859VC++: 28. 비스타 응용 프로그램 개발을 위한 VS.NET 2005 환경 설정
443정성태1/26/200721294VC++: 27. COM 개체로 인해 IE 7 비스타 버전이 종료될 때 오류 화면이 뜬다면?파일 다운로드1
442정성태1/24/200724302.NET Framework: 79. 새로운 암호화 클래스 (ECDsaCng, ECDiffieHellmanCng) 소개 [1]
441정성태1/23/200729030Windows: 17. 보안 데스크톱에서 활성화되지 않은 UAC 창이 안전할까?
440정성태1/24/200723120.NET Framework: 78. C# 3.0 - Anonymous types [1]
439정성태1/25/200724146.NET Framework: 77. C# 3.0 - Lambda 표현식 [1]
438정성태1/24/200723615.NET Framework: 76. C# 3.0 - 확장 함수
437정성태1/23/200731094Windows: 16. 개발자를 위한 UAC 환경 설정 [3]
436정성태1/17/200720255VS.NET IDE: 42. Orcas 2007년 1월 CTP 버전 설치 [5]
435정성태1/14/200719904기타: 17. 베타 제품과 최종 제품은 다르다 [2]
434정성태2/4/200723495Windows: 15. MIC 환경 구성 - Windows XP와 유사한 보안 설정 [4]
... [181]  182  183  184  185  186  187  188  189  190  191  192  193  194  195  ...