Weryfikowanie kodu za pomocą diagramów zależności

Dlaczego warto używać diagramów zależności?

Aby upewnić się, że kod nie powoduje konfliktu z jego projektem, zweryfikuj kod za pomocą diagramów zależności w programie Visual Studio. Może to pomóc:

• Znajdź konflikty między zależnościami w kodzie i zależnościach na diagramie zależności.

• Znajdź zależności, które mogą mieć wpływ na proponowane zmiany.

  Możesz na przykład edytować diagram zależności, aby wyświetlić potencjalne zmiany architektury, a następnie zweryfikować kod, aby zobaczyć zależności, których dotyczy problem.

• Refaktoryzacja lub migrowanie kodu do innego projektu.

  Znajdź kod lub zależności, które wymagają pracy podczas przenoszenia kodu do innej architektury.

Wymagania

• Visual Studio

  Aby utworzyć diagram zależności dla projektu platformy .NET Core, musisz mieć program Visual Studio 2019 w wersji 16.2 lub nowszej.

• Rozwiązanie, które ma projekt modelowania z diagramem zależności. Ten diagram zależności musi być połączony z artefaktami w projektach języka C# lub Visual Basic, które chcesz zweryfikować. Zobacz Tworzenie diagramów zależności na podstawie kodu.

Aby sprawdzić, które wersje programu Visual Studio obsługują tę funkcję, zobacz Obsługa wersji dla narzędzi do architektury i modelowania.

Kod można zweryfikować ręcznie z otwartego diagramu zależności w programie Visual Studio lub w wierszu polecenia. Kod można również zweryfikować automatycznie podczas uruchamiania kompilacji lokalnych lub kompilacji usługi Azure Pipelines.

Ważne

Jeśli chcesz uruchomić walidację warstwy przy użyciu serwera Team Foundation Server (TFS), musisz również zainstalować tę samą wersję programu Visual Studio na serwerze kompilacji.

Walidacja zależności na żywo

Walidacja zależności odbywa się w czasie rzeczywistym, a błędy są wyświetlane natychmiast na liście błędów.

• Walidacja na żywo jest obsługiwana w językach C# i Visual Basic.

• Aby włączyć pełną analizę rozwiązania podczas korzystania z walidacji zależności na żywo, otwórz ustawienia opcji na złotym pasku, który zostanie wyświetlony na liście błędów.

  • Możesz trwale odrzucić pasek złota, jeśli nie chcesz widzieć wszystkich problemów z architekturą w rozwiązaniu.
  • Jeśli nie włączysz pełnej analizy rozwiązania, analiza jest wykonywana tylko dla edytowanych plików.

• Podczas uaktualniania projektów w celu włączenia walidacji na żywo okno dialogowe pokazuje postęp konwersji.

• Podczas aktualizowania projektu do weryfikacji zależności na żywo wersja pakietu NuGet jest uaktualniana tak samo dla wszystkich projektów i jest najwyższą wersją w użyciu.

• Dodanie nowego projektu weryfikacji zależności wyzwala aktualizację projektu.

Sprawdzanie, czy element obsługuje walidację

Warstwy można łączyć z witrynami internetowymi, dokumentami pakietu Office, plikami zwykłego tekstu i plikami w projektach udostępnianych w wielu aplikacjach, ale proces weryfikacji nie będzie ich uwzględniać. Błędy walidacji nie będą wyświetlane w przypadku odwołań do projektów ani zestawów połączonych z oddzielnymi warstwami, gdy między tymi warstwami nie występują żadne zależności. Takie odwołania nie są uznawane za zależności, chyba że kod używa tych odwołań.

1. Na diagramie zależności wybierz co najmniej jedną warstwę, kliknij prawym przyciskiem myszy wybór, a następnie kliknij polecenie Wyświetl łącza.

2. W Eksploratorze warstw przyjrzyj się kolumnie Obsługuje walidację . Jeśli wartość ma wartość false, element nie obsługuje walidacji.

Uwzględnij inne zestawy i projekty platformy .NET na potrzeby walidacji

Podczas przeciągania elementów do diagramu zależności odwołania do odpowiednich zestawów lub projektów platformy .NET są automatycznie dodawane do folderu Odwołania do warstwy w projekcie modelowania. Ten folder zawiera odwołania do zestawów i projektów, które są analizowane podczas walidacji. Można dołączyć inne zestawy i projekty .NET do weryfikacji bez ręcznego przeciągania ich do diagramu zależności.

1. W Eksploratorze rozwiązań kliknij prawym przyciskiem myszy projekt modelowania lub folder Odwołania do warstwy , a następnie kliknij polecenie Dodaj odwołanie.

2. W oknie dialogowym Dodawanie odwołania wybierz zestawy lub projekty, a następnie kliknij przycisk OK.

Ręczne weryfikowanie kodu

Jeśli masz otwarty diagram zależności połączony z elementami rozwiązania, możesz uruchomić skrót polecenia Weryfikuj z diagramu. Możesz również użyć wiersza polecenia, aby uruchomić polecenie msbuild z właściwością niestandardową /p:ValidateArchitecture ustawioną na true. Na przykład podczas wprowadzania zmian w kodzie regularnie przeprowadzaj walidację warstwy, aby można było wcześnie przechwytywać konflikty zależności.

Weryfikowanie kodu z otwartego diagramu zależności

1. Kliknij prawym przyciskiem myszy powierzchnię diagramu, a następnie kliknij pozycję Weryfikuj architekturę.

   Uwaga / Notatka

   Domyślnie właściwość Akcja kompilacji na pliku diagramu zależności (.layerdiagram) jest ustawiona na Wartość Weryfikuj , aby diagram został uwzględniony w procesie walidacji.

   Okno Lista błędów zgłasza wszelkie błędy, które występują. Aby uzyskać więcej informacji na temat błędów walidacji, zobacz Rozwiązywanie problemów z walidacją warstwy.

2. Aby wyświetlić źródło każdego błędu, kliknij dwukrotnie błąd w oknie Lista błędów .

   Uwaga / Notatka

   Program Visual Studio może wyświetlać mapę kodu zamiast źródła błędu. Dzieje się tak, gdy kod ma zależność od zestawu, który nie jest określony przez diagram zależności, lub kod nie ma zależności określonej przez diagram zależności. Przejrzyj mapę kodu lub kod, aby określić, czy zależność powinna istnieć. Aby uzyskać więcej informacji na temat map kodu, zapoznaj się z Zależności między rozwiązaniami.

3. Aby zarządzać błędami, zobacz Rozwiązywanie błędów walidacji warstwy.

Weryfikowanie kodu w wierszu polecenia

1. Otwórz wiersz polecenia programu Visual Studio.

2. Wybierz jedną z następujących opcji:

   • Aby zweryfikować kod względem określonego projektu modelowania w rozwiązaniu, uruchom program MSBuild z następującą właściwością niestandardową.

     msbuild <FilePath+ModelProjectFileName>.modelproj /p:ValidateArchitecture=true
     

     — lub —

     Przejdź do folderu zawierającego plik projektu modelowania (.modelproj) i diagram zależności, a następnie uruchom program MSBuild z następującą właściwością niestandardową:

     msbuild /p:ValidateArchitecture=true
     

   • Aby zweryfikować kod we wszystkich projektach modelowania w rozwiązaniu, uruchom program MSBuild z następującą właściwością niestandardową:

     msbuild <FilePath+SolutionName>.sln /p:ValidateArchitecture=true
     

     — lub —

     Przejdź do folderu rozwiązania, który musi zawierać projekt modelowania zawierający diagram zależności, a następnie uruchom program MSBuild z następującą właściwością niestandardową:

     msbuild /p:ValidateArchitecture=true
     

     Wszelkie błędy, które wystąpią, zostaną wyświetlone. Aby uzyskać więcej informacji na temat programu MSBuild, zobacz MSBuild i MSBuild Task.

   Aby uzyskać więcej informacji na temat błędów walidacji, zobacz Rozwiązywanie problemów z walidacją warstwy.

Zarządzanie błędami walidacji

Podczas procesu programowania możesz pominąć niektóre zgłoszone konflikty podczas walidacji. Na przykład, możesz chcieć pominąć błędy, którymi już się zajmujesz lub które nie są istotne dla danego scenariusza. W przypadku pomijania błędu dobrym rozwiązaniem jest zarejestrowanie elementu roboczego w programie Team Foundation.

Ostrzeżenie

Aby utworzyć element roboczy lub utworzyć łącze do elementu roboczego, musisz już nawiązać połączenie z kontrolą kodu źródłowego (SCC) serwera TFS. Jeśli spróbujesz otworzyć połączenie z innym serwerem TFS SCC, program Visual Studio automatycznie zamknie bieżące rozwiązanie. Przed podjęciem próby utworzenia lub połączenia z elementem roboczym upewnij się, że masz już połączenie z odpowiednim SCC. W kolejnych wersjach programu Visual Studio polecenia menu nie są dostępne, jeśli nie masz połączenia z SCC.

Utwórz element roboczy dla błędu weryfikacji

• W oknie Lista błędów kliknij prawym przyciskiem myszy błąd, wskaż polecenie Utwórz element roboczy, a następnie kliknij typ elementu roboczego, który chcesz utworzyć.

Te zadania umożliwiają zarządzanie błędami walidacji w oknie Lista błędów :

do	Wykonaj następujące kroki
Pomijanie wybranych błędów podczas walidacji	Kliknij prawym przyciskiem myszy jeden lub wiele wybranych błędów, wskaż polecenie Zarządzaj błędami walidacji, a następnie kliknij pozycję Pomiń błędy. Zignorowane błędy są pokazywane z formatowaniem przekreślenia. Po uruchomieniu walidacji przy następnym uruchomieniu te błędy nie będą wyświetlane. Pominięte błędy są śledzone w pliku .suppressions dla odpowiedniego pliku diagramu zależności.
Zatrzymaj tłumienie wybranych błędów	Kliknij prawym przyciskiem myszy wybrany ukryty błąd lub błędy, wskaż polecenie Zarządzanie błędami walidacyjnymi, a następnie kliknij polecenie Przestań ukrywać błędy. Po następnym uruchomieniu walidacji zostaną wyświetlone wybrane pominięte błędy.
Przywróć wszystkie pominięte błędy w oknie Lista błędów	Kliknij prawym przyciskiem myszy w dowolnym miejscu w oknie Lista błędów , wskaż polecenie Zarządzaj błędami walidacji, a następnie kliknij polecenie Pokaż wszystkie pominięte błędy.
Ukryj wszystkie pominięte błędy w oknie Lista błędów	Kliknij prawym przyciskiem myszy w dowolnym miejscu w oknie Lista błędów , wskaż polecenie Zarządzaj błędami walidacji, a następnie kliknij polecenie Ukryj wszystkie pominięte błędy.

Automatyczne weryfikowanie kodu

Walidację warstwy można wykonać za każdym razem, gdy uruchamiasz kompilację lokalną. Jeśli twój zespół korzysta z usługi Azure DevOps, możesz przeprowadzić weryfikację warstw przy użyciu commitów z blokadą, które można określić poprzez utworzenie niestandardowego zadania MSBuild, i użyć raportów kompilacji do zbierania błędów walidacji. Aby utworzyć kompilacje z kontrolowanym zaewidencjonowaniem, zobacz Kontrolowane zaewidencjonowanie TFVC.

Aby automatycznie weryfikować kod podczas kompilacji lokalnej

Za pomocą edytora tekstów otwórz plik projektu modelowania (modelproj), a następnie dołącz następującą właściwość:

<ValidateArchitecture>true</ValidateArchitecture>

- lub -

1. W Eksploratorze rozwiązań kliknij prawym przyciskiem myszy projekt modelowania zawierający diagram zależności lub diagramy, a następnie kliknij polecenie Właściwości.

2. W oknie Właściwości ustaw właściwość Validate Architecture projektu modelowania na true.

   Obejmuje to projekt modelowania w procesie weryfikacji.

3. W Eksploratorze rozwiązań kliknij plik diagramu zależności (.layerdiagram), którego chcesz użyć do weryfikacji.

4. W oknie Właściwości upewnij się, że właściwość Akcja kompilacji diagramu jest ustawiona na Wartość Weryfikuj.

   Obejmuje to diagram zależności w procesie walidacji.

Aby zarządzać błędami w oknie Lista błędów, zobacz Rozwiązywanie błędów walidacji warstwy.

Rozwiązywanie problemów z walidacją warstwy

W poniższej tabeli opisano problemy z walidacją warstwy i ich rozwiązanie. Te problemy różnią się od błędów, które wynikają z konfliktów między kodem a projektem. Aby uzyskać więcej informacji na temat tych błędów, zobacz Rozwiązywanie problemów z walidacją warstwy.

Issue	Możliwa przyczyna	Resolution
Błędy walidacji nie występują zgodnie z oczekiwaniami.	Walidacja nie działa na diagramach zależności, które są kopiowane z innych diagramów zależności w Eksploratorze rozwiązań i które znajdują się w tym samym projekcie modelowania. diagramy zależności, które są kopiowane w ten sposób, zawierają te same odwołania co oryginalny diagram zależności.	Dodaj nowy diagram zależności do projektu modelowania. Skopiuj elementy z diagramu zależności źródłowej do nowego diagramu.

Usuwanie błędów walidacji warstwy

Podczas sprawdzania poprawności kodu na diagramie zależności występują błędy walidacji, gdy kod powoduje konflikt z projektem. Na przykład następujące warunki mogą spowodować wystąpienie błędów walidacji:

• Artefakt jest przypisywany do niewłaściwej warstwy. W takim przypadku przenieś artefakt.

• Artefakt, taki jak klasa, używa innej klasy w sposób, który powoduje konflikt z architekturą. Zrefaktoruj kod, aby usunąć zależność.

Aby rozwiązać te błędy, zaktualizuj kod, dopóki nie pojawią się żadne błędy podczas walidacji. To zadanie można wykonać w sposób iteracyjny.

W poniższej sekcji opisano składnię, która jest używana w tych błędach, wyjaśnia znaczenie tych błędów i sugeruje, co można zrobić, aby je rozwiązać lub zarządzać.

Syntax	Opis
ArtifactN(ArtifactTypeN)	ArtifactN to artefakt skojarzony z warstwą na diagramie zależności. ArtifactTypeN jest typem ArtifactN, takim jak klasa lub metoda, na przykład: MySolution.MyProject.MyClass.MyMethod(Method)
Nazwa przestrzeni nazwN	Nazwa przestrzeni nazw.
LayerNameN	Nazwa warstwy na diagramie zależności.
DependencyType	Typ relacji zależności między artifact1 i Artifact2. Na przykład Artifact1 ma relację Calls z Artifact2.

Błąd składni	Opis błędu
DV0001: Nieprawidłowa zależność	Ten problem jest zgłaszany, gdy element kodu (przestrzeń nazw, typ, składowa) mapowany na warstwę odwołuje się do elementu kodu mapowanego na inną warstwę, ale nie ma strzałki zależności między tymi warstwami na diagramie weryfikacji zależności zawierającym te warstwy. Jest to naruszenie ograniczeń zależności.
DV1001: Nieprawidłowa nazwa przestrzeni nazw	Zgłaszany jest problem dotyczący elementu kodu związanego z warstwą, którego właściwość "Dozwolone nazwy przestrzeni nazw" nie zawiera przestrzeni nazw, w której ten element kodu jest zdefiniowany. Jest to naruszenie ograniczeń nazewnictwa. Należy pamiętać, że składnia "Dozwolone nazwy przestrzeni nazw" to lista przestrzeni nazw oddzielonych średnikami, w których można zdefiniować elementy kodu przypisane do danej warstwy.
DV1002: Zależność od nieodwoływalnej przestrzeni nazw	Ten problem jest zgłaszany w elemencie kodu skojarzonym z warstwą, który odwołuje się do innego elementu kodu zdefiniowanego w przestrzeni nazw, znajdującej się we właściwości warstwy "Nieodwoływalna przestrzeń nazw". Jest to naruszenie ograniczeń nazewnictwa. Należy pamiętać, że właściwość "Przestrzenie nazw niemożliwe do odwołania" jest zdefiniowana jako lista przestrzeni nazw, rozdzielona średnikami, które nie mogą być odwoływane w elementach kodu skojarzonych z tą warstwą.
DV1003: Niedozwolona nazwa przestrzeni nazw	Ten problem jest zgłaszany w elemencie kodu skojarzonym z warstwą, której właściwość "Niedozwolone nazwy przestrzeni nazw" zawiera przestrzeń nazw, w której definiuje się ten element kodu. Jest to naruszenie ograniczeń nazewnictwa. Należy pamiętać, że właściwość "Niedozwolona nazwa przestrzeni nazw" jest zdefiniowana jako rozdzielona średnikami lista przestrzeni nazw, w których nie należy definiować elementów kodu skojarzonych z tą warstwą.
DV2001: Obecność diagramu warstwowego	Ten problem jest zgłaszany w projekcie, który nie zawiera pliku diagramu zależności, ale odwołuje się do analizatorów weryfikacji zależności. Jeśli weryfikacja zależności nie została użyta, możesz usunąć element "Microsoft.DependencyValidation.Analyzers" bezpośrednio z Eksploratora rozwiązań lub pominąć to ostrzeżenie. Aby dodać diagram zależności, zobacz Tworzenie diagramów zależności na podstawie kodu.
DV2002: Baza niezmapowanych typów	Ten problem jest zgłaszany, gdy element kodu nie jest mapowany na żadną warstwę.
DV3001: Brak łącza	Nie można odnaleźć artefaktu, do którego prowadzi warstwa "LayerName". Czy brakuje odwołania do zestawu?
DV9001: Analiza architektury wykazała błędy wewnętrzne	Wyniki mogą być niepełne. Aby uzyskać więcej informacji, zobacz szczegółowy dziennik zdarzeń kompilacji lub okno danych wyjściowych.

Treści powiązane

• Walidacja zależności na żywo w programie Visual Studio
• Weryfikowanie systemu podczas programowania
• Wideo: Weryfikowanie zależności architektury w czasie rzeczywistym