Diagramy warstw: Zalecenia
Możesz opisać architektury swoją aplikację na wysoki poziom tworząc warstwy diagramy w programie Visual Studio Ultimate.Aby upewnić się, że kod pozostaje zgodny z tym projektem, przeprowadź walidację kodu przy użyciu diagramu warstwowego w programie Visual Studio Ultimate lub Visual Studio Premium.Można także dodać warstwy Weryfikacja procesu kompilacji.Zobacz Channel 9 wideo: projektowania i weryfikacji architektury za pomocą diagramów warstwowych.
Co to jest warstwowego diagramu?
Podobnie jak diagramu architektury w tradycyjnych warstwowego diagramu identyfikuje główne składniki lub jednostki organizacyjne projektu i ich zależnościami.Każdy węzeł diagramu, o nazwie warstwy, reprezentuje logicznej grupy obszary nazw, projekty lub inne artefakty.Można rysować zależności, które powinno funkcjonować w projekcie.W odróżnieniu od diagramu architektury w tradycyjnych można sprawdzić zgodność rzeczywiste zależności w kodzie źródłowym zakładanych zależności między określonymi przez użytkownika.Dokonując weryfikacji część regularnego kompilacji na Team Foundation Server, można zapewnić, że kod programu w dalszym ciągu stosować się do systemu architektury poprzez przyszłych zmian.Zobacz Diagramy warstw: Odwołanie.
Jak projektować lub aktualizowania aplikacji przy użyciu diagramy warstwowe
Następujące kroki zawiera przegląd informacji dotyczących używania diagramy warstwowe w ramach procesu tworzenia aplikacji.Później w tym temacie opisano więcej szczegółów na temat każdego kroku.Jeśli tworzysz nowy projekt, można pominąć czynności, które odwołują się do istniejącego kodu.
[!UWAGA]
Te kroki są wyświetlane w kolejności przybliżony.Prawdopodobnie można nakłada zadań, zmienianie kolejności je do własnych własne sytuacji i przeglądania ich na początku każdej iteracji w projekcie.
Tworzenie diagramu warstwy dla całej aplikacji lub dla warstwy znajdujące się w nim.
Definiowanie warstwy do reprezentowania podstawowej obszarów funkcjonalnych lub składniki aplikacji.Nadaj nazwę te warstwy zgodnie z ich funkcji, na przykład "Prezentacja" lub "Usługi".Jeśli masz Visual Studio rozwiązania, każda warstwa można skojarzyć z kolekcją artefakty, takich jak projekty, obszary nazw, pliki i tak dalej.
Odnajdywanie istniejące zależności między warstwami.
Edycja warstw i zależności wyświetlanych zaktualizowanego projektu, który ma kod w celu odzwierciedlenia.
Projektowanie aplikacji nowe obszary przez tworzenie warstw do reprezentowania podmiotu zabezpieczeń architektury bloki lub składniki i definiowanie zależności wyświetlanych na każdej warstwy używaniu innych.
Edytowanie układu i wyglądu diagramu pomaga omówić go z innymi.
Sprawdź poprawność kodu względem warstwowego diagramu aby wyróżnić konfliktów między kodem i architektura wymagane.
Aktualizowanie kodu są zgodne z nową architektury.Wielokrotnie powtarzane projektowanie i konfliktów przedstawiono kod refactor do weryfikacji.
Uwzględnione warstwy weryfikacji w procesie kompilacji aby upewnić się, że kod w dalszym ciągu stosować się do swojego wzoru.
Tworzenie diagramu warstwowego
Należy utworzyć warstwowego diagramu w projekcie modelowania.Można dodać nowe warstwowego diagramu do istniejącego projektu modelowania, Utwórz nowy projekt modelowania diagramu warstwy lub kopiowanie istniejącego diagramu warstwy w obrębie tego samego projektu modelowania.
.gif "Ważna uwaga") Ważne |
|---|
Nie dodać, przeciągnij lub skopiuj istniejącego diagramu warstwy z projektu modelowania do innego projektu modelowania lub do innej lokalizacji w rozwiązaniu.Diagramy warstwowe, które są kopiowane w ten sposób będzie miał tych samych odniesień jako oryginalnego folderu, nawet jeśli zmodyfikować diagramu.To uniemożliwi weryfikacji warstwy prawidłowe działanie i może być przyczyną innych problemów, takich jak brakujących elementów lub inne błędy podczas próby otwarcia diagramu. |
Zobacz Tworzenie diagramów warstwy na podstawie kodu.
Definiowanie warstwy do reprezentowania obszarów funkcjonalnych lub składników
Warstwy reprezentuje grupy logiczne artefakty, takich jak projektów, pliki kodu, obszary nazw, klasy i metody.Możesz utworzyć warstwy z artefakty z projektów Visual C# .NET i Visual Basic .NET lub do warstwy można dołączyć specyfikacje lub plany, łącząc dokumenty, takie jak pliki programu Word lub prezentacje programu PowerPoint.Każda warstwa postać prostokąta na diagram i pokazuje liczbę artefakty, które są z nim połączone.Warstwy mogą zawierać warstwy zagnieżdżone opisujące innych zadań.
Jako wytyczne ogólne, nazwa warstwy zgodnie z ich funkcji, na przykład "Prezentacja" lub "Usługi".Jeśli artefaktów są ściśle wzajemnie, należy je umieścić w tej samej warstwie.Jeśli artefaktów można zaktualizować osobno lub używane w oddzielnych aplikacji, należy je umieścić w różnych warstwach.Aby dowiedzieć się więcej o wzorce warstw, odwiedź witrynę wzorce i najlepsze praktyki w https://go.microsoft.com/fwlink/?LinkId=145794.
.gif "Porada") Porada |
|---|
Niektóre rodzaje artefakty, które można połączyć z warstw, ale które nie obsługują sprawdzania poprawności względem warstwowego diagramu.Aby sprawdzić, czy artefaktu obsługuje weryfikacji, otwórz Explorer warstwy do zbadania obsługuje weryfikacji właściwości łącza artefaktu.Zobacz odnajdywanie istniejące zależności między warstwami. |
Podczas aktualizowania nieznanych aplikacji, można użyć wykresy zależności pomaga poznać i zrozumieć kod.Te wykresy mogą pomóc odkryć, klastry i zależności w kodzie.Możesz także użyć Eksploratora architektury do zbadania przestrzeni nazw i klas, które często dobrze odpowiadają istniejącym warstwom.Może to ułatwić ułatwić przypisania artefakty do warstwy.Możesz następnie użyć diagramów warstwowych, aby ułatwić aktualizowanie kodu.
Aby uzyskać więcej informacji, zobacz następujące tematy:
Odnajdywanie istniejące zależności między warstwami
Zależność istnieje wszędzie tam, gdzie artefakt, który jest skojarzony z jedną warstwą zawiera odwołanie do artefaktu skojarzonego z inną warstwą.Na przykład klasa w jednej warstwie deklaruje zmienną, która zawiera klasę w innej warstwie.Istniejące zależności może odnaleźć przez odtwarzania je.
[!UWAGA]
Zależności nie mogą być odtwarzane dla niektórych rodzajów artefaktów.Na przykład nie zostaną odtworzone żadne zależności z lub do warstwy, która jest połączona z plikiem tekstowym.Aby zobaczyć, które artefakty ma zależności, że można odtwarzanie, kliknij prawym przyciskiem myszy jednej lub wielu warstw, a następnie kliknij przycisk Wyświetl łącza.W Eksploratorze warstw, przeanalizuj kolumnę Obsługuje walidację.Zależności nie będą odtwarzane dla artefaktów, w których w tej kolumnie jest wyświetlana wartość Fałsz.
Aby odtwarzanie istniejące zależności między warstwami
- Wybierz warstwę jednego lub wielu warstw, kliknij prawym przyciskiem myszy zaznaczonej warstwy, a następnie kliknij Generowanie zależności.
Zazwyczaj zobaczysz niektóre zależności, które nie powinny istnieć.Możesz edytować te zależności, aby dopasować je do zamierzonego projektu.
Edytowanie warstw i zależności w celu przedstawienia zamierzonego projektu
Opisujące zmiany, które mają być systemu lub planowaną architekturę, aby edytować diagramy warstwowe, wykonaj następujące kroki.Można też rozważyć zmiany wprowadzone w niektórych refaktoryzacji do poprawy struktury kodu przed jej rozszerzeniem.Zobacz poprawy struktury kodu.
Aby |
Wykonaj następujące kroki |
|---|---|
Usunięcie zależności, który nie powinien istnieć |
Kliknij przycisk zależność, a następnie naciśnij klawisz usunąć. |
Zmień lub ogranicz kierunek zależności |
Ustaw właściwość Kierunek. |
Tworzenie nowych zależności |
Użyj narzędzi Zależność i Dwukierunkowe zależności. Aby narysować wiele zależności, kliknij dwukrotnie narzędzie.Gdy skończysz, kliknij przycisk wskaźnik narzędzie lub naciśnij klawisz ESC klucza. |
Określanie, że artefakty skojarzone z warstwą nie mogą zależeć od określonych przestrzeni nazw |
Wpisz przestrzenie nazw do właściwości Zabronione zależności przestrzeni nazw warstwy.Użyj średnika (;) do oddzielenia przestrzeni nazw. |
Określanie, że artefakty skojarzone z warstwą nie mogą należeć do określonych przestrzeni nazw |
Wpisz przestrzenie nazw do właściwości Zabronione przestrzenie nazw warstwy.Użyj średnika (;) do oddzielenia przestrzeni nazw. |
Określanie, że artefakty skojarzone z warstwą muszą należeć do jednej z określonych przestrzeni nazw |
Wpisz przestrzeń nazw do właściwości Wymagane przestrzenie nazw warstwy.Użyj średnika (;) do oddzielenia przestrzeni nazw. |
Poprawy struktury kodu
Zmiany refaktoryzacji są ulepszenia, które nie ma wpływu na zachowanie aplikacji, ale ułatwić Kodeksie zmienianie i rozszerzanie w przyszłości.Kod dobrze ma projektu łatwy do abstrakcyjnej do warstwowego diagramu.
Na przykład jeśli utworzysz warstwy dla każdego obszaru nazw w kodzie, a następnie odtwarzanie zależności, należy minimalny zbiór jednokierunkowego zależności między warstwami.Jeśli tworzysz bardziej szczegółowe diagramu za pomocą klasy lub metody jako warstw w wyniku należy również zaznaczyć te same właściwości.
Jeśli nie jest to możliwe, kod trudniej zmiany w całym użytkowania i będzie mniej odpowiednie dla weryfikacji za pomocą diagramów warstwowych.
Nowe obszary projektowania aplikacji
Podczas tworzenia nowego projektu lub nowego obszaru uruchamiania w nowy projekt, można rysować warstwy i zależności do identyfikowania głównych składników przed rozpoczęciem do tworzenia kodu.
Pokaż zidentyfikować wzorce architektury diagramy warstwowe, jeśli jest to możliwe.Na przykład warstwowego diagramu opisujące aplikację pulpitu mogą obejmować warstwy prezentacji, logika domeny i magazynu danych.Diagramy warstwowe, obejmujący pojedynczy funkcji w aplikacji może być warstwy Model, widok i kontroler.Aby uzyskać więcej informacji o tych wzorców, zobacz wzorce i praktyki: Architektura.
Jeśli często tworzysz podobne wzorców, należy utworzyć niestandardowe narzędzie.Zobacz Porady: definiowanie niestandardowego elementu przybornika modelowania.
Utwórz artefakt kodu dla każdej warstwy nazw, klasa lub składnik.Ułatwia wykonanie kodu, a także połączyć artefakty kodu z warstw.Jak utworzyć każdego artefaktu, połącz je z odpowiednią warstwę.
Nie trzeba połączyć najczęściej klasy i inne artefakty warstwy ponieważ mieści się w ramach większych artefakty, takie jak obszary nazw, które zostały już połączone warstwy.
Tworzenie nowego diagramu dla nowej funkcji.Zwykle pojawi się jeden lub więcej diagramów warstwowych opisujący całej aplikacji.W przypadku projektowania nowych funkcji w aplikacji, nie dodać lub zmienić istniejących diagramów.Zamiast tego należy utworzyć własny diagramu odzwierciedlającą nowe części kodu.Warstwy diagramu mogą obejmować prezentacji, logika domeny i warstwy bazy danych dla nowej funkcji.
Podczas tworzenia aplikacji, zarówno przed ogólną diagramu i bardziej szczegółowe diagramu funkcja zostanie zweryfikowana kodu.
Edytowanie układu dla prezentacji i dyskusji
Aby zidentyfikować zależności i warstwy lub omówić je z członkami zespołu, edytować wyglądu i układu diagramu w następujący sposób:
Zmień rozmiary, kształty i pozycje warstwy.
Zmienić kolory warstw i zależności.
- Wybierz jeden lub więcej warstw lub zależności, kliknij prawym przyciskiem myszy, a następnie kliknij właściwości.W właściwości okna, edytować kolor właściwości.
Sprawdź poprawność kodu względem diagramu
Po wprowadzeniu diagramu, możesz można sprawdzić jego poprawność kodu ręcznie w dowolnym momencie lub automatycznie każdym uruchomieniu lokalną kompilację lub Team Foundation Build.
Zobacz:
Dołączenia warstwy Weryfikacja procesu kompilacji
Aktualizowanie kodu są zgodne z nowej architektury
Zwykle błędy pojawi się po raz pierwszy Sprawdź poprawność kodu zaktualizowanych warstwowego diagramu.Te błędy mogą mieć kilka przyczyn:
Artefakt jest przypisany 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ą.W tym przypadku zrefaktoryzuj kod, aby usunąć zależność.
Aby rozwiązać te błędy, aktualizuj kod, dopóki nie przestaną pojawiać się błędy podczas walidacji.Jest to zwykle iterację.Aby uzyskać więcej informacji na temat tych błędów, zobacz Walidacja kodu przy użyciu diagramów warstwy.
[!UWAGA]
Podczas tworzenia lub refactor kod, może być konieczne nowe artefakty do warstwowego diagramu.To może być konieczne, na przykład, jeśli masz warstwy, które reprezentują istniejące obszary nazw i nowy kod tylko dodaje więcej materiałów do tych obszarów nazw.
Podczas procesu projektowania możesz pominąć niektóre konflikty zgłoszone podczas walidacji.Na przykład możesz pominąć błędy, które są już poprawiane lub które nie są istotne w konkretnym scenariuszu.Gdy błąd zostanie pominięty, dobrze jest dodać do dziennika element roboczy w Team Foundation.Aby wykonać to zadanie, zobacz Walidacja kodu przy użyciu diagramów warstwy.
Dołączenia warstwy Weryfikacja procesu kompilacji
W celu zapewnienia, że przyszłych zmian w kodzie, odpowiadają diagramy warstwowe, obejmują weryfikacji warstwy do procesu tworzenia standardowych swoje rozwiązanie.Przy każdym innym członkom zespołu tworzenie rozwiązania, jak tworzyć błędy będą raportowane różnice między zależności w kodzie i diagramy warstwowe.Aby uzyskać więcej informacji o tym warstwy weryfikacji w procesie kompilacji, zobacz Walidacja kodu przy użyciu diagramów warstwy.