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" 프로젝트를 만들었을 때의 최초 생성 파일들입니다.
예제로 하나 추가된 "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가 걸리는 것을 확인할 수 있습니다.
그리고 모든 실행이 완료되었을 때, 즉 컴파일러에 의한 구문 해석이 모두 끝났을 때 다음과 같이 cs 파일에는 "a" 문자를 포함한 모든 토큰에 대해 "{0}contains the letter 'a'"라는 경고 메시지가 나타나게 됩니다.
이 정도면, "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"로 변경할 수 있는 상황이라면 그에 대한 권고를 해주는 예제입니다.
관심있으신 분은 해당 문서를 살펴보시면 정보를 좀 더 얻을 수 있을 것입니다.
마지막으로, "Code Action" 기능은 뭘까요? 예를 들자면, "Code Issue"를 통해 "const"로 바꿀 것을 권고하는 것으로 끝나지 않고, 사용자로 하여금 간단한 버튼 클릭만으로 "const"로 코드를 자동으로 바꿔주는 동작을 말합니다. 즉, "Code Action" 기능을 제공하면 아래의 화면에 보는 것처럼 "Ctrl + ." 키를 눌러 나오는 메뉴에 사용자가 직접 선택할 수 있는 "Code Action" 동작을 지정할 수 있습니다.
여기까지, 이번 주제에 대한 설명은 모두 끝났습니다.
그나저나... Code Issue / Code Action 기능은 일반 개발자들 입장에서는 그다지 매력적이지는 않을 것 같습니다. 프레임워크 개발자나, 사내에서 사용될 "Naming Rule" 등을 강제화하고 싶을 때 사용될 수 있겠지만... 과연 국내 개발 환경에서 적극적으로 이런 plug-in을 만들 개발자(또는 개발팀)들이 있을까 의문이군요. ^^
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]