Bagikan melalui


Mengelola pengaturan aplikasi (.NET)

Pengaturan aplikasi memungkinkan Anda menyimpan informasi aplikasi secara dinamis. Dengan pengaturan aplikasi, Anda dapat menggunakan komputer klien untuk menyimpan informasi yang seharusnya tidak disertakan dalam kode aplikasi saat runtime. Pengaturan aplikasi dapat mencakup string koneksi, preferensi pengguna, dan lainnya.

Nota

Pengaturan aplikasi menggantikan properti dinamis yang digunakan dalam versi Visual Studio yang lebih lama.

Setiap pengaturan aplikasi harus memiliki nama yang unik. Nama dapat berupa kombinasi huruf, angka, atau garis bawah apa pun. Nama tidak dapat dimulai dengan angka, dan tidak dapat memiliki spasi. Nama diubah melalui properti Name.

Pengaturan aplikasi dapat disimpan sebagai jenis data apa pun yang diserialisasikan ke XML atau memiliki TypeConverter yang mengimplementasikan ToString/FromString. Jenis yang paling umum adalah String, Integer, dan Boolean. Anda juga dapat menyimpan nilai sebagai Color, Object, atau sebagai string koneksi.

Pengaturan aplikasi juga menyimpan nilai. Nilai diatur dengan properti Nilai dan harus cocok dengan tipe data dari pengaturan.

Selain itu, pengaturan aplikasi dapat terikat ke properti formulir atau kontrol pada waktu desain.

Ada dua jenis pengaturan aplikasi, berdasarkan cakupan:

  • Pengaturan cakupan aplikasi dapat digunakan untuk informasi seperti URL untuk layanan web atau string koneksi database. Nilai-nilai ini dikaitkan dengan aplikasi. Oleh karena itu, pengguna tidak dapat mengubahnya saat runtime.

  • Pengaturan cakupan pengguna dapat digunakan untuk informasi seperti mempertahankan posisi terakhir formulir atau preferensi font. Pengguna dapat mengubah nilai-nilai ini saat runtime.

Anda dapat mengubah jenis pengaturan dengan menggunakan properti Cakupan.

Sistem proyek menyimpan pengaturan aplikasi dalam dua file XML:

  • File app.config, yang dibuat pada waktu desain saat Anda membuat pengaturan aplikasi pertama

  • File user.config, yang dibuat pada runtime saat pengguna yang menjalankan aplikasi mengubah nilai pengaturan pengguna apa pun

Perubahan pengaturan pengguna tidak ditulis ke disk kecuali aplikasi secara khusus memanggil metode untuk melakukannya.

Membuat pengaturan untuk aplikasi pada saat desain

Pada waktu desain, Anda dapat membuat pengaturan aplikasi dengan dua cara:

  • Gunakan halaman Pengaturan dari Project Designer.

  • Gunakan jendela Properti untuk formulir atau kontrol, yang memungkinkan Anda mengikat pengaturan ke properti.

Saat Anda membuat pengaturan cakupan aplikasi (misalnya, string koneksi database, atau referensi ke sumber daya server), Visual Studio menyimpannya di file app.config dengan tag <applicationSettings>. String koneksi disimpan di bawah tag <connectionStrings>.

Saat Anda membuat pengaturan cakupan pengguna (misalnya, font default, halaman beranda, atau ukuran jendela), Visual Studio menyimpannya dalam file app.config dengan tag <userSettings>.

Penting

Saat Anda menyimpan string koneksi di app.config, Anda harus mengambil tindakan pencegahan untuk menghindari mengungkapkan informasi sensitif, seperti kata sandi atau jalur server, dalam string koneksi.

Jika Anda mengambil informasi string koneksi dari sumber eksternal, seperti pengguna yang menyediakan ID pengguna dan kata sandi mereka, pastikan bahwa nilai yang Anda gunakan untuk membangun string koneksi Anda tidak berisi parameter string koneksi tambahan yang mengubah perilaku koneksi Anda.

Pertimbangkan untuk menggunakan fitur Konfigurasi Terproteksi untuk mengenkripsi informasi sensitif dalam file konfigurasi. Untuk informasi selengkapnya, lihat Melindungi informasi koneksi.

Nota

Karena tidak ada model file konfigurasi untuk pustaka kelas, pengaturan aplikasi tidak berlaku untuk proyek Pustaka Kelas. Pengecualiannya adalah Visual Studio Tools for Office Runtime proyek DLL, yang dapat memiliki file konfigurasi.

Menggunakan file pengaturan yang dikustomisasi

Anda dapat menambahkan file pengaturan yang disesuaikan ke proyek Anda untuk manajemen grup pengaturan yang nyaman. Pengaturan yang terkandung dalam satu file dimuat dan disimpan sebagai unit. Menyimpan pengaturan dalam file terpisah untuk grup yang sering digunakan dan jarang digunakan dapat menghemat waktu dalam memuat dan menyimpan pengaturan.

Misalnya, Anda dapat menambahkan file SpecialSettings.settings ke proyek Anda. Meskipun kelas SpecialSettings Anda tidak diekspos di namespace My, Tampilkan Kode dapat membaca file pengaturan khusus yang berisi Partial Class SpecialSettings.

Perancang Pengaturan terlebih dahulu mencari file Settings.settings yang dibuat oleh sistem proyek. File Pengaturan ini adalah file default yang ditampilkan Project Designer di tab Pengaturan. File Pengaturan terletak di folder Proyek Saya untuk proyek Visual Basic dan di folder Properti untuk proyek Visual C#. Project Designer kemudian mencari file pengaturan lain di folder akar proyek. Oleh karena itu, Anda harus meletakkan file pengaturan kustom Anda di sana. Jika Anda menambahkan file .settings di tempat lain di proyek Anda, Project Designer tidak dapat menemukannya.

Mengakses atau mengubah pengaturan aplikasi saat runtime di Visual Basic

Di proyek Visual Basic, Anda dapat mengakses pengaturan aplikasi saat runtime dengan menggunakan objek My.Settings. Pada halaman Pengaturan, pilih tombol Tampilkan kode untuk melihat file Settings.vb. Settings.vb menentukan kelas Settings, yang memungkinkan Anda menangani peristiwa ini pada kelas pengaturan:

Kelas Settings di Settings.vb adalah kelas parsial yang hanya menampilkan kode milik pengguna, bukan seluruh kelas yang dihasilkan. Untuk informasi selengkapnya tentang mengakses pengaturan aplikasi dengan menggunakan objek My.Settings, lihat pengaturan aplikasi Akses (.NET Framework).

Nilai pengaturan yang khusus untuk pengguna yang diubah oleh pengguna saat waktu berjalan, misalnya, posisi formulir, disimpan dalam file user.config. Nilai default masih disimpan dalam app.config.

Jika ada pengaturan yang dicakup pengguna diubah selama runtime, misalnya dalam menguji aplikasi, dan Anda ingin mengatur ulang pengaturan ini ke nilai defaultnya, pilih tombol Sinkronkan.

Kami menyarankan agar Anda menggunakan objek My.Settings dan file pengaturan default untuk mengakses pengaturan. Anda dapat menggunakan Perancang Pengaturan untuk menetapkan properti ke pengaturan, dan, juga, pengaturan pengguna disimpan secara otomatis sebelum penonaktifan aplikasi. Namun, aplikasi Visual Basic Anda dapat mengakses pengaturan secara langsung. Dalam hal ini, Anda harus mengakses kelas MySettings dan menggunakan file settings kustom di root proyek. Anda harus menyimpan pengaturan pengguna sebelum mengakhiri aplikasi, seperti yang akan Anda lakukan untuk aplikasi C#, seperti yang dijelaskan di bagian berikut.

Mengakses atau mengubah pengaturan aplikasi saat runtime di C#

Dalam bahasa selain Visual Basic, seperti C#, Anda harus mengakses kelas Settings secara langsung, seperti yang ditunjukkan dalam contoh Visual C# berikut.

Properties.Settings.Default.FirstUserSetting = "abc";

Anda harus secara eksplisit memanggil metode Save kelas pembungkus ini untuk mempertahankan pengaturan pengguna. Anda biasanya melakukannya di penanganan aktivitas Closing formulir utama. Contoh C# berikut menunjukkan panggilan ke metode Save.

Properties.Settings.Default.Save();

Untuk informasi umum tentang mengakses pengaturan aplikasi melalui kelas Settings, lihat gambaran umum pengaturan aplikasi (.NET Framework).

Memigrasikan aplikasi dari .NET Framework ke .NET

.NET Framework menggunakan file app.config untuk memuat pengaturan untuk aplikasi Anda, seperti string koneksi dan konfigurasi penyedia log. .NET modern menggunakan file appsettings.json untuk pengaturan aplikasi. Untuk mempelajari selengkapnya tentang mengonversi file app.config ke appsettings.json, lihat Modernisasi setelah memutakhirkan ke .NET dari .NET Framework.