Bagikan melalui


Membuat diagram dependensi dari kode Anda

Untuk memvisualisasikan arsitektur logis tingkat tinggi sistem perangkat lunak Anda, buat diagram dependensi di Visual Studio. Untuk memastikan bahwa kode Anda tetap konsisten dengan desain ini, validasi kode Anda dengan diagram dependensi. Anda dapat membuat diagram dependensi untuk proyek Visual C# dan Visual Basic. Untuk melihat edisi Visual Studio mana yang mendukung fitur ini, lihat Dukungan edisi untuk arsitektur dan alat pemodelan.

Membuat diagram dependensi

Diagram dependensi memungkinkan Anda mengatur item solusi Visual Studio ke dalam grup abstrak logis yang disebut lapisan. Anda dapat menggunakan lapisan untuk menjelaskan tugas utama yang dilakukan artefak ini atau komponen utama sistem.

Setiap lapisan mungkin berisi lapisan lain yang menjelaskan tugas yang lebih rinci. Anda juga dapat menentukan dependensi yang dimaksudkan atau yang sudah ada di antara lapisan. Dependensi ini, yang direpresentasikan sebagai panah, menunjukkan lapisan yang menggunakan atau dapat menggunakan fungsionalitas yang diwakili oleh lapisan lain. Untuk mempertahankan kontrol arsitektur kode, tunjukkan dependensi yang dimaksud pada diagram dan kemudian validasi kode terhadap diagram.

Video: Memvalidasi dependensi arsitektur Anda secara real time

Membuat diagram dependensi

Sebelum Anda membuat diagram dependensi, pastikan solusi Anda memiliki proyek pemodelan.

Penting

Jangan menambahkan, menarik, atau menyalin diagram dependensi yang ada dari satu proyek pemodelan ke proyek pemodelan lain, atau ke tempat lain dalam solusi. Ini mempertahankan referensi dari diagram asli, bahkan jika Anda mengubah diagram. Ini juga mencegah validasi lapisan berfungsi dengan benar dan mungkin menyebabkan masalah lain, seperti elemen yang hilang atau kesalahan lain saat Anda mencoba membuka diagram.

Sebagai gantinya, tambahkan diagram dependensi baru ke proyek pemodelan. Salin elemen dari diagram sumber ke diagram baru. Simpan keduanya, proyek pemodelan dan diagram dependensi baru.

Menambahkan diagram dependensi baru ke proyek pemodelan

Catatan

Diagram dependensi untuk proyek .NET Core yang didukung untuk memulai Visual Studio 2019 versi 16.2.

  1. Pada menu Arsitektur, pilih Diagram Dependensi Baru.

  2. Di bawah Template, pilih diagram dependensi.

  3. Beri nama diagram.

  4. Pada Tambahkan ke Proyek Pemodelan, telusuri dan pilih proyek pemodelan yang sudah ada di solusi Anda.

    -atau-

    Pilih Buat proyek pemodelan baru untuk menambahkan proyek pemodelan baru ke solusi.

    Catatan

    Diagram dependensi harus ada di dalam proyek pemodelan. Namun, Anda dapat menautkannya ke item di mana saja dalam solusi.

  5. Pastikan untuk menyimpan keduanya, proyek pemodelan dan diagram dependensi.

Seret dan letakkan, atau salin dan tempel, dari Peta Kode

  1. Buat Peta Kode untuk solusi menggunakan menu Arsitektur.

  2. Pertimbangkan untuk menerapkan filter Peta Kode untuk menghapus folder solusi dan "Uji Aset" jika Anda hanya ingin menerapkan dependensi dalam kode produk.

  3. Pada Peta Kode yang dihasilkan, hapus node "Eksternal", atau perluas untuk menampilkan rakitan eksternal, tergantung pada apakah Anda ingin menerapkan dependensi namespace layanan. Hapus rakitan yang tidak diperlukan dari Peta Kode.

  4. Buat Diagram Dependensi baru untuk solusi dengan menggunakan menu Arsitektur.

  5. Pilih semua simpul di Peta Kode (gunakan Ctrl + A, atau gunakan pemilihan pita karet dengan menekan tombol Shift sebelum Anda mengklik, menyeret, dan melepaskan).

  6. Tarik dan letakkan, atau salin dan tempel, elemen yang dipilih ke diagram Validasi Dependensi baru.

  7. Ini menunjukkan arsitektur aplikasi saat ini. Putuskan apa yang Anda inginkan untuk arsitektur dan ubah diagram dependensi yang sesuai.

Diagram dependensi yang dihasilkan dari Peta Kode

Membuat lapisan dari artefak

Anda dapat membuat lapisan dari item solusi Visual Studio, seperti proyek, file kode, namespace layanan, kelas, dan metode. Ini secara otomatis membuat tautan antara lapisan dan item, termasuk dalam proses validasi lapisan.

Anda bisa menautkan lapisan ke item yang tidak mendukung validasi, seperti dokumen Word atau presentasi PowerPoint. Ini memungkinkan Anda mengaitkan lapisan dengan spesifikasi atau paket. Anda juga dapat menautkan lapisan ke file dalam proyek yang dibagikan di beberapa aplikasi, tetapi proses validasi tidak akan menyertakan lapisan tersebut, yang muncul dengan nama generik seperti "Layer 1" dan "Layer 2".

Untuk melihat apakah item tertaut mendukung validasi, buka Penjelajah Lapisan dan periksa properti Validasi Dukungan item. Lihat Mengelola tautan ke artefak.

Untuk Ikuti langkah-langkah ini
Membuat lapisan untuk artefak tunggal
  1. Tarik item ke diagram dependensi dari sumber ini:
    Lapisan muncul pada diagram dan ditautkan ke artefak.
  2. Ganti nama lapisan untuk mencerminkan tanggung jawab kode atau artefak terkait.

Penting: Menyeret file biner ke diagram dependensi tidak secara otomatis menambahkan referensinya ke proyek pemodelan. Tambahkan file biner secara manual yang ingin Anda validasi ke proyek pemodelan. Untuk menambahkan file biner ke proyek pemodelan
  1. Pada Penjelajah Solusi, buka menu pintasan untuk proyek pemodelan, lalu pilih Tambahkan Item yang Ada.
  2. Dalam kotak dialog Tambahkan Item yang Sudah Ada, telusuri ke file biner, pilih file, lalu pilih OKE. File biner muncul dalam proyek pemodelan.
  3. Di Penjelajah Solusi, pilih file biner yang Anda tambahkan, lalu tekan F4 untuk membuka jendela Properti.
  4. Pada setiap file biner, atur properti Tindakan Build ke Validasi.
Membuat lapisan tunggal untuk semua artefak yang dipilih Tarik semua artefak ke diagram dependensi secara bersamaan.

Lapisan muncul pada diagram dan ditautkan ke semua artefak.
Membuat lapisan untuk setiap artefak yang dipilih Tekan dan tahan tombol SHIFT saat Anda menarik semua artefak ke diagram dependensi secara bersamaan.
Catatan: Jika Anda menggunakan tombol SHIFT untuk memilih rentang item, lepaskan kunci setelah Anda memilih artefak. Tekan dan tahan lagi saat Anda menyeret artefak ke diagram.

Lapisan untuk setiap artefak muncul pada diagram dan ditautkan ke setiap artefak.
Menambahkan artefak ke lapisan Seret artefak ke lapisan.
Membuat lapisan baru yang tidak ditautkan Di Kotak Alat, perluas bagian Diagram Dependensi, lalu seret Lapisan ke diagram dependensi.

Untuk menambahkan beberapa lapisan, klik dua kali pada alat. Setelah selesai, pilih alat Penunjuk atau tekan tombol ESC.

- atau -

Buka menu pintasan untuk diagram dependensi, pilih Tambahkan, lalu pilih Lapisan.
Membuat lapisan berlapis Tarik lapisan yang ada ke lapisan lain.

- atau -

Buka menu pintasan untuk lapisan, pilih Tambahkan, lalu pilih Lapisan.
Membuat lapisan baru yang berisi dua atau beberapa lapisan yang ada Pilih lapisan, buka menu pintasan untuk pilihan Anda, lalu pilih Grup.
Mengubah warna lapisan Atur properti Warna ke warna yang Anda inginkan.
Tentukan bahwa artefak yang terkait dengan lapisan seharusnya bukan milik namespace layanan yang ditentukan Ketik namespace layanan di properti Namespace Terlarang lapisan. Gunakan titik koma (;) untuk memisahkan namespace layanan.
Tentukan bahwa artefak yang terkait dengan lapisan tidak dapat bergantung pada namespace layanan yang ditentukan Ketik namespace layanan di properti Dependensi Namespace Terlarang lapisan. Gunakan titik koma (;) untuk memisahkan namespace layanan.
Menentukan bahwa artefak yang terkait dengan lapisan harus tergolong dalam salah satu namespace layanan yang ditentukan Ketik namespace layanan di properti Namespace Layanan Yang Diperlukan lapisan. Gunakan titik koma (;) untuk memisahkan namespace layanan.

Angka pada lapisan menunjukkan jumlah artefak yang ditautkan ke lapisan. Namun, saat membaca nomor ini, ingatlah:

  • Jika lapisan terhubung ke artefak yang berisi artefak lain, tetapi lapisan tidak terhubung langsung ke artefak lain, maka angka tersebut hanya menyertakan artefak yang ditautkan. Namun, artefak lainnya disertakan untuk analisis selama validasi lapisan.

    Misalnya, jika lapisan ditautkan ke satu namespace layanan, maka jumlah artefak tertaut adalah 1, bahkan jika namespace layanan berisi kelas. Jika lapisan juga memiliki tautan ke setiap kelas di namespace layanan, maka angka tersebut akan menyertakan kelas yang ditautkan.

  • Jika lapisan berisi lapisan lain yang ditautkan ke artefak, maka lapisan kontainer juga ditautkan ke artefak tersebut, meskipun angka pada lapisan kontainer tidak menyertakan artefak tersebut.

Mengelola tautan antara lapisan dan artefak

  1. Pada diagram dependensi, buka menu pintasan untuk lapisan, lalu pilih Tampilkan Tautan.

    Penjelajah Lapisan menunjukkan tautan artefak untuk lapisan yang dipilih.

  2. Gunakan tugas berikut untuk mengelola tautan ini:

Untuk Pada Penjelajah Lapisan
Menghapus tautan antara lapisan dan artefak Buka menu pintasan untuk tautan artefak, lalu pilih Hapus.
Memindahkan tautan dari satu lapisan ke lapisan lainnya Tarik tautan artefak ke lapisan yang ada pada diagram.

- atau -

1. Buka menu pintasan untuk tautan artefak, lalu pilih Potong.
2. Pada diagram dependensi, buka menu pintasan untuk lapisan, lalu pilih Tempel.
Salin tautan dari satu lapisan ke lapisan lainnya 1. Buka menu pintasan untuk tautan artefak, lalu pilih Salin.
2. Pada diagram dependensi, buka menu pintasan untuk lapisan, lalu pilih Tempel.
Membuat lapisan baru dari tautan artefak yang ada Tarik tautan artefak ke area kosong pada diagram.
Verifikasi bahwa artefak tertaut mendukung validasi untuk diagram dependensi. Lihat kolom Mendukung Validasi untuk tautan artefak.

Merekayasa balik dependensi yang ada

Dependensi ada di mana pun artefak yang terkait dengan satu lapisan memiliki referensi ke artefak yang terkait dengan lapisan yang lain. Misalnya, kelas dalam satu lapisan mendeklarasikan variabel yang memiliki kelas di lapisan yang lain. Anda dapat merekayasa balik dependensi yang ada untuk artefak yang ditautkan ke lapisan pada diagram.

Catatan

Dependensi tidak dapat direkayasa balik untuk jenis artefak tertentu. Misalnya, tidak ada dependensi yang akan direkayasa balik dari atau ke lapisan yang ditautkan ke file teks. Untuk melihat artefak mana yang memiliki dependensi yang dapat direkayasa balik, buka menu pintasan untuk satu atau beberapa lapisan, lalu pilih Tampilkan Tautan. Di Penjelajah Lapisan, periksa kolom Validasi Dukungan. Dependensi tidak akan direkayasa balik untuk artefak yang kolom ini menampilkan False.

  • Pilih satu atau beberapa lapisan, buka menu pintasan untuk lapisan yang dipilih dan pilih Hasilkan Dependensi.

    Jika Anda melihat beberapa dependensi yang seharusnya tidak ada, Anda dapat mengedit dependensi ini untuk menyelaraskannya dengan desain yang dimaksudkan.

Edit lapisan dan dependensi untuk menunjukkan desain yang dimaksudkan

Untuk menjelaskan perubahan yang Anda rencanakan akan dilakukan pada sistem atau arsitektur yang dimaksudkan, edit diagram dependensi:

Untuk Lakukan langkah-langkah ini
Mengubah atau membatasi arah dependensi Atur properti Arahnya.
Membuat dependensi baru Gunakan alat Dependensi dan Dependensi Dua Arah.

Untuk menggambar beberapa dependensi, klik dua kali alat. Setelah selesai, pilih alat Penunjuk atau tekan tombol ESC.
Tentukan bahwa artefak yang terkait dengan lapisan tidak dapat bergantung pada namespace layanan yang ditentukan Ketik namespace layanan di properti Dependensi Namespace Terlarang lapisan. Gunakan titik koma (;) untuk memisahkan namespace layanan.
Menentukan bahwa artefak yang terkait dengan lapisan tidak boleh tergolong dalam namespace layanan yang ditentukan Ketik namespace layanan di properti Namespace Terlarang lapisan. Gunakan titik koma (;) untuk memisahkan namespace layanan.
Menentukan bahwa artefak yang terkait dengan lapisan harus tergolong dalam salah satu namespace layanan yang ditentukan Ketik namespace layanan di properti Namespace Layanan Yang Diperlukan lapisan. Gunakan titik koma (;) untuk memisahkan namespace layanan.

Mengubah bagaimana elemen muncul pada diagram

Anda dapat mengubah ukuran, bentuk, warna, dan posisi lapisan atau warna dependensi dengan mengedit propertinya.

Menemukan pola dan dependensi pada peta kode

Saat membuat diagram dependensi, Anda mungkin juga membuat peta kode. Diagram ini dapat membantu Anda menemukan pola dan dependensi saat Anda menjelajahi kode. Gunakan Penjelajah Solusi, Tampilan Kelas, atau Browser Objek untuk menjelajahi rakitan, namespace layanan, dan kelas - yang seringkali sesuai dengan lapisan yang ada. Untuk informasi selengkapnya, lihat: