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

비밀번호

댓글 작성자
 




... 31  32  33  34  35  36  37  38  39  40  41  42  43  [44]  45  ...
NoWriterDateCnt.TitleFile(s)
12535정성태2/9/20219221개발 환경 구성: 541. Wireshark로 확인하는 LSO(Large Send Offload), RSC(Receive Segment Coalescing) 옵션
12534정성태2/8/20219794개발 환경 구성: 540. Wireshark + C/C++로 확인하는 TCP 연결에서의 closesocket 동작 [1]파일 다운로드1
12533정성태2/8/20219457개발 환경 구성: 539. Wireshark + C/C++로 확인하는 TCP 연결에서의 shutdown 동작파일 다운로드1
12532정성태2/6/20219947개발 환경 구성: 538. Wireshark + C#으로 확인하는 ReceiveBufferSize(SO_RCVBUF), SendBufferSize(SO_SNDBUF) [3]
12531정성태2/5/20218976개발 환경 구성: 537. Wireshark + C#으로 확인하는 PSH flag와 Nagle 알고리듬파일 다운로드1
12530정성태2/4/202113147개발 환경 구성: 536. Wireshark + C#으로 확인하는 TCP 통신의 Receive Window
12529정성태2/4/202110196개발 환경 구성: 535. Wireshark + C#으로 확인하는 TCP 통신의 MIN RTO [1]
12528정성태2/1/20219594개발 환경 구성: 534. Wireshark + C#으로 확인하는 TCP 통신의 MSS(Maximum Segment Size) - 윈도우 환경
12527정성태2/1/20219804개발 환경 구성: 533. Wireshark + C#으로 확인하는 TCP 통신의 MSS(Maximum Segment Size) - 리눅스 환경파일 다운로드1
12526정성태2/1/20217665개발 환경 구성: 532. Azure Devops의 파이프라인 빌드 시 snk 파일 다루는 방법 - Secure file
12525정성태2/1/20217388개발 환경 구성: 531. Azure Devops - 파이프라인 실행 시 빌드 이벤트를 생략하는 방법
12524정성태1/31/20218477개발 환경 구성: 530. 기존 github 프로젝트를 Azure Devops의 빌드 Pipeline에 연결하는 방법 [1]
12523정성태1/31/20218525개발 환경 구성: 529. 기존 github 프로젝트를 Azure Devops의 Board에 연결하는 방법
12522정성태1/31/202110023개발 환경 구성: 528. 오라클 클라우드의 리눅스 VM - 9000 MTU Jumbo Frame 테스트
12521정성태1/31/20219988개발 환경 구성: 527. 이더넷(Ethernet) 환경의 TCP 통신에서 MSS(Maximum Segment Size) 확인 [1]
12520정성태1/30/20218529개발 환경 구성: 526. 오라클 클라우드의 VM에 ping ICMP 여는 방법
12519정성태1/30/20217596개발 환경 구성: 525. 오라클 클라우드의 VM을 외부에서 접근하기 위해 포트 여는 방법
12518정성태1/30/202125050Linux: 37. Ubuntu에 Wireshark 설치 [2]
12517정성태1/30/202112685Linux: 36. 윈도우 클라이언트에서 X2Go를 이용한 원격 리눅스의 GUI 접속 - 우분투 20.04
12516정성태1/29/20219323Windows: 188. Windows - TCP default template 설정 방법
12515정성태1/28/202110553웹: 41. Microsoft Edge - localhost에 대해 http 접근 시 무조건 https로 바뀌는 문제 [3]
12514정성태1/28/202110809.NET Framework: 1021. C# - 일렉트론 닷넷(Electron.NET) 소개 [1]파일 다운로드1
12513정성태1/28/20218866오류 유형: 698. electronize - User Profile 디렉터리에 공백 문자가 있는 경우 빌드가 실패하는 문제 [1]
12512정성태1/28/20218652오류 유형: 697. The program can't start because VCRUNTIME140.dll is missing from your computer. Try reinstalling the program to fix this problem.
12511정성태1/27/20218373Windows: 187. Windows - 도스 시절의 8.3 경로를 알아내는 방법
12510정성태1/27/20218759.NET Framework: 1020. .NET Core Kestrel 호스팅 - Razor 지원 추가 [1]파일 다운로드1
... 31  32  33  34  35  36  37  38  39  40  41  42  43  [44]  45  ...