Diagrammi delle dipendenze: linee guida
Descrivere l'architettura dell'app a livello generale creando diagrammi di dipendenza in Visual Studio. Assicurarsi che il codice rimanga coerente con questa progettazione convalidando il codice con un diagramma delle dipendenze. È anche possibile includere la convalida dei livelli nel processo di compilazione.
Per vedere quali edizioni di Visual Studio supportano questa funzionalità, vedere Supporto dell'edizione per gli strumenti di architettura e modellazione.
Nota
I diagrammi di dipendenza per i progetti .NET Core sono supportati a partire da Visual Studio 2019 versione 16.2.
Che cos'è un diagramma delle dipendenze?
Come un diagramma dell'architettura tradizionale, un diagramma delle dipendenze identifica i componenti principali o le unità funzionali della progettazione e le relative interdipendenze. Ogni nodo del diagramma, denominato layer, rappresenta un gruppo logico di spazi dei nomi, progetti o altri artefatti. È possibile tracciare le dipendenze che devono esistere nella progettazione. A differenza di un diagramma architettura tradizionale, è possibile verificare che le dipendenze effettive nel codice sorgente siano conformi alle dipendenze desiderate specificate. Facendo parte della convalida di una compilazione regolare su Team Foundation Server , è possibile assicurarsi che il codice del programma continui a rispettare l'architettura del sistema tramite modifiche future. Vedere Diagrammi delle dipendenze: Informazioni di riferimento.
Come progettare o aggiornare l'app con diagrammi di dipendenza
I passaggi seguenti forniscono una panoramica dell'uso dei diagrammi di dipendenza all'interno del processo di sviluppo. Le sezioni successive in questo argomento descrivono in modo più dettagliato ogni passaggio. Se si sviluppa una nuova progettazione, omettere i passaggi relativi al codice esistente.
Nota
I passaggi sono visualizzati in ordine approssimativo. Potrebbe essere necessario sovrapporre alcune attività, riordinarle per adattarle alla situazione specifica ed eseguirle di nuovo all'inizio di ogni iterazione nel progetto.
Creare un diagramma delle dipendenze per l'intera applicazione o per un livello al suo interno.
Definire i livelli per rappresentare le aree funzionali o i componenti principali dell'applicazione. Assegnare a questi livelli nomi conformi alla relativa funzione, ad esempio "Presentazione" o "Servizi". Se si dispone di una soluzione di Visual Studio, è possibile associare ogni livello a una raccolta di artefatti, ad esempio progetti, spazi dei nomi, file e così via.
Individuare le dipendenze esistenti tra i livelli.
Modificare i livelli e le dipendenze per visualizzare la progettazione aggiornata che si vuole che il codice rifletta.
Progettare nuove aree dell'applicazione creando livelli per rappresentare i blocchi o i componenti principali dell'architettura e definendo le dipendenze per mostrare come ogni livello usa gli altri.
Modificare il layout e l'aspetto del diagramma per illustrarlo con i colleghi.
Convalidare il codice rispetto al diagramma delle dipendenze per evidenziare i conflitti tra il codice e l'architettura necessaria.
Aggiornare il codice in modo che sia conforme alla nuova architettura. Sviluppare in modo iterativo ed effettuare il refactoring del codice fino a ottenere una convalida senza conflitti.
Includere la convalida del livello nel processo di compilazione per assicurarsi che il codice continui a rispettare la progettazione.
Creare un diagramma delle dipendenze
Un diagramma delle dipendenze deve essere creato all'interno di un progetto di modellazione. È possibile aggiungere un nuovo diagramma di dipendenza a un progetto di modellazione esistente, creare un nuovo progetto di modellazione per il diagramma delle dipendenze o copiare un diagramma delle dipendenze esistente all'interno dello stesso progetto di modellazione.
Importante
Non aggiungere, trascinare o copiare un diagramma delle dipendenze esistente da un progetto di modellazione a un altro progetto di modellazione o in un'altra posizione nella soluzione. Un diagramma delle dipendenze copiato in questo modo avrà gli stessi riferimenti del diagramma originale, anche se si modifica il diagramma. Ciò impedirà il corretto funzionamento della convalida dei livelli e potrebbe provocare altri problemi, ad esempio la mancanza di elementi o altri errori durante il tentativo di apertura del diagramma.
Vedere Creare diagrammi di dipendenza dal codice.
Definire i livelli per rappresentare aree funzionali o componenti
I livelli rappresentano gruppi logici di artefatti, ad esempio progetti, file di codice, spazi dei nomi, classi e metodi. È possibile creare livelli da elementi di progetti Visual C# e Visual Basic oppure allegare specifiche o piani a un livello collegando documenti, ad esempio file di Word o presentazioni di PowerPoint. Ogni livello viene visualizzato come un rettangolo nel diagramma e viene indicato il numero di artefatti collegati a ogni livello. Un livello può contenere livelli annidati che descrivono attività più specifiche.
È in genere consigliabile assegnare a questi livelli nomi conformi alla relativa funzione, ad esempio "Presentazione" o "Servizi". Se gli artefatti sono strettamente interdipendenti, posizionarli nello stesso livello. Se gli artefatti possono essere aggiornati separatamente o possono essere usati in applicazioni distinte, posizionarli in livelli diversi.
Suggerimento
Esistono alcuni tipi di artefatti che è possibile collegare a livelli, ma che non supportano la convalida rispetto al diagramma delle dipendenze. Per verificare se l'artefatto supporta la convalida, aprire Esplora layer per esaminare la proprietà Supports Validation del collegamento artefatto. Vedere Individuare le dipendenze esistenti tra i livelli.
Quando si aggiorna un'applicazione poco nota, è anche possibile creare mappe codice. Questi diagrammi consentono di individuare i motivi e le dipendenze durante l'esplorazione del codice. Usare Esplora soluzioni per esplorare spazi dei nomi e classi, che spesso corrispondono correttamente ai livelli esistenti. Assegnare questi artefatti di codice ai livelli trascinandoli da Esplora soluzioni a diagrammi di dipendenza. È quindi possibile usare diagrammi di dipendenza per aggiornare il codice e mantenerlo coerente con la progettazione.
Vedere:
Individuare le dipendenze esistenti tra i livelli
È presente una dipendenza quando un elemento associato a un livello dispone di un riferimento a un elemento associato a un altro livello. Ad esempio, una classe di un livello dichiara una variabile che dispone di una classe in un altro livello. Per individuare le dipendenze esistenti, è possibile decompilarle.
Nota
Non è possibile decompilare dipendenze per determinati tipi di elementi. Ad esempio, non è possibile decompilare dipendenze da e verso un livello collegato a un file di testo. Per visualizzare gli elementi con dipendenze che è possibile invertire, fare clic con il pulsante destro del mouse su uno o più livelli e quindi scegliere Visualizza collegamenti. In Esplora layer esaminare la colonna Supporta convalida . Le dipendenze non verranno ingegneriate in modo inverso per gli artefatti per i quali questa colonna mostra False.
Per decompilare le dipendenze esistenti tra i livelli
Selezionare un livello o più livelli, fare clic con il pulsante destro del mouse su un livello selezionato e quindi scegliere Genera dipendenze.
In genere vengono visualizzate alcune dipendenze che non dovrebbero esistere. È possibile modificare queste dipendenze per allinearle con la progettazione desiderata.
Modificare livelli e dipendenze per visualizzare la progettazione prevista
Per descrivere le modifiche che si prevede di apportare al sistema o all'architettura desiderata, seguire questa procedura per modificare il diagramma delle dipendenze. È anche possibile prendere in considerazione alcune modifiche relative al refactoring per migliorare la struttura del codice prima di estenderlo. Vedere Miglioramento della struttura del codice.
| Per | Eseguire questi passaggi |
|---|---|
| Eliminare una dipendenza che non dovrebbe essere presente | Fare clic sulla dipendenza e quindi premere CANC. |
| Modificare o limitare la direzione di una dipendenza | Impostarne la proprietà Direction . |
| Creare nuove dipendenze | Usare gli strumenti Dipendenze e Dipendenze bidirezionali. Per disegnare più dipendenze, fare doppio clic sullo strumento. Al termine, fare clic sullo strumento Puntatore o premere ESC. |
| Specificare che gli elementi associati a un livello non possono dipendere dagli spazi dei nomi specificati | Digitare gli spazi dei nomi nella proprietà Dipendenze spazio dei nomi non consentito del livello. Usare un punto e virgola (;) per separare gli spazi dei nomi. |
| Specificare che gli elementi associati a un livello non devono appartenere agli spazi dei nomi specificati | Digitare gli spazi dei nomi nella proprietà Spazi dei nomi non consentiti del livello. Usare un punto e virgola (;) per separare gli spazi dei nomi. |
| Specificare che gli artefatti associati a un livello non devono appartenere a uno degli spazi dei nomi specificati | Digitare lo spazio dei nomi nella proprietà Required Namespaces del layer. Usare un punto e virgola (;) per separare gli spazi dei nomi. |
Miglioramento della struttura del codice
Le modifiche relative al refactoring sono miglioramenti che non influiscono sul comportamento dell'applicazione, ma contribuiscono a rendere il codice più semplice da modificare ed estendere nel futuro. Il codice ben strutturato ha una progettazione facile da astrarre a un diagramma delle dipendenze.
Ad esempio, se si crea un livello per ogni spazio dei nomi nel codice e quindi si decompilano le dipendenze, dovrebbe essere presente un insieme minimo di dipendenze unidirezionali tra i livelli. Se si crea un diagramma più dettagliato usando classi o metodi come livelli, il risultato dovrebbe avere le stesse caratteristiche.
In caso contrario, il codice sarà più difficile da modificare per tutta la sua vita e sarà meno adatto per la convalida usando diagrammi di dipendenza.
Progettare nuove aree dell'applicazione
Quando si inizia a sviluppare un nuovo progetto o una nuova area in un nuovo progetto, è possibile tracciare livelli e dipendenze per semplificare l'identificazione dei componenti principali prima di iniziare a sviluppare il codice.
Mostra modelli architetturali identificabili nei diagrammi delle dipendenze, se possibile. Ad esempio, un diagramma delle dipendenze che descrive un'applicazione desktop può includere livelli come Presentazione, Logica di dominio e Archivio dati. Un diagramma delle dipendenze che copre una singola funzionalità all'interno di un'applicazione potrebbe avere livelli come Modello, Visualizzazione e Controller.
Creare un artefatto di codice per ogni livello , ad esempio uno spazio dei nomi, una classe o un componente. In questo modo sarà più semplice seguire il codice e collegare gli elementi di codice ai livelli. Non appena si crea ogni artefatto, collegarlo al livello appropriato.
Non è necessario collegare la maggior parte delle classi e di altri artefatti ai livelli perché rientrano in artefatti più grandi, ad esempio spazi dei nomi già collegati ai livelli.
Creare un nuovo diagramma per una nuova funzionalità. In genere, ci saranno uno o più diagrammi di dipendenza che descrivono l'intera applicazione. Se si progetta una nuova funzionalità nell'applicazione, non apportare aggiunte o modifiche ai diagrammi esistenti. Creare invece un diagramma personalizzato che rispecchia nuove parti del codice. I livelli nel nuovo diagramma possono includere livelli relativi a presentazione, logica di dominio e database per la nuova funzionalità.
Quando si compila l'applicazione, il codice verrà convalidato rispetto al diagramma complessivo e al diagramma più dettagliato relativo alle funzionalità.
Modificare il layout per la presentazione e la discussione
Per semplificare l'identificazione di livelli e dipendenze o per esaminarli con i membri del team, modificare l'aspetto e il layout del diagramma nei modi seguenti:
Modificare le dimensioni, le forme e le posizioni dei livelli.
Cambiare i colori dei livelli e le dipendenze.
- Selezionare uno o più livelli o dipendenze, fare clic con il pulsante destro del mouse e quindi scegliere Proprietà. Nella finestra Proprietà modificare la proprietà Color.
Convalidare il codice rispetto al diagramma
Dopo aver modificato il diagramma, è possibile convalidarlo manualmente in base al codice in qualsiasi momento o automaticamente ogni volta che si compila.
Vedere:
Aggiornare il codice in modo che sia conforme alla nuova architettura
In genere, gli errori verranno visualizzati la prima volta che si convalida il codice rispetto a un diagramma delle dipendenze aggiornato. Gli errori possono avere cause diverse:
Un artefatto viene assegnato al livello errato. In questo caso, spostare l'elemento.
Un elemento, ad esempio una classe, usa un'altra classe in un modo che causa conflitti con l'architettura. In questo caso, eseguire il refactoring del codice per rimuovere la dipendenza.
Per risolvere gli errori, aggiornare il codice finché non verranno più visualizzati errori di convalida. Si tratta in genere di un processo iterativo. Per altre informazioni su questi errori, vedere Convalidare il codice con diagrammi di dipendenza.
Nota
Durante lo sviluppo o il refactoring del codice, potrebbero essere presenti nuovi artefatti da collegare al diagramma delle dipendenze. È tuttavia possibile che ciò non sia necessario, ad esempio se sono presenti livelli che rappresentano spazi dei nomi esistenti e il nuovo codice aggiunge altri elementi a questi spazi dei nomi.
Durante il processo di sviluppo, potrebbe essere necessario eliminare alcuni conflitti segnalati durante la convalida. Ad esempio, è possibile eliminare gli errori che sono già stati corretti o che non sono attinenti allo scenario in questione. Quando si elimina un errore, è consigliabile registrare un elemento di lavoro in Team Foundation. Per eseguire questa attività, vedere Convalidare il codice con diagrammi di dipendenza.
Includere la convalida del livello nel processo di compilazione
Per garantire che le modifiche future nel codice siano conformi ai diagrammi di dipendenza, includere la convalida del livello per il processo di compilazione standard della soluzione. Ogni volta che altri membri del team compilano la soluzione, eventuali differenze tra le dipendenze nel codice e il diagramma delle dipendenze verranno segnalate come errori di compilazione. Per altre informazioni sull'inclusione della convalida del livello nel processo di compilazione, vedere Convalidare il codice con diagrammi di dipendenza.