Bagikan melalui

Tutorial: Membuat templat proyek

Dengan .NET, Anda dapat membuat dan menyebarkan templat yang menghasilkan proyek, file, dan sumber daya. Tutorial ini adalah bagian dua dari seri yang mengajarkan Anda cara membuat, menginstal, dan menghapus instalasi templat untuk digunakan dengan dotnet new perintah .

Petunjuk / Saran

Templat .NET resmi yang dikirim dengan .NET SDK dapat ditemukan di repositori berikut:

Templat Penyimpanan
Konsol, pustaka kelas, dan templat item umum dotnet/sdk
templat ASP.NET dan Blazor dotnet/aspnetcore
templat Aplikasi Halaman Tunggal ASP.NET dotnet/spa-templates
Templat WPF dotnet/wpf
Templat Windows Forms dotnet/winforms
Menguji templat dotnet/test-templates
Templat MAUI dotnet/maui

Anda dapat melihat templat yang diinstal pada komputer Anda dengan menjalankan dotnet new list perintah .

Di bagian seri ini, Anda mempelajari cara:

  • Buat sumber daya templat proyek.
  • Buat folder dan file konfigurasi templat.
  • Instal templat dari lokasi berkas.
  • Menguji templat item.
  • Uninstal templat item.

Prasyarat

  • .NET 9 atau versi yang lebih baru.

  • Selesaikan bagian 1 dari seri tutorial ini.

  • Buka terminal dan navigasikan ke folder working\content .

Membuat template proyek

Templat proyek menghasilkan proyek siap dijalankan yang memudahkan pengguna untuk memulai dengan sekumpulan kode yang berfungsi. .NET menyertakan beberapa templat proyek seperti aplikasi konsol atau pustaka kelas. Dalam contoh ini, Anda membuat proyek aplikasi konsol baru yang menggantikan output konsol "Halo Dunia" standar dengan yang berjalan secara asinkron.

Di terminal Anda, navigasikan ke folder working\content dan buat subfolder baru bernama consoleasync. Masukkan subfolder dan jalankan dotnet new console untuk menghasilkan aplikasi konsol standar. Edit file yang dihasilkan oleh templat ini untuk membuat templat baru.

working
└───content
    └───consoleasync
            consoleasync.csproj
            Program.cs

Mengubah Program.cs

Buka file Program.cs . Proyek konsol standar tidak menulis ke output konsol secara asinkron, jadi tambahkan fungsionalitas penulisan asinkron tersebut. Ubah kode menjadi berikut dan simpan file:

// See https://aka.ms/new-console-template for more information
await Console.Out.WriteAsync("Hello World with C#");

Sekarang setelah Anda memiliki konten templat yang dibuat, Anda perlu membuat konfigurasi templat di folder akar templat.

Membuat konfigurasi templat

Dalam tutorial ini, folder templat Anda terletak di working\content\consoleasync.

Templat dikenali oleh .NET karena memiliki folder khusus dan file konfigurasi di akar folder templat Anda.

Pertama, buat subfolder baru bernama .template.config, dan masukkan. Kemudian, buat file baru bernama template.json. Struktur folder Anda akan terlihat seperti ini:

working
└───content
    └───consoleasync
        └───.template.config
                template.json

Buka template.json dengan editor teks favorit Anda dan tempelkan kode json berikut dan simpan.

{
  "$schema": "http://json.schemastore.org/template",
  "author": "Me",
  "classifications": [ "Common", "Console" ],
  "identity": "ExampleTemplate.AsyncProject",
  "name": "Example templates: async project",
  "shortName": "consoleasync",
  "sourceName":"consoleasync",
  "tags": {
    "language": "C#",
    "type": "project"
  }
}

File konfigurasi ini berisi semua pengaturan untuk templat Anda. Anda dapat melihat pengaturan dasar, seperti name dan shortName, tetapi ada juga tags/type nilai yang diatur ke project. Ini mengategorikan templat Anda sebagai templat "proyek". Tidak ada batasan pada jenis templat yang Anda buat. Nilai item dan project adalah nama umum yang direkomendasikan .NET sehingga pengguna dapat dengan mudah memfilter jenis templat yang mereka cari.

Item sourceName adalah yang akan digantikan ketika pengguna menggunakan template. Nilai sourceName dalam file konfigurasi dicari di setiap nama file dan konten file, dan secara default diganti dengan nama folder saat ini. Ketika parameter -n atau --name diteruskan dengan perintah dotnet new, nilai yang disediakan digunakan menggantikan nama folder saat ini. Dalam kasus templat ini, consoleasync diganti dengan nama file .csproj .

Item classifications mewakili kolom tag yang Anda lihat saat menjalankan dotnet new dan mendapatkan daftar templat. Pengguna juga dapat mencari berdasarkan tag klasifikasi. Jangan membingungkan tags properti dalam file template.json dengan classifications daftar tag. Mereka adalah dua konsep berbeda yang sayangnya dinamai sama. Skema lengkap untuk file template.json ditemukan di Penyimpanan Skema JSON dan dijelaskan di Referensi untuk template.json. Untuk informasi selengkapnya tentang file template.json , lihat wiki templat dotnet.

Sekarang setelah Anda memiliki file .template.config/template.json yang valid, templat Anda siap untuk diinstal. Sebelum menginstal templat, pastikan Anda menghapus folder dan file tambahan yang tidak ingin Disertakan dalam templat Anda, seperti folder bin atau obj . Di terminal Anda, navigasikan ke folder consoleasync dan jalankan dotnet new install .\ untuk menginstal templat yang terletak di folder saat ini. Jika Anda menggunakan sistem operasi Linux atau macOS, gunakan garis miring: dotnet new install ./.

dotnet new install .\

Perintah ini menghasilkan daftar templat yang diinstal, yang harus menyertakan templat Anda.

The following template packages will be installed:
   <root path>\working\content\consoleasync

Success: <root path>\working\content\consoleasync installed the following templates:
Templates                                         Short Name               Language          Tags
--------------------------------------------      -------------------      ------------      ----------------------
Example templates: async project                  consoleasync             [C#]              Common/Console

Menguji templat proyek

Sekarang setelah Anda memiliki templat proyek yang terinstal, uji.

  1. Navigasikan ke folder pengujian .

  2. Buat aplikasi konsol baru dengan perintah berikut, yang menghasilkan proyek kerja yang dapat Anda uji dengan mudah dengan dotnet run perintah .

    dotnet new consoleasync -n MyProject

    Anda mendapatkan output berikut.

    The template "Example templates: async project" was created successfully.

  3. Jalankan proyek menggunakan perintah berikut.

    dotnet run

    Anda mendapatkan output berikut.

    Hello World with C#

Selamat! Anda membuat dan menyebarkan templat proyek dengan .NET. Sebagai persiapan untuk bagian berikutnya dari seri tutorial ini, hapus instalan templat yang Anda buat. Pastikan untuk menghapus semua file dari folder pengujian juga. Ini membuat Anda kembali ke kondisi bersih yang siap untuk bagian berikutnya dari seri tutorial ini.

Menghapus pemasangan templat

Di terminal Anda, navigasikan ke folder consoleasync dan jalankan perintah berikut untuk menghapus instalasi templat yang terletak di folder saat ini:

  • Pada Windows: dotnet new uninstall .\
  • Di Linux atau macOS: dotnet new uninstall ./

Perintah ini menghasilkan daftar templat yang dihapus instalasinya, yang harus menyertakan templat Anda.

Success: <root path>\working\content\consoleasync was uninstalled.

Kapan saja, Anda dapat menggunakan dotnet new uninstall untuk melihat daftar paket templat yang diinstal, termasuk untuk setiap paket templat perintah untuk menghapus instalannya.

Langkah selanjutnya

Dalam tutorial ini, Anda membuat templat proyek. Untuk mempelajari cara mengemas templat item dan proyek ke dalam file yang mudah digunakan, lanjutkan seri tutorial ini.

Membuat paket templat

  • Last updated on