.NET Compiler Platform SDK

  • 아티클

컴파일러는 애플리케이션 코드의 구문 및 의미 체계의 유효성을 검사할 때 애플리케이션 코드의 세부 모델을 빌드합니다. 컴파일러는 이 모델을 사용하여 소스 코드에서 실행 가능 출력을 빌드합니다. .NET Compiler Platform SDK는 이 모델에 대한 액세스를 제공합니다. 우리는 점점 더 IntelliSense, 리팩터링, 지능형 이름 바꾸기, “모든 참조 찾기” 및 “정의로 이동”과 같은 IDE(통합 개발 환경) 기능에 의존하여 생산성을 높입니다. 또한 코드 분석 도구를 사용하여 코드 품질을 개선하고 코드 생성기를 사용하여 애플리케이션 구성에서 도움을 받습니다. 이러한 도구가 더 스마트해짐에 따라 컴파일러가 애플리케이션 코드를 처리할 때 컴파일러만이 만드는 모델의 점점 더 많은 부분에 이러한 도구가 액세스해야 합니다. 이것이 바로 Roslyn API의 핵심 임무입니다. 불투명 상자를 열고 도구 및 최종 사용자가 컴파일러가 코드에 대해 가진 다양한 정보를 공유할 수 있도록 하는 것 말입니다. 컴파일러는 불투명한 소스 코드 입력 변환기 및 개체 코드 출력 변환기 대신 Roslyn을 통해 플랫폼이 됩니다. 즉, 도구 및 애플리케이션에서 코드 관련 작업에 사용할 수 있는 API입니다.

.NET Compiler Platform SDK 개념

.NET Compiler Platform SDK는 코드 중심 도구 및 애플리케이션을 만들기 위한 진입에 대한 장벽을 크게 낮춰줍니다. 메타 프로그래밍, 코드 생성 및 변환, C# 및 Visual Basic 언어의 대화형 사용, 도메인 특정 언어에 C# 및 Visual Basic 포함과 같은 영역에서 다양한 혁신 기회를 창출합니다.

.NET Compiler Platform SDK를 사용하면 코딩 실수를 찾아 수정하는 분석기 및 코드 수정을 빌드할 수 있습니다. 분석기는 구문(코드 구조) 및 의미 체계를 이해하여 수정해야 하는 사례를 검색합니다. 코드 수정은 분석기 또는 컴파일러 진단에서 발견된 코딩 실수를 해결하기 위해 하나 이상의 제안된 수정 사항을 제공합니다. 일반적으로 분석기 및 연관된 코드 수정 사항은 단일 프로젝트에서 함께 패키지됩니다.

분석기 및 코드 수정 사항은 정적 분석을 사용하여 코드를 이해하며, 코드를 실행하거나 다른 테스트 이점을 제공하지 않습니다. 하지만 종종 버그, 유지 관리할 수 없는 코드, 표준 지침 위반으로 이어질 수 있는 사례를 짚어줄 수 있습니다.

분석기 및 코드 수정 외에도 .NET Compiler Platform SDK를 사용하면 코드 리팩터링을 빌드할 수 있습니다. 또한 C# 또는 Visual Basic 코드베이스를 검사하고 이해할 수 있게 해주는 단일 API 집합도 제공합니다. 이 단일 코드베이스를 사용할 수 있으므로 .NET Compiler Platform SDK에서 제공하는 구문 및 의미 체계 분석 API를 활용하여 분석기 및 코드 수정 사항을 더 쉽게 작성할 수 있습니다. 컴파일러가 수행한 분석을 복제하는 대규모 작업에서 벗어난 사용자는 프로젝트 또는 라이브러리에 대한 일반적인 코딩 오류를 찾아 수정하는 더 중심이 되는 작업에 집중할 수 있습니다.

작은 이점 한 가지는 사용자가 직접 프로젝트의 코드를 이해하기 위해 자체 코드베이스를 작성하는 경우보다 Visual Studio에 로드되었을 때 분석기 및 코드 수정 사항이 메모리를 훨씬 더 적게 사용하고 규모가 작다는 것입니다. 컴파일러 및 Visual Studio에서 사용되는 것과 같은 클래스를 활용하여 자체 정적 분석 도구를 만들 수 있습니다. 즉, 팀은 IDE 성능에 대한 눈에 띄는 영향 없이 분석기 및 코드 수정 사항을 사용할 수 있습니다.

분석기 및 코드 수정 사항을 작성하는 세 가지 주요 시나리오가 있습니다.

  1. 팀 코딩 표준 적용
  2. 라이브러리 패키지로 지침 제공
  3. 일반 지침 제공

팀 코딩 표준 적용

많은 팀에는 다른 팀 구성원과의 코드 검토를 통해 적용되는 코딩 표준이 있습니다. 분석기 및 코드 수정 사항은 이 프로세스를 훨씬 더 효율적으로 만들 수 있습니다. 코드 검토는 개발자가 다른 팀 구성원과 자신의 작업을 공유할 때 발생합니다. 개발자는 의견을 듣기 전에 새로운 기능을 완성하는 데 필요한 모든 시간을 투자했을 것입니다. 개발자가 팀의 습관과 일치하지 않는 습관을 강화하는 동안 몇 주가 흐를 수도 있습니다.

개발자가 코드를 작성할 때 분석기가 실행됩니다. 개발자는 즉시 지침을 따르도록 권장하는 즉각적인 피드백을 받습니다. 개발자는 프로토타입 생성을 시작하는 즉시 규격 코드를 작성하는 습관이 붙게 됩니다. 기능이 사람에 의한 검토를 받을 준비가 되면 모든 표준 지침이 적용된 상태가 되어 있습니다.

팀은 팀 코딩 습관을 위반하는 가장 일반적인 습관을 찾는 분석기 및 코드 수정 사항을 빌드할 수 있습니다. 이러한 분석기 및 코드 수정 사항을 각 개발자의 컴퓨터에 설치하여 표준을 적용할 수 있습니다.

팁

사용자 고유의 분석기를 빌드하기 전에 기본 제공되는 분석기를 확인합니다. 자세한 내용은 코드 스타일 규칙을 참조하세요.

라이브러리 패키지로 지침 제공

NuGet에는 .NET 개발자가 사용할 수 있는 다양한 라이브러리가 있습니다. 이러한 라이브러리 중 일부는 Microsoft에서 제공한 것이고, 또 다른 일부는 타사에서 제공한 것이며, 나머지는 커뮤니티 회원 및 지원자가 제공한 것입니다. 개발자가 이러한 라이브러리로 성공할 수 있는 경우 해당 라이브러리는 더 많이 채택되고 더 많은 검토를 받게 됩니다.

설명서를 제공하는 것 외에 라이브러리의 일반적인 오용을 찾아 수정하는 분석기 및 코드 수정 사항을 제공할 수 있습니다. 이러한 즉각적인 수정 사항은 개발자가 더 빠르게 성공하도록 도와줍니다.

NuGet의 라이브러리를 사용하여 분석기 및 코드 수정 사항을 패키지할 수 있습니다. 해당 시나리오에서 NuGet 패키지를 설치하는 모든 개발자는 분석기 패키지도 설치합니다. 라이브러리를 사용하는 모든 개발자는 실수 및 제안된 수정 사항에 대한 즉각 적인 피드백의 형태로 팀으로부터 즉시 지침을 받게 됩니다.

일반 지침 제공

.NET 개발자 커뮤니티는 경험을 통해 잘 작동하는 패턴과 가장 피해야 할 패턴을 간파해왔습니다. 여러 커뮤니티 회원은 이러한 권장 패턴을 적용하는 분석기를 만들었습니다. 자세히 알아보다 보면 항상 새로운 아이디어를 위한 여지가 있음을 알게 됩니다.

이러한 분석기를 Visual Studio Marketplace에 업로드하고 Visual Studio를 사용하는 개발자가 다운로드할 수 있습니다. 언어 및 플랫폼을 처음 사용하는 초보자는 일반적으로 인정된 습관을 신속하게 배우고 .NET 여정에서 조기에 생산성을 높일 수 있습니다. 이러한 습관이 더 널리 사용됨에 따라 커뮤니티에서는 이러한 습관을 채택합니다.

다음 단계

.NET Compiler Platform SDK에는 코드 생성, 분석 및 리팩터링에 대한 최신 언어 개체 모델이 포함되어 있습니다. 이 섹션에서는 .NET Compiler Platform SDK에 대한 개념적 개요를 제공합니다. 자세한 내용은 빠른 시작, 샘플 및 자습서 섹션에서 확인할 수 있습니다.

다음 다섯 가지 항목에서 .NET Compiler Platform SDK의 개념에 대해 자세히 알아볼 수 있습니다.

시작하려면 .NET Compiler Platform SDK를 설치해야 합니다.

설치 지침 - Visual Studio 설치 관리자

Visual Studio 설치 관리자에서 .NET Compiler Platform SDK를 찾는 두 가지 방법이 있습니다.

Visual Studio 설치 관리자를 사용한 설치 - 워크로드 보기

.NET Compiler Platform SDK는 Visual Studio 확장 개발 워크로드의 일부로 자동으로 선택되지 않습니다. 선택적 구성 요소로 선택해야 합니다.

  1. Visual Studio 설치 관리자를 실행합니다.
  2. 수정을 선택합니다.
  3. Visual Studio 확장 개발 워크로드를 확인합니다.
  4. 요약 트리에서 Visual Studio 확장 개발 노드를 엽니다.
  5. .NET Compiler Platform SDK에 대한 확인란을 선택합니다. 선택적 구성 요소 아래에서 마지막에 찾을 수 있습니다.

필요에 따라, 시각화 도우미에서 DGML 편집기에 그래프도 표시할 수 있습니다.

  1. 요약 트리에서 개별 구성 요소 노드를 엽니다.
  2. DGML 편집기 확인란을 선택합니다.

Visual Studio 설치 관리자를 사용한 설치 - 개별 구성 요소 탭

  1. Visual Studio 설치 관리자를 실행합니다.
  2. 수정을 선택합니다.
  3. 개별 구성 요소 탭을 선택합니다.
  4. .NET Compiler Platform SDK에 대한 확인란을 선택합니다. 컴파일러, 빌드 도구 및 런타임 섹션의 위쪽에서 찾을 수 있습니다.

필요에 따라, 시각화 도우미에서 DGML 편집기에 그래프도 표시할 수 있습니다.

  1. DGML 편집기 확인란을 선택합니다. 코드 도구 섹션에서 찾을 수 있습니다.