.NET: Pengecualian Yang Harus Dilempar Saat Pengaturan Konfigurasi yang Diperlukan Hilang?

Berikut skenario standar:

if(string.IsNullOrEmpty(Configuration.AppSettings["foobar"]))
   throw new SomeStandardException("Application not configured correctly, bozo.");

Masalahnya adalah, saya tidak sepenuhnya yakin pengecualian mana yangSomeStandardException seharusnya.

Saya meneliti Kerangka 3.5 dan menemukan dua kandidat yang mungkin: ConfigurationExceptiondan ConfigurationErrorsException.

System.Configuration.ConfigurationException

Pengecualian yang muncul ketika kesalahan sistem konfigurasi telah terjadi.

Catatan

The ConfigurationExceptioneksepsi dilemparkan jika upaya aplikasi untuk membaca atau menulis data ke file konfigurasi tapi tidak berhasil. Beberapa kemungkinan alasan untuk hal ini dapat mencakup format XML yang salah di file konfigurasi, masalah izin file, dan properti konfigurasi dengan nilai yang tidak valid.

catatan:

The ConfigurationExceptionobjek dipertahankan untuk kompatibilitas. The ConfigurationErrorsException objek menggantikannya untuk sistem konfigurasi.

Pengecualian ini sebenarnya terdengar sempurna untuk apa yang saya butuhkan, tapi sudah ditandai usang, jadi, ixnay on atthay.

Ini membawa kita ke hal yang sangat membingungkan ConfigurationErrorsException:

System.Configuration.ConfigurationErrorsException

Nilai saat ini bukan salah satu nilai EnableSessionState.

Seperti yang Anda lihat, dokumentasinya sama sekali tidak berguna. (Begitulah dalam bantuan lokal dan online.) Pemeriksaan kelas itu sendiri menunjukkan bahwa itu berlebihan secara drastis untuk apa yang saya inginkan.

Singkatnya, saya memerlukan pengecualian standar yang harus dibuang ketika pengaturan konfigurasi aplikasi hilang atau berisi nilai yang tidak valid. Anda akan berpikir Kerangka memiliki pengecualian seperti itu yang dimasukkan ke dalamnya untuk digunakan aplikasi. (Tampaknya memang demikian, tetapi ditandai usang, dan digantikan oleh sesuatu yang jauh lebih besar cakupannya.)

Solusi apa, jika ada, yang kalian gunakan untuk ini, dan apakah saya harus menyedotnya dan menggulung pengecualian saya sendiri untuk ini?

Edit Adenda

Beberapa orang bertanya apakah saya dapat memberikan nilai default atau tidak, dan melanjutkan. Dalam kasus tertentu, ya, dan dalam kasus tersebut, pengecualian tidak akan dilemparkan. Namun, untuk pengaturan tertentu, ini tidak berlaku. Misalnya: nama dan kredensial server database, server otentikasi, dan jalur ke aplikasi pihak ketiga yang diinstal.

Perlu juga dicatat bahwa aplikasi yang terutama saya kerjakan adalah aplikasi konsol yang berjalan dalam mode batch, dan saya ingin aplikasi tersebut menampilkan pengecualian yang ditangkap oleh metode utama dan dicatat dengan tepat jika hal tersebut tidak dikonfigurasi dengan benar. (Ini kode warisan yang saya warisi, dan saat ini hanya menganggap semuanya bagus.)

Anda tidak dibatasi dalam memberikan pengecualian pada pengecualian yang ada dalam Kerangka. Jika Anda memutuskan untuk menggunakan pengecualian yang ada, Anda tidak harus benar-benar mengikuti dokumentasi ke surat itu. Dokumentasi akan menjelaskan bagaimana framework menggunakan pengecualian tertentu, tetapi tidak menyiratkan batasan apa pun tentang cara Anda memilih untuk menggunakan / menggunakan kembali pengecualian yang ada.

Ini adalah aplikasi Anda - selama Anda mendokumentasikannya dan dengan jelas menunjukkan pengecualian yang akan dilemparkan dalam kasus tertentu dari nilai konfigurasi yang hilang, Anda dapat menggunakan pengecualian apa pun yang Anda suka. Jika Anda memang menginginkan indikasi yang sangat spesifik dari nilai yang hilang , Anda dapat mempertimbangkan untuk menulis pengecualian ConfigurationSettingMissing Anda sendiri:

[Serializable]
public class ConfigurationMissingException : ConfigurationErrorsException
{}

EDIT: Menulis pengecualian Anda sendiri dalam hal ini membawa manfaat tambahan untuk menjamin bahwa tidak akan pernah ada kebingungan mengenai dari mana pengecualian itu berasal- kerangka kerja, atau aplikasi Anda. Kerangka tidak akan pernah memberikan pengecualian khusus Anda.

UPDATE: Saya setuju dengan komentar, jadi saya telah mengubah subclass menjadi ConfigurationErrorsException dari Exception. Saya pikir itu umumnya ide yang baik untuk pengecualian kustom subclass dari pengecualian Framework yang ada jika memungkinkan, menghindari kelas Exception kecuali Anda memerlukan pengecualian khusus aplikasi.

Secara pribadi, saya akan menggunakan InvalidOperationException , karena ini masalah dengan status objek - bukan sistem konfigurasinya. Lagi pula, bukankah seharusnya Anda mengizinkan setelan ini disetel oleh kode dan bukan konfigurasi juga? Bagian penting di sini bukanlah bahwa tidak ada baris di app.config, tetapi informasi yang diperlukan tidak ada.

Bagi saya, ConfigurationException (dan penggantinya, ConfigurationErrorsException - terlepas dari dokumen MSDN yang menyesatkan) adalah untuk kesalahan dalam menyimpan, membaca, dll. Dari Konfigurasi.

Seperti yang dikatakan Daniel Richardson, ConfigurationErrorsException adalah yang akan digunakan. Secara umum, hanya disarankan untuk membuat jenis Pengecualian kustom Anda sendiri jika Anda memiliki skenario untuk menanganinya. Dalam kasus kesalahan konfigurasi, yang biasanya berakibat fatal, hal ini jarang terjadi sehingga biasanya lebih tepat untuk menggunakan kembali jenis ConfigurationErrorsException yang ada.

Sebelum .NET 2.0, rekomendasinya adalah menggunakan System.Configuration.ConfigurationException . ConfigurationException menjadi usang di .NET 2.0, karena alasan yang tidak pernah jelas bagi saya, dan rekomendasi diubah untuk menggunakan ConfigurationErrorsException.

Saya menggunakan metode helper untuk membuang pengecualian sehingga mudah untuk mengubah pengecualian yang dilemparkan di satu tempat saat bermigrasi dari .NET 1.x ke 2.0, atau jika Microsoft memutuskan untuk mengubah rekomendasinya lagi:

if(string.IsNullOrEmpty(Configuration.AppSettings("foobar")))
{
   throw CreateMissingSettingException("foobar");
}

...

private static Exception CreateMissingSettingException(string name)
{
    return new ConfigurationErrorsException(
        String.Format
        (
        CultureInfo.CurrentCulture,
        Properties.Resources.MissingConfigSetting,
        name
        )
        );
}

Tentang apa System.Configuration.SettingsPropertyNotFoundException?

ConfigurationErrorsExceptionadalah pengecualian yang tepat untuk diterapkan dalam situasi yang Anda gambarkan. Versi sebelumnya dari dokumentasi MSDN untuk ConfigurationErrorsExceptionlebih masuk akal.

http://msdn.microsoft.com/en-us/library/system.configuration.configurationerrorsexception(VS.80).aspx

Rangkuman dan komentar MSDN sebelumnya adalah:

• Pengecualian yang muncul ketika kesalahan sistem konfigurasi telah terjadi.
• The ConfigurationErrorsException eksepsi dilemparkan ketika kesalahan terjadi ketika informasi konfigurasi yang sedang dibaca atau ditulis.

Kelas ConfigurationElement (yang merupakan kelas dasar dari banyak kelas terkait konfigurasi, seperti ConfigurationSection) memiliki metode yang disebut OnRequiredPropertyNotFound (ada juga metode pembantu lain). Anda mungkin bisa memanggilnya.

OnRequiredPropertyNotFound diimplementasikan seperti ini:

protected virtual object OnRequiredPropertyNotFound(string name) {
    throw new ConfigurationErrorsException(SR.GetString("Config_base_required_attribute_missing", new object[] { name }), this.PropertyFileName(name), this.PropertyLineNumber(name)); }

Saya akan menyedotnya dan menggulungnya sendiri ... tetapi sebelum Anda melakukannya, Mungkinkah sistem mengasumsikan nilai default untuk pengaturan konfigurasi ini? Saya biasanya mencoba melakukan itu untuk setiap pengaturan yang mungkin terlewatkan oleh orang-orang Manajemen Operasi ... (atau mungkin saya harus mengatakan, untuk sebanyak mungkin pengaturan - untuk beberapa pengaturan jelas tidak tepat untuk membuat sistem membuat keputusan default. ..)

secara umum pengecualian khusus tidak membutuhkan banyak usaha ... berikut ini contohnya ...

[Serializable]
public class MyCustomApplicationException : ApplicationException
{
    #region privates
    #endregion privates

    #region properties
    #endregion properties

    public MyCustomApplicationException (string sMessage,
        Exception innerException)
        : base(sMessage, innerException) { }
    public MyCustomApplicationException (string sMessage)
        : base(sMessage) { }
    public MyCustomApplicationException () { }

    #region Serializeable Code
    public MyCustomApplicationException (
       SerializationInfo info, StreamingContext context)
        : base(info, context) { }
    #endregion Serializeable Code
}

Metode alternatif yang dapat Anda gunakan untuk file konfigurasi Anda adalah dengan menggunakan bagian konfigurasi khusus sebagai lawan AppSettings. Dengan cara itu Anda dapat menentukan bahwa properti IsRequireddan sistem konfigurasi akan menangani pemeriksaan ini untuk Anda. Jika properti hilang itu akan melempar ConfigurationErrorsExceptionjadi saya kira itu mendukung jawaban bahwa Anda harus menggunakan pengecualian itu dalam kasus Anda.

Aturan umum saya adalah:

1. Jika kasus konfigurasi yang hilang tidak terlalu umum dan saya yakin saya tidak ingin menangani kasus ini secara berbeda dari pengecualian lainnya, saya hanya menggunakan kelas "Pengecualian" dasar dengan pesan yang sesuai:

   lempar Pengecualian baru ("pesan saya di sini")

2. Jika saya ingin, atau berpikir ada kemungkinan besar saya ingin menangani kasus ini dengan cara yang berbeda dari kebanyakan pengecualian lainnya, saya akan menggulung tipe saya sendiri seperti yang telah disarankan orang di sini.

Saya cenderung tidak setuju dengan premis pertanyaan Anda:

Singkatnya, saya memerlukan pengecualian standar yang harus dibuang ketika pengaturan konfigurasi aplikasi hilang atau berisi nilai yang tidak valid. Anda akan berpikir Kerangka memiliki pengecualian seperti itu yang dimasukkan ke dalamnya untuk digunakan aplikasi. (Tampaknya memang demikian, tetapi ditandai usang, dan digantikan oleh sesuatu yang jauh lebih besar cakupannya.)

Menurut dokumentasi MSDN di System.Exception ( Exception Class , Anda seharusnya tidak memberikan pengecualian untuk kesalahan input pengguna, karena alasan kinerja (yang telah ditunjukkan oleh orang lain di Stack Overflow dan di tempat lain). Ini tampaknya masuk akal karena baik - mengapa fungsi Anda tidak bisa mengembalikan false jika input pengguna salah dimasukkan, dan kemudian membuat aplikasi keluar dengan anggun? Ini tampaknya lebih merupakan masalah desain daripada masalah yang harus dilemparkan Exception.

Seperti yang ditunjukkan orang lain, jika Anda benar - benar harus membuat pengecualian - karena alasan apa pun - tidak ada alasan mengapa Anda tidak dapat menentukan jenis Pengecualian Anda dengan mewarisi dari System.Exception.

Anda dapat mencoba mewarisi XML Exception, atau hanya menggunakannya.