Atribut Paling Berguna [ditutup]

Saya tahu bahwa atribut sangat berguna. Ada beberapa yang sudah ditentukan sebelumnya [Browsable(false)]yang memungkinkan Anda untuk menyembunyikan properti di tab properti. Berikut adalah pertanyaan yang menjelaskan atribut: Apa itu atribut di .NET?

Apa atribut yang telah ditentukan (dan namespace mereka) yang Anda gunakan dalam proyek Anda?

[DebuggerDisplay]dapat sangat membantu untuk dengan cepat melihat output kustom dari Tipe ketika Anda mengarahkan mouse pada instance Type selama debugging. contoh:

[DebuggerDisplay("FirstName={FirstName}, LastName={LastName}")]
class Customer
{
    public string FirstName;
    public string LastName;
}

Beginilah seharusnya terlihat di debugger:

Juga, perlu disebutkan bahwa [WebMethod]atribut dengan CacheDurationset properti dapat menghindari eksekusi yang tidak perlu dari metode layanan web.

System.Obsoleteadalah salah satu atribut paling berguna dalam kerangka kerja, menurut saya. Kemampuan untuk meningkatkan peringatan tentang kode yang seharusnya tidak lagi digunakan sangat berguna. Saya suka memiliki cara untuk memberi tahu pengembang bahwa sesuatu tidak boleh lagi digunakan, serta memiliki cara untuk menjelaskan mengapa dan menunjukkan cara yang lebih baik / baru dalam melakukan sesuatu.

Ini Conditional attributejuga cukup berguna untuk penggunaan debug. Ini memungkinkan Anda untuk menambahkan metode dalam kode Anda untuk tujuan debug yang tidak akan dikompilasi ketika Anda membangun solusi Anda untuk rilis.

Lalu ada banyak atribut khusus untuk Kontrol Web yang menurut saya berguna, tetapi lebih spesifik dan tidak memiliki kegunaan di luar pengembangan kontrol server dari apa yang saya temukan.

[Flags]cukup berguna. Gula sintaksis sudah pasti, tetapi masih agak bagus.

[Flags] 
enum SandwichStuff
{
   Cheese = 1,
   Pickles = 2,
   Chips = 4,
   Ham = 8,
   Eggs = 16,
   PeanutButter = 32,
   Jam = 64
};

public Sandwich MakeSandwich(SandwichStuff stuff)
{
   Console.WriteLine(stuff.ToString());
   // ...
}

// ...

MakeSandwich(SandwichStuff.Cheese 
   | SandwichStuff.Ham 
   | SandwichStuff.PeanutButter);
// produces console output: "Cheese, Ham, PeanutButter"

Leppie menunjukkan sesuatu yang tidak saya sadari, dan yang agak mengurangi antusiasme saya untuk atribut ini: ia tidak memerintahkan kompiler untuk mengizinkan kombinasi bit sebagai nilai valid untuk variabel enumerasi, kompiler memungkinkan ini untuk enumerasi terlepas. Latar belakang C ++ saya menunjukkan melalui ... menghela napas

Saya suka [DebuggerStepThrough]dari System.Diagnostics .

Ini sangat berguna untuk menghindari melangkah ke metode atau properti do-nothing satu baris (jika Anda dipaksa untuk bekerja di .Net awal tanpa properti otomatis). Letakkan atribut pada metode pendek atau pengambil atau penyetel properti, dan Anda akan terbang tepat saat menekan "step into" di debugger.

Untuk apa nilainya, berikut adalah daftar semua atribut .NET . Ada beberapa ratus.

Saya tidak tahu tentang orang lain tetapi saya memiliki beberapa RTFM yang serius untuk dilakukan!

Pilihan saya adalah untuk Conditional

[Conditional("DEBUG")]
public void DebugOnlyFunction()
{
    // your code here
}

Anda dapat menggunakan ini untuk menambahkan fungsi dengan fitur debugging canggih; seperti Debug.Write, ini hanya disebut dalam debug build, dan dengan demikian memungkinkan Anda untuk merangkum logika debug kompleks di luar aliran utama program Anda.

Saya selalu menggunakan DisplayName, Descriptiondan DefaultValueatribut atas properti publik dari kontrol pengguna saya, kontrol khusus atau kelas apa pun yang saya akan edit melalui kisi properti. Tag ini digunakan oleh .NET PropertyGrid untuk memformat nama, panel deskripsi, dan nilai tebal yang tidak disetel ke nilai default.

[DisplayName("Error color")]
[Description("The color used on nodes containing errors.")]
[DefaultValue(Color.Red)]
public Color ErrorColor
{
    ...
} 

Saya hanya berharap Visual Studio's IntelliSense akan mempertimbangkan Descriptionatribut jika tidak ada komentar XML ditemukan. Itu akan menghindari harus mengulangi kalimat yang sama dua kali.

[Serializable]digunakan sepanjang waktu untuk serialisasi dan deserializing objek ke dan dari sumber data eksternal seperti xml atau dari server jauh. Lebih lanjut di sini.

Dalam semangat Hofstadtian, [Attribute]atributnya sangat berguna, karena itulah cara Anda membuat atribut Anda sendiri. Saya telah menggunakan atribut alih-alih antarmuka untuk mengimplementasikan sistem plugin, menambahkan deskripsi ke Enums, mensimulasikan banyak pengiriman dan trik lainnya.

Berikut adalah postingan tentang atribut menarik InternalsVisibleTo . Pada dasarnya apa yang dilakukannya meniru fungsi akses teman-teman C ++. Ini sangat berguna untuk pengujian unit.

Saya menemukan [DefaultValue]cukup berguna.

Saya akan menyarankan [TestFixture]dan [Test]- dari perpustakaan nUnit .

Tes unit dalam kode Anda memberikan keamanan dalam refactoring dan dokumentasi terkodifikasi.

[XmlIgnore]

karena ini memungkinkan Anda untuk mengabaikan (dalam serialisasi xml apa saja) objek 'induk' yang jika tidak akan menyebabkan pengecualian saat menyimpan.

Itu tidak bernama, tidak didukung dalam kerangka kerja, dan seharusnya tidak memerlukan parameter, tetapi atribut ini adalah penanda yang berguna untuk kelas yang tidak dapat diubah:

[ImmutableObject(true)]

Saya suka menggunakan [ThreadStatic]atribut dalam kombinasi dengan pemrograman berbasis thread dan stack. Misalnya, jika saya ingin nilai yang ingin saya bagikan dengan sisa urutan panggilan, tetapi saya ingin melakukannya di luar jalur (yaitu di luar parameter panggilan), saya mungkin menggunakan sesuatu seperti ini.

class MyContextInformation : IDisposable {
    [ThreadStatic] private static MyContextInformation current;

    public static MyContextInformation Current {
        get { return current; }
    }

    private MyContextInformation previous;


    public MyContextInformation(Object myData) {
       this.myData = myData;
       previous = current;
       current = this;
    }

    public void Dispose() {
       current = previous;
    }
}

Kemudian dalam kode saya, saya dapat menggunakan ini untuk memberikan informasi kontekstual dari band kepada orang-orang di hilir dari kode saya. Contoh:

using(new MyContextInformation(someInfoInContext)) {
   ...
}

Atribut ThreadStatic memungkinkan saya untuk membatasi panggilan hanya ke utas yang dimaksud menghindari masalah berantakan dari akses data di utas.

The DebuggerHiddenAttribute yang memungkinkan untuk menghindari langkah ke dalam kode yang tidak harus debugged.

public static class CustomDebug
{
    [DebuggerHidden]
    public static void Assert(Boolean condition, Func<Exception> exceptionCreator) { ... }
}

...

// The following assert fails, and because of the attribute the exception is shown at this line
// Isn't affecting the stack trace
CustomDebug.Assert(false, () => new Exception()); 

Itu juga mencegah menampilkan metode dalam jejak stack, berguna ketika memiliki metode yang hanya membungkus metode lain:

[DebuggerHidden]
public Element GetElementAt(Vector2 position)
{
    return GetElementAt(position.X, position.Y);
}

public Element GetElementAt(Single x, Single y) { ... }

Jika sekarang Anda memanggil GetElementAt(new Vector2(10, 10))dan terjadi kesalahan pada metode terbungkus, tumpukan panggilan tidak menunjukkan metode yang memanggil metode yang melempar kesalahan.

DesignerSerializationVisibilityAttributesangat bermanfaat. Saat Anda meletakkan properti runtime pada kontrol atau komponen, dan Anda tidak ingin perancang untuk membuat serial, Anda menggunakannya seperti ini:

[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public Foo Bar {
    get { return baz; }
    set { baz = value; }
}

Hanya beberapa atribut yang mendapatkan dukungan kompiler, tetapi satu penggunaan atribut yang sangat menarik adalah di AOP: PostSharp menggunakan atribut yang dipesan lebih dahulu untuk menyuntikkan IL ke dalam metode, memungkinkan segala macam kemampuan ... mencatat / melacak menjadi contoh sepele - tetapi beberapa contoh bagus lainnya adalah hal-hal seperti implementasi INotifyPropertyChanged otomatis (di sini ).

Beberapa yang terjadi dan berdampak langsung ke kompiler atau runtime :

• [Conditional("FOO")] - panggilan ke metode ini (termasuk evaluasi argumen) hanya terjadi jika simbol "FOO" didefinisikan selama pembuatan
• [MethodImpl(...)] - Digunakan untuk menunjukkan beberapa hal seperti sinkronisasi, inlining
• [PrincipalPermission(...)] - Digunakan untuk menyuntikkan pemeriksaan keamanan ke dalam kode secara otomatis
• [TypeForwardedTo(...)]- Digunakan untuk memindahkan tipe antar majelis tanpa membangun kembali penelepon

Untuk hal-hal yang diperiksa secara manual melalui refleksi - Saya penggemar System.ComponentModelatribut; hal-hal seperti [TypeDescriptionProvider(...)],, [TypeConverter(...)]dan [Editor(...)]yang sepenuhnya dapat mengubah perilaku tipe dalam skenario pengikatan data (yaitu properti dinamis, dll).

Jika saya akan melakukan merangkak cakupan kode, saya pikir keduanya akan menjadi teratas:

 [Serializable]
 [WebMethod]

Saya telah menggunakan [DataObjectMethod]akhir - akhir ini. Ini menjelaskan metode sehingga Anda dapat menggunakan kelas Anda dengan ObjectDataSource (atau kontrol lainnya).

[DataObjectMethod(DataObjectMethodType.Select)] 
[DataObjectMethod(DataObjectMethodType.Delete)] 
[DataObjectMethod(DataObjectMethodType.Update)] 
[DataObjectMethod(DataObjectMethodType.Insert)] 

Info lebih lanjut

Dalam proyek kami saat ini, kami menggunakan

[ComVisible(false)]

Ini mengontrol aksesibilitas tipe atau anggota yang dikelola perorangan, atau semua tipe dalam suatu majelis, ke COM.

Info lebih lanjut

[TypeConverter(typeof(ExpandableObjectConverter))]

Memberitahu desainer untuk memperluas properti yang merupakan kelas (dari kendali Anda)

[Obfuscation]

Menginstruksikan alat kebingungan untuk mengambil tindakan yang ditentukan untuk pertemuan, jenis, atau anggota. (Meskipun biasanya Anda menggunakan level Majelis[assembly:ObfuscateAssemblyAttribute(true)]

Atribut yang paling saya gunakan adalah yang terkait dengan Serialisasi XML.

XmlRoot

XmlElement

XmlAttribute

dll ...

Sangat berguna saat melakukan parsing atau serialisasi XML yang cepat dan kotor.

Menjadi pengembang tingkat menengah yang saya sukai

System.ComponentModel.EditorBrowsableAttribute Mengizinkan saya menyembunyikan properti sehingga pengembang UI tidak kewalahan dengan properti yang tidak perlu mereka lihat.

System.ComponentModel.BindableAttributeBeberapa hal tidak perlu menjadi basis data. Sekali lagi, kurangi pekerjaan yang harus dilakukan pengembang UI.

Saya juga suka DefaultValueyang disebutkan oleh Lawrence Johnston.

System.ComponentModel.BrowsableAttribute dan Flags digunakan secara teratur.

saya menggunakan System.STAThreadAttribute System.ThreadStaticAttribute saat dibutuhkan.

Ngomong-ngomong. Saya ini sama berharganya untuk semua pengembang .Net framework.

[EditorBrowsable(EditorBrowsableState.Never)]memungkinkan Anda untuk menyembunyikan properti dan metode dari IntelliSense jika proyek tidak ada dalam solusi Anda. Sangat membantu untuk menyembunyikan aliran yang tidak valid untuk antarmuka yang lancar. Seberapa sering Anda ingin GetHashCode () atau Equals ()?

Untuk MVC [ActionName("Name")]memungkinkan Anda untuk memiliki tindakan Dapatkan dan Posting tindakan dengan metode tanda tangan yang sama, atau menggunakan tanda hubung dalam nama tindakan, yang jika tidak tidak mungkin tanpa membuat rute untuk itu.

Saya menganggap penting untuk disebutkan di sini bahwa atribut berikut ini juga sangat penting:

STAThreadAttribute 

Mengindikasikan bahwa model threading COM untuk suatu aplikasi adalah apartemen single-threaded apartment (STA).

Misalnya atribut ini digunakan dalam Aplikasi Formulir Windows:

static class Program
{
    /// <summary>
    /// The main entry point for the application.
    /// </summary>
    [STAThread]
    static void Main()
    {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        Application.Run(new Form1());
    }
}

Dan juga ...

SuppressMessageAttribute

Menekan pelaporan pelanggaran aturan alat analisis statis tertentu, yang memungkinkan beberapa penindasan pada artefak kode tunggal.

Sebagai contoh:

[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "isChecked")]
[SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId = "fileIdentifier")]
static void FileNode(string name, bool isChecked)
{
    string fileIdentifier = name;
    string fileName = name;
    string version = String.Empty;
}

Dari atas kepala saya, di sini adalah daftar cepat, kira-kira diurutkan berdasarkan frekuensi penggunaan, atribut yang telah ditentukan yang sebenarnya saya gunakan dalam proyek besar (~ 500k LoCs):

Bendera, Serializable, WebMethod, COMVisible, TypeConverter, Conditional, ThreadStatic, Usang, InternalVisibleTo, DebuggerStepThrough.

Saya menghasilkan kelas entitas data melalui CodeSmith dan saya menggunakan atribut untuk beberapa rutin validasi. Berikut ini sebuah contoh:

/// <summary>
/// Firm ID
/// </summary>
[ChineseDescription("送样单位编号")]
[ValidRequired()]
public string FirmGUID
{
    get { return _firmGUID; }
    set { _firmGUID = value; }
}

Dan saya mendapat kelas utilitas untuk melakukan validasi berdasarkan atribut yang melekat pada kelas entitas data. Ini kodenya:

namespace Reform.Water.Business.Common
{
/// <summary>
/// Validation Utility
/// </summary>
public static class ValidationUtility
{
    /// <summary>
    /// Data entity validation
    /// </summary>
    /// <param name="data">Data entity object</param>
    /// <returns>return true if the object is valid, otherwise return false</returns>
    public static bool Validate(object data)
    {
        bool result = true;
        PropertyInfo[] properties = data.GetType().GetProperties();
        foreach (PropertyInfo p in properties)
        {
            //Length validatioin
            Attribute attribute = Attribute.GetCustomAttribute(p,typeof(ValidLengthAttribute), false);
            if (attribute != null)
            {
                ValidLengthAttribute validLengthAttribute = attribute as ValidLengthAttribute;
                if (validLengthAttribute != null)
                {
                    int maxLength = validLengthAttribute.MaxLength;
                    int minLength = validLengthAttribute.MinLength;
                    string stringValue = p.GetValue(data, null).ToString();
                    if (stringValue.Length < minLength || stringValue.Length > maxLength)
                    {
                        return false;
                    }
                }
            }
            //Range validation
            attribute = Attribute.GetCustomAttribute(p,typeof(ValidRangeAttribute), false);
            if (attribute != null)
            {
                ValidRangeAttribute validRangeAttribute = attribute as ValidRangeAttribute;
                if (validRangeAttribute != null)
                {
                    decimal maxValue = decimal.MaxValue;
                    decimal minValue = decimal.MinValue;
                    decimal.TryParse(validRangeAttribute.MaxValueString, out maxValue);
                    decimal.TryParse(validRangeAttribute.MinValueString, out minValue);
                    decimal decimalValue = 0;
                    decimal.TryParse(p.GetValue(data, null).ToString(), out decimalValue);
                    if (decimalValue < minValue || decimalValue > maxValue)
                    {
                        return false;
                    }
                }
            }
            //Regex validation
            attribute = Attribute.GetCustomAttribute(p,typeof(ValidRegExAttribute), false);
            if (attribute != null)
            {
                ValidRegExAttribute validRegExAttribute = attribute as ValidRegExAttribute;
                if (validRegExAttribute != null)
                {
                    string objectStringValue = p.GetValue(data, null).ToString();
                    string regExString = validRegExAttribute.RegExString;
                    Regex regEx = new Regex(regExString);
                    if (regEx.Match(objectStringValue) == null)
                    {
                        return false;
                    }
                }
            }
            //Required field validation
            attribute = Attribute.GetCustomAttribute(p,typeof(ValidRequiredAttribute), false);
            if (attribute != null)
            {
                ValidRequiredAttribute validRequiredAttribute = attribute as ValidRequiredAttribute;
                if (validRequiredAttribute != null)
                {
                    object requiredPropertyValue = p.GetValue(data, null);
                    if (requiredPropertyValue == null || string.IsNullOrEmpty(requiredPropertyValue.ToString()))
                    {
                        return false;
                    }
                }
            }
        }
        return result;
    }
}
}

[DeploymentItem("myFile1.txt")] MSDN Doc on DeploymentItem

Ini sangat berguna jika Anda menguji file atau menggunakan file sebagai input untuk pengujian Anda.

[System.Security.Permissions.PermissionSetAttribute] memungkinkan tindakan keamanan untuk PermissionSet diterapkan ke kode menggunakan keamanan deklaratif.

// usage:
public class FullConditionUITypeEditor : UITypeEditor
{
    // The immediate caller is required to have been granted the FullTrust permission.
    [PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
    public FullConditionUITypeEditor() { }
}