ادامه درس شانزدهم

ادامه درس شانزدهم

 تعریف و یا کنترل موارد استفاده از یک صفت

 AttributeUsage یکی از کلاسهای از پیش تعریف شده در زبان است که با استفاده از آن می‌توانیم موارد استفاده از صفتی را که تولید کرده‌ایم را کنترل کنیم.

 این کلاس دارای سه property مختلف است که می‌توان آنها را به هنگام استفاده صفت شخصی تنظیم نمود و مورد استفاده قرار داد.

 ValidOn

با استفاده از این property می‌توانیم مشخص کنیم که صفت تولید شده توسط ما، بر روی کدام یک از عناصر برنامه قابل اعمال هستند. اطلاعات این عناصر از AttributeTarget گرفته می‌شود و می‌توان عناصر مختلف را بوسیله OR بیتی با یکدیگر ترکیب نمود.

 AllowMultiple

با استفاده از این property می‌توان مشخص کرد که آیا می‌توان از این صفت بیش از یکبار بر روی یک عنصر برنامه استفاده کرد یا نه.

 Inherited

با استفاده از این property می‌توان قوانین ارث‌بری این صفت را کنترل نمود. با استفاده از این property می‌توان مشخص کرد که آیا کلاسی که از کلاسی که صفت بر روی آن اعمال شده، ارث بری می‌کند نیز، صفت بر رویش اعمال می‌شود یا نه و یا به عبارتی صفت در کلاس مشتق شده نیز مورد ارث‌بری قرار می‌گیرد یا نه.

 حال با استفاده از موارد گفته شده در بالا، می‌خواهیم این مطالب را بر روی صفتی که خودمان تولید کردیم اعمال نماییم. مثال 7-16 را بررسی نمایید.

 مثال 7-16

using System;

[AttributeUsage(AttributeTargets.Class), AllowMultiple = false, Inherited = false ]

public class HelpAttribute : Attribute

{

    public HelpAttribute(String Description_in)

    {

        this.description = Description_in;

    }

    protected String description;

    public String Description

    {

        get 

        {

            return this.description;

        }            

    }    

}

در ابتدا به AttributeTargets.Class توجه نمایید. این مشخص می‌کند که صفت Help تنها بر روی کلاسها قابل اعمال است و در صورتیکه از آن بر روی عنصری به غیر از کلاس استفاده نماییم خطایی رخ خواهد داد. بنابراین کد زیر، خطایی تولید خواهد کرد :

[Help("this is a do-nothing class")]

public class AnyClass

{

    [Help("this is a do-nothing method")]    //error

    public void AnyMethod()

    {

    }

} 

و کد خطای تولید شده بشکل زیر خواهد بود :

AnyClass.cs: Attribute 'Help' is not valid on this declaration type. 

It is valid on 'class' declarations only.

توجه کنید که با استفاده از AttributeTargets.All به صفت Help این امکان را می‌دهیم تا بر روی تمامی عناصر موجود اعمال شود. لیست کامل عناصر مجاز نیز بشرح زیر است :

• Assembly, 
• Module, 
• Class, 
• Struct, 
• Enum, 
• Constructor, 
• Method, 
• Property, 
• Field,
• Event, 
• Interface, 
• Parameter, 
• Delegate, 
• All = Assembly , Module , Class , Struct , Enum ,  Constructor , Method , Property , Field , Event , Interface , Parameter , Delegate,
• ClassMembers = Class , Struct , Enum , Constructor , Method , Property , Field , Event , Delegate , Interface

 حال به AllowMultiple = false توجه نمایید. با استفاده از این کد، به صفت Help اجازه می‌دهیم تا تنها یکبار بر روی عنصری از برنامه اعمال شود. پس کد زیر تولید خطا می‌نماید :

[Help("this is a do-nothing class")]

[Help("it contains a do-nothing method")]

public class AnyClass

{

    [Help("this is a do-nothing method")]        //error

    public void AnyMethod()

    {

    }

}

و کد خطای تولید شده نیز بصورت زیر است :

AnyClass.cs: Duplicate 'Help' attribute

در نهایت نیز به بررسی Inherited می‌پردازیم. با استفاده از این ویژگی، معین می‌کنیم درصورتیکه کلاس دیگری بخواهد از روی کلاسی که صفت بر روی آن اعمال شده ارث‌بری نماید، آیا این صفت بر روی آن کلاس نیز اعمال شود یا نه. در صورتیکه مقدار این ویژگی برابر با True باشد، کلاس مشتق شده نیز از صفت ارث‌بری می‌نماید. برای یک مثال می‌توانیم حالت زیر را در نظر بگیریم :

[Help("BaseClass")] 

public class Base

{

}

public class Derive :  Base

{

}

تمامی حالتهای مختلف ترکیب این سه ویژگی بصورت زیر است :

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false ]

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false ]

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true ]

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true ]

 استفاده از پارامترهای Positional و Named در صفتهای شخصی

 همانطور که در قبل نیز اشاره شد، پارامترهای Positional پارامترهای سازنده صفت هستند و در هر بار استفاده از صفت باید لحاظ شوند. حال برای بررسی می‌خواهیم پارامترهایی به صفت Help خود اضافه نماییم.

 مثال 8-16

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]

public class HelpAttribute : Attribute

{

    public HelpAttribute(String Description_in)

    {

        this.description = Description_in;

        this.verion = "No Version is defined for this class";

    }

    protected String description;

    public String Description

    {

        get 

        {

            return this.description;

        }

    }

    protected String version;

    public String Version

    {

        get 

        {

            return this.version;

        }

        //if we ever want our attribute user to set this property, 

        //we must specify set method for it 

        set 

        {

            this.verion = value;

        }

    }

}

[Help("This is Class1")]

public class Class1

{

}

[Help("This is Class2", Version = "1.0")]

public class Class2

{

}

[Help("This is Class3", Version = "2.0", Description = "This is do-nothing class")]

public class Class3

{

}

پس از اینکه این صفت را بر روی کلاس Class1 اعمال کردیم و بخواهیم آنرا کامپایل کنیم با پیغام زیر روبرو می‌شویم :

Help.Description : This is Class1

Help.Version :No Version is defined for this class

چون در اینجا هیچ مقداری برای Version در نظر نگرفته‌ایم، با این پیام مواجه شده‌ایم.

 حال نتیجه اعمال این صفت را بر روی کلاس دوم بررسی می‌کنیم.

Help.Description : This is Class2

Help.Version :  1.0

برای پارامترهای اختیاری معمولا از دو سازنده استفاده نمی‌شود و در عوض از پارامترهای Named استفاده می‌گردد. نکته‌ای که باید به آن توجه کنید آنست که برای پارامترهای Named حتما باید در تعریف property، از متد set نیز استفاده نمایید در غیر اینصورت با پیغام خطای زیر روبرو می‌شوید :

'Version' : Named attribute argument can't be a read only property

بنابراین درصورتیکه این صفت را بر روی کلاس سوم نیز اعمال کنیم با پیغام خطای مشابهی روبرو خواهیم شد. اگر در کلاس Help تغییری کوچکی اییجاد کنیم و به Description نیز متد set را بیفزاییم، با خطا مواجه نخواهیم شد.

Help.Description : This is do-nothing class 

Help.Version : 2.0

اتفاقی که در اینجا  رخ می‌دهد آنست که در ابتدا سازنده (Constructor) این صفت به همراه پارامترهای Positional آن فراخوانده می‌شوند و سپس متد set برای هر یک از پارامترهای Named فراخوانده می‌شود .

 انواع (type) معتبر برای پارامترهای صفت

 انواع معتبر برای پارامترهای صفت بشرح زیر می‌باشند :

bool,byte,char,double,float,int,long,short,string,System.Type ,object 

همچنین می‌توان از enum و یا آرایه‌ای تک بعدی، که عناصر آن یکی از انواع فوق باشد، نیز استفاده نمود.

 استفاده از صفتها در زمان اجرا

تا کنون با طریقه ساخت صفتها و چگونگی استفاده و اعمال آنها بر عناصر مختلف برنامه آشنا شدیم. حال نوبت به آن رسیده است تا ببینیم چگونه می‌توان از صفتها در زمان اجرا استفاده نمود. برای جستجوی (query) یک برنامه درباره صفت موجود در آن، به Reflection نیازمندیم. Reflection قابلیت بدست آوردن اطلاعات مربوط به انواع (Types) مختلف در زمان اجرای برنامه است. با استفاده از توابع Reflection موجود در .Net Framework می‌توانیم با جستجو و پیمایش Metadate مربوط به یک اسمبلی، لیست کاملی از کلاسها، انواع و متدهایی را که برای آن اسمبلی خاص تعریف شده‌اند را، بدست آوریم. به مثال 9-16 در این باره توجه نمایید.

 مثال 9-16 : استفاده از Reflection

using System;

using System.Reflection;

using System.Diagnostics;

//attaching Help attribute to entire assembly

[assembly : Help("This Assembly demonstrates custom attributes creation and their run-time query.")]

//our custom attribute class

public class HelpAttribute : Attribute

{

    public HelpAttribute(String Description_in)

    {

        //

        // TODO: Add constructor logic here

        this.description = Description_in;

        //

    }

    protected String description;

    public String Description

    {

        get

        {

            return this.deescription;

        }           

    }   

}

//attaching Help attribute to our AnyClass

[HelpString("This is a do-nothing Class.")]

public class AnyClass

{

//attaching Help attribute to our AnyMethod

    [Help("This is a do-nothing Method.")]

    public void AnyMethod()

    {

    }

//attaching Help attribute to our AnyInt Field

    [Help("This is any Integer.")]

    public int AnyInt;

}

class QueryApp

{

    public static void Main()

    {

    }

}

مبحث صفتها بسیار گسترده است و می‌توان ساعتها در مورد صفتهای مختلف بحث نمود. اما آنچه مسلم است تمرین مستمر و پیگیری برنامه نویس در یافتن مواردی که می‌توان با استفاده از صفتها، برنامه‌ای پویاتر ایجاد نمود، مهمترین عامل در فهم و درک کامل مبحث خواهد بود. درباره Reflection نیز در آینده در یان سایت مفصلا توضیح خواهم داد.

 خلاصه :

در این درس با صفتها آشنا شدید. یاد گرفتید که چگونه از صفتهای موجود در .Net Framework استفاده کرده و همچنین چگونه صفتهای شخصی و دلخواه خود را تولید نمایید. همچنین با پارامترهای صفتها و انواع آنها و نیز، عناصری که صفتها بر روی آنها اعمال می‌شوند آشنا شدید. در انتهای درس نیز به مختصر درباره Reflection و چگونگی استفاده از صفتها در زمان اجرا صحبت کردیم. امیدوارم مفید واقع شده باشد.

درس شانزدهم – استفاده از صفتها در C#

 درس شانزدهم – استفاده از صفتها در C#

 در این درس با نحوه استفاده از صفتها در زبان C# آشنا خواهید شد. اهداف ما در این درس به شرح زیر است :

1-     صفتها چه هستند و چرا از آنها استفاده می‌کنیم

2-     استفاده از صفتهای تک پارامتری و چند پارامتری

3-   انواع پارامترهای صفت (پارامترهای Named و Positional)

4- Target های صفتها (عناصری که صفتها بر روی آنها اعمال می‌شوند)

5- تولید صفتهای شخصی

6- تعریف و یا کنترل موارد استفاده از یک صفت

7- استفاده از پارامترهای Positional و Named در صفتهای شخصی

8- انواع (type) معتبر برای پارامترهای صفت

9- استفاده از صفتها در زمان اجرا

10- خلاصه مطالب

11- منابع
 

صفتها در حقیقت اطلاعات توضیحی هستند که می‌توانید آنها را به برنامه‌های خود بیفزایید. صفتها را می‌توان برای کلیه عناصر برنامه از قبیل کلاسها، واسطها، اسمبلی ها و ... مورد استفاده قرار داد. از این اطلاعات می‌توان برای موارد متنوعی در زمان اجرای برنامه استفاده نمود. برای مثال می‌توان به صفتی مانند DllImportAttribute اشاره کرد که امکان برقراری ارتباط با توابع کتابخانه‌ای Win32 را فراهم می‌نماید. همچنین صفتهایی نیز وجود دارند که برنامه‌نویس یا توسعه دهنده برنامه را در امر تولید برنامه یاری می‌نمایند. برای مثال می‌توان به صفت ObsoleteAttribute اشاره کرد که با استفاده از آن، در زمان کامپایل برنامه پیغامی برای برنامه نویس نمایش داده می‌شود و مشخص می‌کند که متدی خاص مورد استفاده قرار نگرفته و یا دیگر مورد استفاده نیست. همچنین هنگامیکه با فرمهای ویندوز کار می‌کنیم، صفتهای بسیاری وجود دارند که امکان استفاده از این فرمها را فراهم کرده و باعث می‌شوند تا اطلاعات مربوط به این عناصر در property فرم ظاهر شوند. یکی دیگر از موارد استفاده از صفتها در مسایل امنیتی اسمبلی‌های .Net است. برای مثال صفتهایی وجود دارند که باعث جلوگیری از فراخوانی‌های غیر مجاز می‌شوند، بدین معنی که تنها اجازه فراخوانی را به متدها یا اشیایی می‌دهند که قبلا تعریف شده و مشخص شده باشند.

 یکی از علتهای استفاده از صفتها آنست که، اغلب سرویسهایی را که آنها برای کاربر فراهم می‌نمایند، بسیار پیچیده است و با کدهای معمولی نمی‌توان آنرا را بدست آورد. از اینرو استفاده از صفتها در بسیاری از موارد ضروری و اجتناب ناپذیر است. همانطور که خواهید دید، صفتها به برنامه‌های ما Metadata اضافه می‌نمایند. پس از کامپایل برنامه‌های C#، فایل اسمبلی برای آن ایجاد می‌گردد که این اسمبلی معمولا یا یک فایل اجرایی است و یا یک Dll است. توصیف اسمبلی، در Metadata  ی مربوط به آن قرار می‌گیرد. طی پروسه‌ای تحت عنوان Reflection، صفت یک برنامه از طریق فایل Metadata  ی موجود در اسمبلی آن قابل دسترس می‌گردد. .(برای آشنایی بیشتر با اسمبلی و Metadata می‌توانید به " کامپایل یک برنامه سی شارپ " در همین سایت مراجعه نمایید.) در حقیقت صفتها، کلاسهایی هستند که می‌توانید آنها را با زبان C# تولید کرده و جهت افزودن اطلاعاتی توضیحی به کد خود، از آنها استفاده نمایید. این اطلاعات در زمان اجرای برنامه از طریق Reflection قابل دسترسی هستند.

 در این درس با روش استفاده از صفتها و چگونگی ارتباط دادن آنها با عناصر مختلف برنامه آشنا خواهید شد.

 مفاهیم اولیه درباره صفتها

 صفتها را معمولا قبل از اعلان عنصر مورد نظر در برنامه قرار می‌دهند. اعلان صفتها بدین صورت است که نام صفت درون دو براکت قرار می‌گیرد.

[ObsoleteAttribute]

استفاده از کلمه Attribute در اعلان صفت الزامی نیست، از اینرو اعلان زیر با اعلان فوق یکسان است :

[Obsolete]

همچنین صفتها می‌توانند دارای پارامتر نیز باشند که با استفاده از آنها خواص بیشتری را در اختیار برنامه قرار می‌دهند. در مثال 1-16 موارد متنوعی از استفاده صفت ObsoleteAttribute را مشاهده می‌نمایید.

مثال 1-16 :‌ نحوه استفاده از صفتها

using System;

class BasicAttributeDemo
{
    [Obsolete]
    public void MyFirstDeprecatedMethod()
    {
        Console.WriteLine("Called MyFirstDeprecatedMethod().");
    }

    [ObsoleteAttribute]
    public void MySecondDeprecatedMethod()
    {
        Console.WriteLine("Called MySecondDeprecatedMethod().");
    }

    [Obsolete("You shouldn't use this method anymore.")]
    public void MyThirdDeprecatedMethod()
    {
        Console.WriteLine("Called MyThirdDeprecatedMethod().");
    }

    // make the program thread safe for COM
    [STAThread]
    static void Main(string[] args)
    {
        BasicAttributeDemo attrDemo = new BasicAttributeDemo();

        attrDemo.MyFirstDeprecatedMethod();
        attrDemo.MySecondDeprecatedMethod();
        attrDemo.MyThirdDeprecatedMethod();
    }
}

همانطور که در مثال 1-16 نیز مشاهده می‌شود، صفت Obsolete در فرمهای مختلف مورد استفاده قرار گرفته است. اولین محلی که از این صفت استفاده شده است، متد MyFirstDeprecatedMethod() و پس از آن در متد MySecondDeprecatedMethod()  است. تنها تفاوت استفاده در این دو حالت آنست که در متد دوم صفت با نام کامل یعنی به همراه کلمه Attribute مورد استفاده قرار گرفته است. نتیجه هر دو اعلان یکسان است. همانطور که گفته بودیم، صفتها می‌توانند دارای پارامتر نیز باشند :

[Obsolete("You shouldn't use this method anymore.")]

    public void MyThirdDeprecatedMethod()

    ...

این پارامتر، ویژگی خاصی را به صفت می‌افزاید که آن را با دو اعلان قبلی متمایز می‌نماید. نتیجه هر سه اعلان این صفت در زیر آورده شده است. این پیغامها، پیامهای کامپایلر C# هستند که به هنگام کامپایل برنامه تولید شده‌اند.

>csc BasicAttributeDemo.cs

Microsoft (R) Visual C# .NET Compiler version 7.10.2292.4

for Microsoft (R) .NET Framework version 1.1.4322

Copyright (C) Microsoft Corporation 2001-2002. All rights reserved.

BasicAttributeDemo.cs(29,3): warning CS0612:

'BasicAttributeDemo.MyFirstDeprecatedMethod()' is obsolete

BasicAttributeDemo.cs(30,3): warning CS0612:

'BasicAttributeDemo.MySecondDeprecatedMethod()' is obsolete

BasicAttributeDemo.cs(31,3): warning CS0618:

'BasicAttributeDemo.MyThirdDeprecatedMethod()' is obsolete: 'You shouldn't use this method anymore.'

همانطور که ملاحظه می‌کنید، سومین اعلان صفت در این برنامه که با پارامتر همراه بود، باعث شده است تا پارامتر صفت نیز به عنوان بخشی از پیام نمایش داده شده توسط کامپایلر، نشان داده شود. در مورد دو صفت دیگر نیز مشاهده می‌شود که تنها پیغامی ساده تولید گردیده است.

 مثال 1-16 شامل صفت دیگری نیز می‌باشد. این صفت STAThreadAttribute است که معمولا در ابتدای کلیه برنامه‌های C# و قبل از آغاز متد Main() قرار می‌گیرد. این صفت بیان می‌دارد که برنامه C# مورد نظر می‌تواند با کد مدیریت نشده COM از طریق Simple Threading Apartment ارتباط برقرار نماید. استفاده از این صفت در هر برنامه‌ای می‌تواند مفید باشد، چراکه شما بعنوان برنامه نویس هیچ‌گاه اطلاع ندارید که آیا کنابخانه ثالثی که از آن استفاده می‌کنید، قصد برقراری ارتباط با COM را دارد یا نه؟ (در صورتیکه با برخی از اصطلاحات بکار رفته آشنایی ندارید اصلا نگران نشوید. در اینجا هدف تنها نشان دادن موارد استفاده از صفتهاست.)

 صفتها می‌توانند دارای چندین پارامتر باشند. در مثال 2-16، استفاده از دو پارامتر برای یک صفت نشان داده شده است.

 مثال 2-16

using System;

public class AnyClass 

{

    [Obsolete("Don't use Old method, use New method", true)]

    static void Old( ) { }

    static void New( ) { }

    public static void Main( ) 

    {

        Old( );

    }

}

همانطور که در مثال 2-16 مشاهده می‌کنید، صفت مورد استفاده دارای دو پارامتر است. پارامتر اول که یک جمله متنی است و همانند مثال 1-16 عمل می‌کند. پارامتر دوم نیز بیان کننده نوع پیغامی است که این صفت در هنگام کامپایل تولید می‌کند. در صورتیکه این مقدار برابر با True باشد، بدین معناست که در هنگام کامپایل پیغام خطا تولید می‌شود و کامپایل برنامه متوقف می‌گردد. در حالت پیش فرض مقدار این پارامتر برابر با False است که بیان می‌دارد، به هنگام کامپایل تنها پیغام هشداری تولید خواهد شد. در پیغام این برنامه، عنصری از برنامه را که نباید از آن استفاده شود معین شده و جایگزین آن نیز معرفی می‌شود.

AnyClass.Old()' is obsolete: 'Don't use Old method,  use New method'

 نکته مهمی که باید در مورد صفتها در نظر بگیرید آنست که اطلاعاتی که توسط صفت در کد برنامه قرار می‌گیرد، توسط سایر برنامه‌ها نیز قابل تفسیر و استفاده است.

 انواع پارامترهای صفت (پارامترهای Positional و Named)

همانطور که در بالا نیز اشاره شد، صفتها می‌توانند دارای پارامتر نیز باشند. این پارامترها به دو دسته تقسیم می‌شوند. پارامترهای محلی (positional) و پارامترهای اسمی (named). از پارامترهای positional در زمانی استفاده می‌شود که می‌خواهیم پارامتر مورد نظر بصورت اجباری مورد استفاده قرار گیرد و البته این مسئله یک قانون نیست ! چراکه در مورد صفت Obsolete، این صفت دارای یک پارامتر positional دیگر با نام error و از نوع int نیز می‌باشد که ما آنرا در مثال 1-16 لحاظ نکردیم. همانطور که در مثال 2-16 مشاهده کردید، از این پارامتر positional می‌توان برای ایجاد یک خطا در زمان کامپایل برنامه استفاده نمود.

[Obsolete("Don't use Old method, use New method", true)]

static void Old( ) { }

تفاوت پارامترهای positional با پارامترهای named در آنست که، پارامترهای named با نامشان مورد استفاده قرار می‌گیرند و همیشه اختیاری هستند. در مثال 3-16 صفت DllImport را مشاهده می‌نمایید که دارای هر دو نوع پارامتر positional و named است.

مثال 3-16

using System;
using System.Runtime.InteropServices;

class AttributeParamsDemo
{
    [DllImport("User32.dll", EntryPoint="MessageBox")]
    static extern int MessageDialog(int hWnd, string msg, string caption, int msgType);

    [STAThread]
    static void Main(string[] args)
    {
        MessageDialog(0, "MessageDialog Called!", "DllImport Demo", 0);
    }
}

صفت DllImport در مثال 3-16 دارای یک پارامتر positional ("User32.dll") و یک پارامتر named (EntryPoint="MessageBox") است . پارامترهای named در هر مکانی می‌توانند قرار گیرند و مانند پارامترهای positional دارای محدودیت مکانی نیستند. بدین معنا که چون در پارامترهای named، نام پارامتر مستقیما مورد استفاده قرار می‌گیرد، محل قرار گیری آن در لیست پارامترهای صفت مهم نیست اما در مورد پارامترهای positional چون اسم پارامتر مورد استفاده قرار نمی‌گیرد، این پارامترها حتما باید در مکانهای تعیین شده و تعریف شده در لیست پارامترهای صفت قرار گیرند. توجه کنید که چون هدف ما تنها آشنایی با صفتها و نحوه استفاده از آنهاست، درباره پارامترهای مختلف صفت DllImport بحث نخواهیم کرد چراکه پارامترهای این صفت نیاز به آشنایی کامل با Win32 API دارد.

 در یک بررسی کلی می‌توان گفت که پارامترهای Positional، پارامترهای سازنده(Constructor)  صفت هستند و در هر بار استفاده از صفت باید مورد استفاده قرار گیرند، ولی پارامترهای Named کاملا اختیاری هستند و همیشه نیازی به استفاده از آنها نمی‌باشد.

 Target های صفتها (عناصری که صفتها بر روی آنها اعمال می‌شوند)

صفتهایی که تا کنون مشاهده کردید، همگی بر روی متدها اعمال شده بودند. اما عناصر مختلف دیگری در C# وجود دارند که می‌توان صفتها را بر روی آنها اعمال نمود. جدول 1-16 عناصر مختلف زبان C# را که صفتها بر روی آنها اعمال می‌شوند را نشان می‌دهد.

قابل اعمال به ....	عناصر اعمال شونده
به تمامی عناصر قابل اعمال هستند.	all
به تمام یک اسمبلی	assembly
کلاسها	class
سازنده‌ها	constructor
Delegate ها	delegates
عناصر شمارشی	enum
رخدادها	event
فیلدها	field
واسطها	interface
متدها	method
ماژولها (کدهای کامپایل شده‌ای که می‌توانند به عنوان قسمتی از یک اسمبلی در نظر گرفته شوند.)	module
پارامترها	parameter
Property ها	property
مقادیر بازگشتی	returnvalue
ساختارها	struc

 هر چند ممکن است استفاده از این Target ها باعث ایجاد ابهام شوند، اما می‌توان با استفاده از این Target ها معین کرد که صفت دقیقا به عنصر مورد نظر اعمال شود. یکی از صفتهایی که بر روی اسمبلی اعمال می‌شود و باعث ارتباط با CLS می‌گردد، صفت CLSCompliantAttribute است. CLS یا همان Common Language Specification امکان برقراری ارتباط بین کلیه زبانهایی که تحت .Net کار می‌کنند را فراهم می‌نماید. Target های صفتها با استفاده از اسم Target که بعد از آن کولون قرار می‌گیرد، ایجاد می‌شوند. در مثال 4-16 نحوه استفاده از این صفت نشان داده شده است.

 مثال 4-16

using System;

[assembly:CLSCompliant(true)]

public class AttributeTargetDemo
{
    public void NonClsCompliantMethod(uint nclsParam)
    {
        Console.WriteLine("Called NonClsCompliantMethod().");
    }

    [STAThread]
    static void Main(string[] args)
    {
        uint myUint = 0;

        AttributeTargetDemo tgtDemo = new AttributeTargetDemo();

        tgtDemo.NonClsCompliantMethod(myUint);
    }
}

با استفاده از Target مورد نظر در اینجا یعنی assembly، این صفت بر روی کل اسمبلی اعمال می‌گردد. کد موجود در مثال 4-16 کامپایل نخواهد شد، زیرا uint در متد NonClsCompliantMethod() اعلان شده است. در اینجا درصورتیکه فرم پارامتر صفت CLSCompliant را به false تغییر دهید و یا متد NonClsCompliantMethod() را به متدی منطبق با CLS تبدیل کنید (مثلا نوع بازگشتی آنرا int تعریف کنید) آنگاه برنامه کامپایل خواهد شد. (توضیحی که درباره CLS میتوانم بیان کنم اینست که CLS مجموعه‌ای از ویژگیها و خواص .Net Framework است که به نحوی بیان می‌دارد، برای اینکه زبانهای مختلف تحت .Net بتوانند بدون مشکل با یکدیگر ارتباط برقرار نمایند، لازم است از یک سری از قوانین پیروی کنند، در غیر اینصورت امکان برقراری ارتباط با سایر کدهای نوسته شده تحت زبانهای برنامه‌سازی دیگر را نخواهند داشت. برای مثال، استفاده از نوع uint به دلیل اینکه در زبانهای مختلف می‌تواند به صورتهای متفاوتی پیاده‌سازی شود و یا وجود نداشته باشد، سازگار با CLS نیست و برای اینکه بخواهیم برنامه‌ای منطبق با CLS داشته باشیم نباید از آن استفاده نماییم.)

 نکته قابل توجه در مورد مثال 4-16 آنست که در این مثال صفت CLSCompliant به استفاده از یک Target که همان assembly است، مورد استفاده قرار گرفته است و از اینرو تمامی مشخصات این صفت به کلیه اعضای این اسمبلی اعمال خواهند شد. توجه نمایید که در این مثال علت و موارد استفاده از صفتها مشهودتر است، چراکه همانطور که مشاهده می‌نمایید، با استفاده از یک صفت می‌توانیم کنترلی بر روی کل اسمبلی و برنامه قرار دهیم تا در صورتیکه می‌‌خواهیم برنامه ما با سایر زبانهای برنامه‌سازی تحت .Net ارتباط برقرار کند، از متدهای استاندارد و سازگار با CLS استفاده نماییم که این قابلیت بزرگی را در اختیار ما قرار خواهد داد.

 تولید صفتهای شخصی

پس از اینکه با طریقه استفاده از صفتهای موجود در زبان آشنا شدید، حال نوبت به ساخت صفتهای شخصی می‌رسد. برای تولید یک صفت (Attribute) باید یک کلاس ایجاد نماییم و این کلاس باید از System.Attribute مشتق شود. کلاسی که از System.Attribute مشتق می‌شود (چه بطور مستقیم و چه بطور غیر مستقیم) یک کلاس صفت(Attribute Class)  است. اعلان کلاس صفت باعث ایجاد صفت جدیدی می‌شود که می‌توان از آن در برنامه استفاده نمود. به مثال 5-16 توجه فرمایید.

 مثال 5-16

using System;

public class HelpAttribute : Attribute

{

}

در این مثال به سادگی یک صفت جدید تولید کرده‌ایم و می‌توانیم از آن استفاده کنیم.

[Help()]

public class AnyClass

{

}

 همانطور که قبلا نیز گفتیم استفاده از کلمه Attribute به دنبال نام صفت الزامی نیست. صفتی که در اینجا ایجاد کرده‌ایم عملا کار خاصی برای ما انجام نمی‌دهد پس اندکی در کد آن تغییر ایجاد می‌کنیم تا مفیدتر باشد.

 مثال 6-16

using System;

public class HelpAttribute : Attribute

{

    public HelpAttribute(String Descrition_in)

    {

        this.description = Description_in;

    }

    protected String description;

    public String Description 

    {

        get 

        {

            return this.description;

        }            

    }    

}

[Help("this is a do-nothing class")]

public class AnyClass

{

}

 هماطور که مشاهده می‌کنید با اضافه کردن چند خط کد توانستیم این صفت را کاراتر کنیم. با قرار دادن یک property در این صفت، پارامتر این صفت بعنوان پیغام نمایش داده می‌شود.

درس پانزدهم - برخورد با استثناها (Exception Handling)

درس پانزدهم - برخورد با استثناها (Exception Handling)

در این درس با چگونگی برخورد با استثناها (یا خطاهای غیر قابل پیش‌بینی) در زبان برنامه‌سازی C# آشنا می‌شویم. اهداف ما در این درس بشرح زیر می‌باشد :

1)      درک و فهم صحیح یک استثناء یا Exception

2)      پیاده‌سازی یک روتین برای برخورد با استثناها بوسیله بلوک try/catch

3)      آزادسازی منابع تخصیص داده شده به یک برنامه در یک بلوک finally

استثناها، در حقیقت خطاهای غیر منتظره در برنامه‌های ما هستند. اکثراً، می‌توان و باید روشهایی را جهت برخورد با خطاهای موجود در برنامه در نظر گرفت و آنها را پیاده‌سازی کرد. بعنوان مثال، بررسی و تایید داده‌های ورودی کاربران، بررسی اشیاء تهی یا Null و یا بررسی نوع بازگشتی متد ها، می‌توانند از جمله مواردی باشند که باید مورد بررسی قرار گیرند. این خطاها، خطاهایی معمول و رایجی هستند که اکثر برنامه‌نویسان از آنها مطلع بوده و راههایی را برای بررسی آنها در نظر می‌گیرند تا از وقوع آنها جلوگیری نمایند.

 اما زمانهایی وجود دارند که از اتفاق افتادن یک خطا در برنامه بی اطلاع هستید و انتظار وقوع خطا در برنامه را ندارید. بعنوان مثال، هرگز نمی‌‌توان وقوع یک خطای I/O را پیش‌بینی نمود و یا کمبود حافظه برای اجرای برنامه و از کار افتادن برنامه به این دلیل. این موارد بسیار غیر منتظره و ناخواسته هستند، اما در صورت وقوع بهتر است بتوان راهی برای مقابله و برخورد با آنها پیدا کرده و با آنها برخورد نمود. در این جاست که مسئله برخورد با استثناها (Exception Handling) مطرح می‌شود.

 هنگامیکه استثنایی رخ می‌دهد، در اصطلاح می‌گوئیم که این استثناء، thrown شده است. در حقیقت thrown، شیء‌ای است مشتق شده از کلاس System.Exception که اطلاعاتی در مورد خطا یا استثناء رخ داده را نشان می‌دهد. در قسمتهای مختلف این درس با روش مقابله با استثناها با استفاده از بلوک های try/catch آشنا خواهید شد.

 کلاس System.Exception حاوی تعداد بسیار زیادی متد و property است که اطلاعات مهمی در مورد استثناء و خطای رخ داده را در اختیار ما قرار می‌دهد. برای مثال، Message یکی از property های موجود در این کلاس است که اطلاعاتی درباره نوع استثناء رخ داده در اختیار ما قرار می‌دهد. StackTrace نیز، اطلاعاتی در مورد Stack (پشته) و محل وقوع خطا در Stack در اختیار ما قرار خواهد داد.

 تشخیص چنین استثناهایی، دقیقاً با روتین‌های نوشته شده توسط برنامه‌نویس در ارتباط هستند و بستگی کامل به الگوریتمی دارد که وی برای چنین شرایطی در نظر گرفته است. برای مثال، در صورتیکه با استفاده از متد System.IO.File.OpenRead()، اقدام به باز کردن فایلی نماییم، احتمال وقوع (Thrown) یکی از استثناهای زیر وجود دارد :

SecurityException

ArgumentException

ArgumentNullException

PathTooLongException

DirectoryNotFoundException

UnauthorizedAccessException

FileNotFoundException

NotSupportedException

با نگاهی بر مستندات .Net Framework SDK، به سادگی می‌توان از خطاها و استثناهایی که ممکن است یک متد ایجاد کند، مطلع شد. تنها کافیست به قسمت Reference/Class Library رفته و مستندات مربوط به Namespace/Class/Method را مطالعه نمایید. در این مستندات هر خطا دارای لینکی به کلاس تعریف کننده خود است که با استفاده از آن می‌توان متوجه شد که این استثناء به چه موضوعی مربوط است. پس از اینکه از امکان وقوع خطایی در قسمتی از برنامه مطلع شدید، لازم است تا با استفاده از مکانیزمی صحیح به مقابله با آن بپردازید.

 هنگامیکه یک استثناء در اصطلاح thrown می‌شود (یا اتفاق می‌افتد) باید بتوان به طریقی با آن مقابله نمود. با استفاده از بلوکهای try/catch می‌توان چنین عملی را انجام داد. پیاده‌سازی این بلوکها بدین شکل هستند که، کدی را که احتمال تولید استثناء در آن وجود دارد را در بلوک try، و کد مربوط به مقابله با این استثناء رخ داده را در بلوک catch قرار می‌دهیم. در مثال 1-15  چگونگی پیاده‌سازی یک بلوک try/catch نشان داده شده است. بدلیل اینکه متد OpenRead() احتمال ایجاد یکی از استثناهای گفته شده در بالا را دارد، آنرا در بلوک try قرار داده ایم. در صورتیکه این خطا رخ دهد، با آن در بلوک catch مقابله خواهیم کرد. در مثال 1-15 در صورت بروز استثناء، پیغامی در مورد استثناء رخ داده و اطلاعاتی در مورد محل وقوع آن در Stack برای کاربر بر روی کنسول نمایش داده  می‌شود.

 نکته : توجه نمایید که کلیه مثالهای موجود در این درس به طور تعمدی دارای خطاهایی هستند تا شما با نحوه مقابله با استثناها آشنا شوید.

using System;

using System.IO;

class TryCatchDemo

{

static void Main(string[] args)

{

try

{

File.OpenRead("NonExistentFile");

}

catch(Exception ex)

{

Console.WriteLine(ex.ToString());

}

}

}

هر چند کد موجود در مثال 1-15 تنها داری یک بلوک catch است، اما تمامی استثناهایی که ممکن است رخ دهند را نشان داده و مورد بررسی قرار می‌دهد زیرا از نوع کلاس پایه استثناء، یعنی Exception تعریف شده است. در کنترل و مقابله با استثناها، باید استثناهای خاص را زودتر از استثناهای کلی مورد بررسی قرار داد. کد زیر نحوه استفاده از چند بلوک catch را نشان می‌دهد :

catch(FileNotFoundException fnfex)

{

  Console.WriteLine(fnfex.ToString());

}

catch(Exception ex)

{

  Console.WriteLine(ex.ToString());

}

در این کد، در صورتیکه فایل مورد نظر وجود نداشته باشد، FileNotFoundException رخ داده  و توسط اولین بلوک catch مورد بررسی قرار می‌گیرد. اما در صورتیکه PathTooLongException رخ دهد، توسط دومین بلوک catch بررسی خواهد شد. علت آنست که برای PathTooLongException بلوک catch ای در نظر گرفته نشده است و تنها گزینه موجود جهت بررسی این استثناء بلوک کلی Exception است. نکته ای که در اینجا باید بدان توجه نمود آنست که هرچه بلوکهای catch مورد استفاده خاص تر و جزئی تر باشند، پیغامها و اطلاعات مفیدتری در مورد خطا می‌توان بدست آورد.

 استثناهایی که مورد بررسی قرار نگیرند، در بالای Stack نگهداری می شوند تا زمانیکه بلوک try/catch مناسبی مربوط به آنها یافت شود. در صورتیکه برای استثناء رخ داده بلوک try/catch در نظر گرفته نشده باشد، برنامه متوقف شده و پیغام خطایی ظاهر می‌گردد. این چنین حالتی بسیار نا مناسب بوده و کاربران را دچار آشفتگی خواهد کرد. استفاده از روشهای مقابله با استثناها در برنامه، روشی مناسب و رایج است و باعث قدرتمند تر شدن برنامه می‌شود.

 یکی از حالتهای بسیار خطرناک و نامناسب در زمان وقوع استثناها، هنگامی است که استثناء یا خطای رخ داده باعث از کار افتادن برنامه شود ولی منابع تخصیص داده شده به آن برنامه آزاد نشده باشند. هر چند بلوک catch برای برخورد با استثناها مناسب است ولی در مورد گفته شده نمی تواند کمکی به حل مشکل نماید. برای چنین شرایطی که نیاز به آزادسازی منابع تخصیص داده شده به یک برنامه داریم، از بلوک finally استفاده می‌کنیم.

 کد نشان داده شده در مثال 2-15، به خوبی روش استفاده از بلوک finally را نشان می‌دهد. همانطور که حتماً می‌دانید، رشته های فایلی پس از اینکه کار با آنها به اتمام می‌رسد باید بسته شوند، در غیر اینصورت هیچ برنامه دیگری قادر به استفاده از آنها نخواهد بود. در این حالت، رشته فایلی، منبعی است که می‌خواهیم پس از باز شدن و اتمام کار، بسته شده و به سیستم باز گردد. در مثال 2-15، outStream با موفقیت باز می‌شود، بدین معنا که برنامه handle ای به یک فایل باز شده در اختیار دارد. اما زمانیکه می‌خواهیم inStraem را باز کنیم، استثناء FileNotFound رخ داده و باعث می‌شود که کنترل برنامه سریعاً به بلوک catch منتقل گردد.

 در بلوک catch می‌توانیم فایل outStream را ببندیم. اما برنامه تنها زمانی به بلوک catch وارد می‌شود که استثنایی رخ دهد. پس اگر هیچ استثنائی رخ نداده و برنامه به درستی عمل نماید، فایل باز شده outStream هرگز بسته نشده و یکی از منابع سیستم به آن بازگردانده نمی‌شود. بنابراین باید برای بستن این فایل نیز فکری کرد. این کاری است که در بلوک finally رخ می دهد. بدین معنا که در هر حالت، چه برنامه با استثنائی روبرو شود و چه نشود، قبل از خروج از برنامه فایل باز شده، بسته خواهد شد. در حقیقت می‌توان گفت بلوک finally، بلوکی است که تضمین می‌نماید در هر شرایطی اجرا خواهد شد. پس برای حصول اطمینان از اینکه منابع مورد استفاده برنامه پس از خروج برنامه، به سیستم باز گردانده می‌شوند، می‌توان از این بلوک استفاده کرد.

using System;

using System.IO;

class FinallyDemo

{

static void Main(string[] args)

{

FileStream outStream = null;

FileStream inStream = null;

try

{

outStream = File.OpenWrite("DestinationFile.txt");

inStream = File.OpenRead("BogusInputFile.txt");

}

catch(Exception ex)

{

Console.WriteLine(ex.ToString());

}

finally

{

if (outStream != null)

{

outStream.Close();

Console.WriteLine("outStream closed.");

}

if (inStream != null)

{

inStream.Close();

Console.WriteLine("inStream closed.");

}

}

}

}

استفاده از بلوک finally الزامی نیست، اما روشی مناسب برای بالا بردن کارآیی برنامه است. ممکن است سوالی در اینجا مطرح شود : در صورتیکه پس از بلوک catch و بدون استفاده از بلوک finally، فایل باز شده را ببندیم، باز هم منبع تخصیص داده شده به برنامه آزاد می شود. پس چه دلیلی برای استفاده از بلوک finally وجود دارد؟ در پاسخ به این سوال باید گفت، در شرایط نرمال که تمامی برنامه بطور طبیعی اجرا می‌‌شود و اتفاق خاصی رخ نمی‌دهد، می توان گفت که دستورات بعد از بلوک catch اجرا شده و منبع تخصیص داده شده به سیستم آزاد می شود. اما برای بررسی همیشه باید بدترین حالت را در نظر گرفت. فرض کنید درون خود بلوک catch استثنائی رخ دهد که شما آنرا پیش‌بینی نکرده‌اید و یا این استثناء باعت متوقف شدن برنامه شود، در چنین حالتی کدهای موجود بعد از بلوک catch هرگر اجرا نخواهند شد و فایل همچنان باز می‌ماند. اما با استفاده از بلوک finally می‌توان مطمئن بود که کد موجود در این بلوک حتماً اجرا شده و منبع تخصیص داده شده به برنامه آزاد می‌گردد.

 در اینجا به پایان درس پانزدهم رسیدیم. هم اکنون می بایست درک صحیحی از استثناء بدست آورده باشید. همچنین می‌توانید به سادگی الگوریتمهایی جهت بررسی استثناها بوسیله بلوکهای try/catch پیاده‌سازی نمایید. بعلاوه می‌توانید با ساتفاده از بلوک finally مطمئن باشید که که منابع تخصیص داده شده به برنامه، به سیستم باز خواهند گشت چراکه این بلوک حتما اجرا می‌شود و می‌توان کدهای مهمی را که می‌خواهیم تحت هر شرایطی اجرا شوند را درون آن قرار داد.