종속성 다이어그램을 사용하여 코드 유효성 검사
종속성 다이어그램을 사용해야 하는 이유
코드가 디자인과 충돌하지 않는지 확인하기 위해 Visual Studio에서 종속성 다이어그램을 사용하여 코드의 유효성을 검사할 수 있습니다. 이 경우 다음에 도움이 됩니다.
코드의 종속성과 종속성 다이어그램의 종속성 사이의 충돌을 찾을 수 있습니다.
제안된 변경 내용의 영향을 받을 수 있는 종속성을 찾습니다.
예를 들어 종속성 다이어그램을 편집하여 잠재적인 아키텍처 변경을 나타낸 다음, 코드의 유효성을 검사하여 영향을 받는 종속성을 확인할 수 있습니다.
코드를 다른 디자인으로 리팩터링 또는 마이그레이션합니다.
코드를 다른 아키텍처로 이동할 때 아직 작업이 필요한 코드 또는 종속성을 찾을 수 있습니다.
요구 사항
Visual Studio
.NET Core 프로젝트에 대한 종속성 다이어그램을 만들려면 Visual Studio 2019 버전 16.2 이상이 필요합니다.
종속성 다이어그램을 사용하는 모델링 프로젝트가 포함된 솔루션. 이 종속성 다이어그램은 유효성 검사를 하려는 C# 또는 Visual Basic 프로젝트의 아티팩트에 연결해야 합니다. 코드에서 종속성 다이어그램 만들기를 참조하세요.
이 기능을 지원하는 Visual Studio 버전을 확인하려면 아키텍처 및 모델링 도구에 대한 에디션 지원을 참조하세요.
Visual Studio의 열린 종속성 다이어그램 또는 명령 프롬프트에서 코드 유효성 검사를 수동으로 수행할 수 있습니다. 또한 로컬 빌드 또는 Azure Pipelines 빌드를 실행할 때 자동으로 코드 유효성 검사를 실행할 수도 있습니다.
Important
TFS(Team Foundation Server)를 사용하여 레이어 유효성 검사를 실행하려면 빌드 서버에 동일한 버전의 Visual Studio를 설치해야 합니다.
실시간 종속성 유효성 검사
종속성 유효성 검사는 실시간으로 진행되며, 오류는 오류 목록에 바로 표시됩니다.
실시간 유효성 검사는 C#과 Visual Basic을 지원합니다.
실시간 종속성 유효성 검사를 사용할 때 전체 솔루션 분석을 사용하도록 설정하려면, 오류 목록에 표시되는 금색 표시줄에서 옵션 설정을 엽니다.
- 솔루션에서 아키텍처 문제를 모두 확인하고 싶지는 않다면 금색 표시줄을 영구적으로 해제해도 됩니다.
- 전체 솔루션 분석을 사용하도록 설정하지 않으면, 편집 중인 파일만 분석됩니다.
실시간 유효성 검사를 사용하도록 프로젝트를 업그레이드할 때는 대화 상자에 변환 진행률이 표시됩니다.
실시간 종속성 유효성 검사를 위해 프로젝트를 업데이트할 때는 NuGet 패키지의 버전이 모든 프로젝트에 대해 동일하게 업그레이드되며, 사용 중인 가장 높은 버전이 됩니다.
새 종속성 유효성 검사 프로젝트를 추가하면 프로젝트 업데이트가 트리거됩니다.
항목에서 유효성 검사를 지원하는지 확인
레이어를 웹 사이트, Office 문서, 일반 텍스트 파일 및 여러 앱에서 공유되는 프로젝트의 파일에 연결할 수는 있지만, 유효성 검사 프로세스에는 레이어가 포함되지 않습니다. 별도의 레이어에 연결된 프로젝트 또는 어셈블리의 경우에는 해당 레이어 간에 종속성이 나타나지 않아도 유효성 검사 오류가 나타나지 않습니다. 이러한 참조는 코드에서 사용하지 않는 한 종속성으로 처리되지 않습니다.
종속성 다이어그램에서 하나 이상의 레이어를 선택하고 선택한 레이어를 마우스 오른쪽 단추로 클릭한 다음 링크 보기를 클릭합니다.
레이어 탐색기에서 유효성 검사 지원 열을 검토합니다. 값이 false일 경우 해당 항목은 유효성 검사를 지원하지 않습니다.
유효성 검사에 다른.NET 어셈블리 및 프로젝트 포함
종속성 다이어그램으로 항목을 끌어 놓으면 해당 .NET 어셈블리나 프로젝트에 대한 참조가 모델링 프로젝트의 레이어 참조 폴더에 자동으로 추가됩니다. 이 폴더에는 유효성 검사 중 분석되는 프로젝트와 어셈블리에 대한 참조가 포함되어 있습니다. 유효성을 검사할 다른 .NET 어셈블리와 프로젝트는 수동으로 종속성 다이어그램으로 끌어 놓지 않고도 포함할 수 있습니다.
솔루션 탐색기에서 모델링 프로젝트 또는 레이어 참조 폴더를 마우스 오른쪽 단추로 클릭한 다음 참조 추가를 클릭합니다.
참조 추가 대화 상자에서 어셈블리 또는 프로젝트를 선택하고 확인을 클릭합니다.
수동으로 코드 유효성 검사
솔루션 항목에 연결된 종속성 다이어그램이 열린 상태에서는 다이어그램에서 유효성 검사 바로 가기 명령을 실행할 수 있습니다. 명령 프롬프트를 사용하여 /p:ValidateArchitecture 사용자 지정 속성이 True로 설정된 msbuild 명령을 실행할 수도 있습니다. 예를 들어, 코드를 변경할 때 종속성 충돌을 빠르게 찾을 수 있도록 레이어 유효성 검사를 정기적으로 수행합니다.
열린 종속성 다이어그램에서 코드 유효성 검사
다이어그램 화면을 마우스 오른쪽 단추로 클릭하고 아키텍처 유효성 검사를 클릭합니다.
참고 항목
기본적으로 종속성 다이어그램 파일(.layerdiagram)의 빌드 작업 속성은 유효성 검사로 설정되어 있으므로 해당 다이어그램이 유효성 검사 프로세스에 포함됩니다.
오류 목록 창에는 발생하는 모든 오류가 보고됩니다. 유효성 검사 오류에 대한 자세한 내용은 레이어 유효성 검사 문제 해결을 참조하세요.
각 오류의 소스를 보려면 오류 목록 창에서 오류 항목을 두 번 클릭합니다.
참고 항목
Visual Studio에서는 오류 소스 대신 코드 맵이 표시될 수도 있습니다. 종속성 다이어그램에 지정되지 않은 어셈블리에 대한 종속성이 코드에 있거나 종속성 다이어그램에 지정된 종속성이 코드에 없는 경우 종속성 그래프가 표시됩니다. 이 경우 코드 맵이나 코드를 검토하여 종속성이 있어야 하는지 여부를 확인합니다. 코드 맵에 대한 자세한 내용은 솔루션 전체에서 종속성 매핑을 참조하세요.
오류를 관리하려면 레이어 유효성 검사 오류 해결을 참조하세요.
명령 프롬프트에서 코드 유효성 검사
Visual Studio 명령 프롬프트를 엽니다.
다음 중 하나를 선택하십시오.
솔루션의 특정 모델링 프로젝트를 기준으로 코드 유효성을 검사하려면 다음 사용자 지정 속성을 사용하여 MSBuild를 실행합니다.
msbuild <FilePath+ModelProjectFileName>.modelproj /p:ValidateArchitecture=true또는
모델링 프로젝트 파일(.modelproj)과 종속성 다이어그램이 포함된 폴더로 이동한 후 다음 사용자 지정 속성을 사용하여 MSBuild를 실행합니다.
msbuild /p:ValidateArchitecture=true솔루션의 모든 모델링 프로젝트를 기준으로 코드 유효성을 검사하려면 다음 사용자 지정 속성을 사용하여 MSBuild를 실행합니다.
msbuild <FilePath+SolutionName>.sln /p:ValidateArchitecture=true또는
솔루션 폴더로 이동한 후 다음 사용자 지정 속성을 사용하여 MSBuild를 실행합니다. 이 솔루션 폴더에는 종속성 다이어그램이 포함된 모델링 프로젝트가 들어 있어야 합니다.
msbuild /p:ValidateArchitecture=true발생하는 모든 오류가 나열됩니다. MSBuild에 대한 자세한 내용은 MSBuild 및 MSBuild 작업을 참조하세요.
유효성 검사 오류에 대한 자세한 내용은 레이어 유효성 검사 문제 해결을 참조하세요.
유효성 검사 오류 관리
개발 과정에서 유효성 검사 중 보고된 충돌 문제 중 일부를 표시하지 않을 수 있습니다. 예를 들어 이미 해결되었거나 특정 시나리오와 관계가 없는 오류를 표시하지 않을 수 있습니다. 오류를 표시하지 않는 경우에는 Team Foundation에 작업 항목을 기록하는 것이 좋습니다.
Warning
작업 항목을 만들거나 작업 항목에 연결하려면 TFS SCC(소스 코드 제어)에 이미 연결되어 있어야 합니다. 다른 TFS SCC에 대한 연결을 열려고 하면 Visual Studio가 자동으로 현재 솔루션을 닫습니다. 작업 항목을 만들거나 작업 항목에 연결하기 전에 적절한 SCC에 이미 연결되어 있는지 확인합니다. Visual Studio의 이후 릴리스에서는 SCC에 연결되어 있지 않으면 메뉴 명령을 사용할 수 없습니다.
유효성 검사 오류에 대한 작업 항목 만들기
- 오류 목록 창에서 오류를 마우스 오른쪽 단추로 클릭하고 작업 항목 만들기를 가리킨 다음 만들려는 작업 항목 형식을 클릭합니다.
다음 작업을 수행하여 오류 목록 창의 유효성 검사 오류를 관리할 수 있습니다.
| 받는 사람 | 다음 단계를 수행하세요. |
|---|---|
| 선택한 오류를 유효성 검사 중에 표시 안 함 | 선택한 하나 이상의 오류를 마우스 오른쪽 단추로 클릭하고 유효성 검사 오류 관리를 가리킨 다음 오류 표시 안 함을 클릭합니다. 표시되지 않는 오류는 취소선 서식을 사용하여 나타납니다. 다음에 유효성 검사를 실행하면 이러한 오류가 나타나지 않습니다. 표시되지 않는 오류는 해당하는 종속성 다이어그램 파일의 .suppressions 파일에서 추적됩니다. |
| 선택한 오류 표시 안 함 중지 | 표시하지 않도록 선택한 하나 이상의 오류를 마우스 오른쪽 단추로 클릭하고 유효성 검사 오류 관리를 가리킨 다음 오류 표시 안 함 중지를 클릭합니다. 다음에 유효성 검사를 실행하면 표시하지 않도록 선택한 오류는 나타나지 않습니다. |
| 오류 목록 창에서 표시되지 않는 모든 오류 복원 | 오류 목록 창에서 아무 곳이나 마우스 오른쪽 단추로 클릭하고 유효성 검사 오류 관리를 가리킨 다음 표시 안 한 오류 표시를 클릭합니다. |
| 표시되지 않는 모든 오류를 오류 목록 창에서 숨기기 | 오류 목록 창에서 아무 곳이나 마우스 오른쪽 단추로 클릭하고 유효성 검사 오류 관리를 가리킨 다음 표시 안 한 오류 숨기기를 클릭합니다. |
자동으로 코드 유효성 검사
로컬 빌드를 실행할 때마다 레이어 유효성 검사를 수행할 수 있습니다. 팀에서 Azure DevOps를 사용하는 경우, 사용자 지정 MSBuild 작업을 생성하여 지정할 수 있는 제어된 체크 인을 사용하여 유효성 검사를 수행하고 빌드 보고서를 사용하여 유효성 검사 오류를 수집할 수 있습니다. 제어된 체크 인 빌드를 만들려면 TFVC 제어된 체크 인을 참조하세요.
로컬 빌드 중 자동으로 코드의 유효성을 검사하려면
텍스트 편집기를 사용하여 모델링 프로젝트 파일(.modelproj)을 열고 다음 속성을 포함합니다.
<ValidateArchitecture>true</ValidateArchitecture>
- 또는 -
솔루션 탐색기에서 하나 이상의 종속성 다이어그램이 포함된 모델링 프로젝트를 마우스 오른쪽 단추로 클릭하고 속성을 클릭합니다.
속성 창에서 모델링 프로젝트의 아키텍처 유효성 검사 속성을 True로 설정합니다.
이렇게 하면 모델링 프로젝트가 유효성 검사 프로세스에 포함됩니다.
솔루션 탐색기에서 유효성 검사에 사용할 종속성 다이어그램(.layerdiagram) 파일을 클릭합니다.
속성 창에서 다이어그램의 빌드 작업 속성이 유효성 검사로 설정되어 있는지 확인합니다.
이렇게 하면 종속성 다이어그램이 유효성 검사 프로세스에 포함됩니다.
오류 목록 창에서 오류를 관리하려면 레이어 유효성 검사 오류 해결을 참조하세요.
레이어 유효성 검사 문제 해결
다음 표에서는 레이어 유효성 검사 문제와 해결 방법에 대해 설명합니다. 이 문제는 코드와 디자인 간의 충돌로 인해 발생하는 오류와 다릅니다. 이러한 오류에 대한 자세한 내용은 레이어 유효성 검사 문제 해결을 참조하세요.
| 문제점 | 가능한 원인 | 해결 방법 |
|---|---|---|
| 유효성 검사 오류가 예상대로 발생하지 않습니다. | 같은 모델링 프로젝트에 있는 종속성 다이어그램과 솔루션 탐색기의 다른 다이어그램에서 복사한 종속성 다이어그램에 대해서는 유효성 검사가 수행되지 않습니다. 이렇게 복사한 종속성 다어어그램은 원본 종속성 다이어그램과 동일한 참조를 포함합니다. | 모델링 프로젝트에 새 종속성 다이어그램을 추가합니다. 원본 종속성 다이어그램에서 새 다이어그램으로 요소를 복사합니다. |
레이어 유효성 검사 오류 해결
종속성 다이어그램에서 코드의 유효성을 검사할 때 코드가 디자인과 충돌하면 유효성 검사 오류가 발생합니다. 예를 들어, 다음과 같은 조건에서 유효성 검사 오류가 발생할 수 있습니다.
잘못된 레이어에 아티팩트가 할당되었습니다. 이 경우 아티팩트를 이동합니다.
클래스 등의 아티팩트가 아키텍처에 맞지 않는 방식으로 다른 클래스를 사용합니다. 이 경우 코드를 리팩터링하여 종속성을 제거합니다.
이러한 오류를 해결하려면 유효성 검사 중 더 이상 오류가 나타나지 않을 때까지 코드를 업데이트합니다. 이 작업은 반복적으로 수행할 수 있습니다.
다음 섹션에서는 이러한 오류에 사용되는 구문과 이러한 오류의 의미를 설명하고 오류의 해결 및 관리 방법을 제안합니다.
| Syntax | 설명 |
|---|---|
| ArtifactN(ArtifactTypeN) | ArtifactN은 레이어 다이어그램의 종속성과 연결된 아티팩트입니다. ArtifactTypeN은 클래스 또는 메서드와 같은 ArtifactN의 형식입니다. 예를 들면 다음과 같습니다. MySolution.MyProject.MyClass.MyMethod(메서드) |
| NamespaceNameN | 네임스페이스의 이름입니다. |
| LayerNameN | 종속성 다이어그램의 레이어 이름입니다. |
| DependencyType | Artifact1과 Artifact2 사이의 종속 관계 유형입니다. 예를 들어 Artifact1은 Artifact2와 Calls 관계입니다. |
| 오류 구문 | 오류 설명 |
|---|---|
| DV0001: 잘못된 종속성 | 이 문제는 레이어에 매핑된 코드 요소(네임스페이스, 형식, 멤버)가 다른 레이어에 매핑된 코드 요소를 참조하지만, 두 레이어가 포함된 종속성 유효성 검사 다이어그램에서 레이어 간의 종속성 화살표가 없을 때 보고됩니다. 이것은 종속성 제약 조건 위반에 해당합니다. |
| DV1001: 네임스페이스 이름이 올바르지 않음 | 이 문제는 "허용된 네임스페이스 이름" 속성에 코드 요소가 정의된 네임스페이스가 없는 계층과 연결된 코드 요소에서 보고됩니다. 이것은 명명 제약 조건 위반에 해당합니다. "허용되는 네임스페이스 이름"의 구문은 레이어와 연결된 코드 요소를 정의할 수 있는 네임스페이스의 세미콜론 목록입니다. |
| DV1002: 참조할 수 없는 네임스페이스의 종속성 | 이 문제는 레이어와 연결되었고, 레이어의 "참조할 수 없는 네임스페이스" 속성에 정의된 네임스페이스에 정의된 다른 코드 요소를 참조하는 코드 요소에서 보고됩니다. 이것은 명명 제약 조건 위반에 해당합니다. "참조할 수 없는 네임스페이스" 속성은 이 레이어와 연결된 코드 요소에서 참조해서는 안 되는 네임스페이스의 세미콜론으로 구분된 목록으로 정의됩니다. |
| DV1003: 허용되지 않는 네임스페이스 이름 | 이 문제는 "허용되지 않는 네임스페이스 이름" 속성에 코드 요소가 정의된 네임스페이스가 있는 계층과 연결된 코드 요소에서 보고됩니다. 이것은 명명 제약 조건 위반에 해당합니다. "허용되지 않는 네임스페이스 이름" 속성은 이 레이어와 연결된 코드 요소를 정의하지 않아야 하는 네임스페이스의 세미콜론으로 구분된 목록으로 정의됩니다. |
| DV2001: 레이어 다이어그램 현재 상태 | 이 문제는 종속성 다이어그램 파일을 포함하지 않지만 종속성 유효성 검사 분석기를 참조하는 프로젝트에서 보고됩니다. 종속성 유효성 검사를 사용하지 않은 경우에는 솔루션 탐색기에서 "Microsoft.DependencyValidation.Analyzers"를 바로 제거하거나 이 경고를 표시하지 않으면 됩니다. 종속성 다이어그램을 추가하려면 코드에서 종속성 다이어그램 만들기를 참조하세요. |
| DV2002: 매핑되지 않은 형식 기준 | 이 문제는 코드 요소가 레이어에 매핑되지 않은 경우에 보고됩니다. |
| DV3001: 링크 누락 | 찾을 수 없는 "아티팩트"에 대한 레이어 "LayerName" 링크입니다. 어셈블리 참조가 있는지 확인하세요. |
| DV9001: 아키텍처 유효성 검사에서 내부 오류 발생 | 결과가 불완전할 수 있습니다. 자세한 내용은 상세 빌드 이벤트 로그를 참조하세요. |