Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 
(연관된 글이 6개 있습니다.)

Roslyn 맛보기 - Roslyn Services APIs를 이용한 Code Issue 및 Code Action 기능 소개


Roslyn 맛보기 (1) - C# 소스 코드를 스크립트 처럼 다루는 방법
Roslyn 맛보기 (2) - C# Interactive (1)
Roslyn 맛보기 (3) - C# Interactive (2)
Roslyn 맛보기 (4) - Roslyn Services APIs를 이용한 Code Issue 및 Code Action 기능 소개
Roslyn 맛보기 (5) - Syntax Analysis (Roslyn Syntax API)
Roslyn 맛보기 (6) - Roslyn Symbol / Binding API
Roslyn 맛보기 (7) - SyntaxTree 조작

Roslyn CTP 버전을 설치하면, 새롭게 몇 가지 유형의 프로젝트 템플릿이 추가됩니다.

  • Console Application
  • Code Issue
  • Code Refactoring
  • Completion Provider
  • Outliner

일단, 위의 프로젝트 유형에서 "Console Application"은 이미 지난번에 살펴본 글에서 실습을 해본 것이나 다름이 없습니다.

Roslyn 맛보기 - C# 소스 코드를 스크립트 처럼 다루는 방법
; https://www.sysnet.pe.kr/2/0/1153

즉, 일반 "Console Application" 에서 "Roslyn.Compilers", "Roslyn.Compilers.CSharp" 2개의 어셈블리를 추가하고 기본 생성되는 Program.cs 파일에 using 문 2개를 추가한 것에 불과합니다.

using Roslyn.Compilers;
using Roslyn.Compilers.CSharp;

그리고, 이번에는 "Code Issue" 프로젝트 유형을 다뤄볼 텐데요. 미리 말씀드리면, 이번 글은 "%PROGRAMFILES% (x86)\Microsoft Codename Roslyn CTP\Documentation\How to Write a Quick Fix (CSharp).docx" 문서를 요약했다고 보시면 됩니다.




"Code Issue"가 구체적으로 어떤 것인지 알고 싶다면, Visual Studio에서 해당 템플릿 프로젝트를 하나 생성해서 "F5 디버깅"을 해보면 금방 알 수 있습니다. 왜냐하면, "Code Issue" 프로젝트를 생성하면 기본적인 예제 코드가 포함되어 있기 때문인데요.

다음 화면은 제가 "FirstQuickFix"라는 이름으로 "Code Issue" 프로젝트를 만들었을 때의 최초 생성 파일들입니다.

csharp_code_issue_1.png

예제로 하나 추가된 "CodeIssueProvider.cs" 파일은 다음과 같이 간단한 코드로 이뤄져 있는데,

namespace FirstQuickFix
{
    [ExportSyntaxNodeCodeIssueProvider("FirstQuickFix", LanguageNames.CSharp)]
    class CodeIssueProvider : ICodeIssueProvider
    {
        private readonly ICodeActionEditFactory editFactory;

        [ImportingConstructor]
        public CodeIssueProvider(ICodeActionEditFactory editFactory)
        {
            this.editFactory = editFactory;
        }

        public IEnumerable<CodeIssue> GetIssues(IDocument document, CommonSyntaxNode node, CancellationToken cancellationToken)
        {
            var tokens = from nodeOrToken in node.ChildNodesAndTokens()
                         where nodeOrToken.IsToken
                         select nodeOrToken.AsToken();

            foreach (var token in tokens)
            {
                var tokenText = token.GetText();

                if (tokenText.Contains('a'))
                {
                    var issueDescription = string.Format("'{0}' contains the letter 'a'", tokenText);
                    yield return new CodeIssue(CodeIssue.Severity.Warning, token.Span, issueDescription);
                }
            }
        }

        public IEnumerable<CodeIssue> GetIssues(IDocument document, CommonSyntaxToken token, CancellationToken cancellationToken)
        {
            throw new NotImplementedException();
        }

        public IEnumerable<CodeIssue> GetIssues(IDocument document, CommonSyntaxTrivia trivia, CancellationToken cancellationToken)
        {
            throw new NotImplementedException();
        }
    }
}

의미는 매우 간단합니다. C# 코드에 포함된 "모든 토큰"의 이름에 대해서 "a"라는 문자를 포함하고 있으면 "Issue" 제기를 하도록 되어 있습니다.

재미있는 것은 "Code Issue" 프로젝트의 경우, 프로젝트 속성의 "Debug" 탭에 "Start" 옵션이 다음과 같이 설정되어 있기 때문에,

Start Action: 
    - Start external program: %PROGRAMFILES% (x86)%\Microsoft Visual Studio 10.0\Common7\IDE\devenv.exe

Start Options:
    - Command line arguments: /rootsuffix Roslyn

"F5 디버깅"을 하게 되면 새로운 Visual Studio 인스턴스가 하나 뜨면서 디버깅이 가능한 상태로 됩니다.

일례로, "CodeIssueProvider.cs" 파일에 정의된 CodeIssueProvider.GetIssues 메서드에 BP(BreakPoint)를 걸고 F5 디버깅 상태로 진입한 후 새로운 Visual Studio 인스턴스에서 임의의 C# 프로젝트를 하나 생성하고 cs 파일을 열면 BP가 걸리는 것을 확인할 수 있습니다.

csharp_code_issue_2.png

그리고 모든 실행이 완료되었을 때, 즉 컴파일러에 의한 구문 해석이 모두 끝났을 때 다음과 같이 cs 파일에는 "a" 문자를 포함한 모든 토큰에 대해 "{0}contains the letter 'a'"라는 경고 메시지가 나타나게 됩니다.

csharp_code_issue_3.png

이 정도면, "Code Issue" 프로젝트가 무엇인지 감이 잡히시죠? ^^




"Code Issue"의 흔한 예로는 "Source Code Analysis"를 들 수 있습니다. 그 한 예로, "StyleCop"이 있는데요. 만약, 기존에 우리가 그런 도구를 만들고 싶다면 어떻게 해야 했을까요? 말 그대로 C# 구문 해석기를 직접 제작하든지, 아니면 다음과 같은 이미 만들어진 구문 분석기를 활용해야만 했습니다.

Irony - Language Implementation Kit
; https://www.sysnet.pe.kr/2/2/177

그런데, "Roslyn"이 나옴으로써 이제는 "Roslyn Services APIs"를 이용하여 C# 구문을 제대로 분석해낼 수 있게 된 것입니다. C#을 만든 마이크로소프트 측에서 제공해 준 것이니, 이만큼 확실한 라이브러리가 있을 수는 없겠지요. ^^

참고로, "How to Write a Quick Fix (CSharp).docx" 문서에서는 예제를 하나 더 소개하고 있습니다. 예를 들어, 다음과 같이 정의된 변수가 있는 경우,

int x = 0;
Console.WriteLine(x);

구문 분석을 통해 "const"로 변경할 수 있는 상황이라면 그에 대한 권고를 해주는 예제입니다.

csharp_code_issue_4.png

관심있으신 분은 해당 문서를 살펴보시면 정보를 좀 더 얻을 수 있을 것입니다.

마지막으로, "Code Action" 기능은 뭘까요? 예를 들자면, "Code Issue"를 통해 "const"로 바꿀 것을 권고하는 것으로 끝나지 않고, 사용자로 하여금 간단한 버튼 클릭만으로 "const"로 코드를 자동으로 바꿔주는 동작을 말합니다. 즉, "Code Action" 기능을 제공하면 아래의 화면에 보는 것처럼 "Ctrl + ." 키를 눌러 나오는 메뉴에 사용자가 직접 선택할 수 있는 "Code Action" 동작을 지정할 수 있습니다.

csharp_code_issue_5.png

여기까지, 이번 주제에 대한 설명은 모두 끝났습니다.

그나저나... Code Issue / Code Action 기능은 일반 개발자들 입장에서는 그다지 매력적이지는 않을 것 같습니다. 프레임워크 개발자나, 사내에서 사용될 "Naming Rule" 등을 강제화하고 싶을 때 사용될 수 있겠지만... 과연 국내 개발 환경에서 적극적으로 이런 plug-in을 만들 개발자(또는 개발팀)들이 있을까 의문이군요. ^^




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

[연관 글]






[최초 등록일: ]
[최종 수정일: 7/10/2021]

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

비밀번호

댓글 작성자
 



2021-04-16 10시08분
My first Roslyn analyzer
; https://medium.com/xfaang/my-first-roslyn-analyzer-88de75bf81cd

How to Distribute Roslyn Analyzers via NuGet
; https://aaronstannard.com/roslyn-nuget/
정성태

... 76  77  78  79  80  81  82  [83]  84  85  86  87  88  89  90  ...
NoWriterDateCnt.TitleFile(s)
11861정성태4/6/201919583디버깅 기술: 126. windbg - .NET x86 CLR2/CLR4 EXE의 EntryPoint
11860정성태4/5/201923424오류 유형: 527. Visual C++ 컴파일 오류 - error C2220: warning treated as error - no 'object' file generated
11859정성태4/4/201920652디버깅 기술: 125. WinDbg로 EXE의 EntryPoint에서 BP 거는 방법
11858정성태3/27/201921563VC++: 129. EXE를 LoadLibrary로 로딩해 PE 헤더에 있는 EntryPoint를 직접 호출하는 방법파일 다운로드1
11857정성태3/26/201919465VC++: 128. strncpy 사용 시 주의 사항(Linux / Windows)
11856정성태3/25/201919738VS.NET IDE: 134. 마이크로소프트의 CoreCLR 프로파일러 리눅스 예제를 Visual Studio F5 원격 디버깅하는 방법 [1]파일 다운로드1
11855정성태3/25/201921867개발 환경 구성: 436. 페이스북 HTTPS 인증을 localhost에서 테스트하는 방법
11854정성태3/25/201917537VS.NET IDE: 133. IIS Express로 호스팅하는 사이트를 https로 접근하는 방법
11853정성태3/24/201920322개발 환경 구성: 435. 존재하지 않는 IP 주소에 대한 Dns.GetHostByAddress/gethostbyaddr/GetNameInfoW 실행이 느리다면? - 두 번째 이야기 [1]
11852정성태3/20/201919566개발 환경 구성: 434. 존재하지 않는 IP 주소에 대한 Dns.GetHostByAddress/gethostbyaddr/GetNameInfoW 실행이 느리다면?파일 다운로드1
11851정성태3/19/201923329Linux: 8. C# - 리눅스 환경에서 DllImport 대신 라이브러리 동적 로드 처리 [2]
11850정성태3/18/201922309.NET Framework: 813. C# async 메서드에서 out/ref/in 유형의 인자를 사용하지 못하는 이유
11849정성태3/18/201921742.NET Framework: 812. pscp.exe 기능을 C#으로 제어하는 방법파일 다운로드1
11848정성태3/17/201918444스크립트: 14. 윈도우 CMD - 파일이 변경된 경우 파일명을 변경해 복사하고 싶다면?
11847정성태3/17/201922922Linux: 7. 리눅스 C/C++ - 공유 라이브러리 동적 로딩 후 export 함수 사용 방법파일 다운로드1
11846정성태3/15/201921534Linux: 6. getenv, setenv가 언어/운영체제마다 호환이 안 되는 문제
11845정성태3/15/201921733Linux: 5. Linux 응용 프로그램의 (C++) so 의존성 줄이기(ReleaseMinDependency) [3]
11844정성태3/14/201923029개발 환경 구성: 434. Visual Studio 2019 - 리눅스 프로젝트를 이용한 공유/실행(so/out) 프로그램 개발 환경 설정 [1]파일 다운로드1
11843정성태3/14/201918000기타: 75. MSDN 웹 사이트를 기본으로 영문 페이지로 열고 싶다면?
11842정성태3/13/201916351개발 환경 구성: 433. 마이크로소프트의 CoreCLR 프로파일러 예제를 Visual Studio CMake로 빌드하는 방법 [1]파일 다운로드1
11841정성태3/13/201916661VS.NET IDE: 132. Visual Studio 2019 - CMake의 컴파일러를 기본 g++에서 clang++로 변경
11840정성태3/13/201918273오류 유형: 526. 윈도우 10 Ubuntu App 환경에서는 USB 외장 하드 접근 불가
11839정성태3/12/201922175디버깅 기술: 124. .NET Core 웹 앱을 호스팅하는 Azure App Services의 프로세스 메모리 덤프 및 windbg 분석 개요 [3]
11838정성태3/7/201925790.NET Framework: 811. (번역글) .NET Internals Cookbook Part 1 - Exceptions, filters and corrupted processes [1]파일 다운로드1
11837정성태3/6/201939752기타: 74. 도서: 시작하세요! C# 7.3 프로그래밍 [10]
11836정성태3/5/201923318오류 유형: 525. Visual Studio 2019 Preview 4/RC - C# 8.0 Missing compiler required member 'System.Range..ctor' [1]
... 76  77  78  79  80  81  82  [83]  84  85  86  87  88  89  90  ...