Thuộc tính của .NET

Thuộc tính là một trong những khái niệm quan trọng nhất của .NET, nó ảnh hưởng đến nhiều phương diện khác nhau của một ứng dụng .NET như khả năng giao tiếp với các thành phần COM, khả năng tạo ra trình dịch vụ, tính năng bảo mật, tính năng lưu dữ liệu của đối tượng vào tập tin...

Thuộc tính là gì?

Sức mạnh của .NET (so với các đời trước) có được phần lớn là do ý tưởng về thông tin mô tả (metadata) đem lại. Chính những thông tin này đã giúp cho các assembly tự mô tả đầy đủ chính nó, nhờ đó việc giao tiếp và sử dụng lại các chương trình viết bằng những ngôn ngữ khác nhau cũng trở nên dễ dàng, hiệu quả hơn. Việc lập trình tất nhiên cũng đơn giản hơn! Làm sao cung cấp những thông tin này? Câu trả lời là: dùng thuộc tính.

Thuộc tính là những đối tượng chuyên dùng để cung cấp thông tin mô tả cho các phần tử trong một assembly .NET. Phần tử ở đây bao gồm assembly, lớp, các thành viên của lớp (gồm hàm tạo, hàm thuộc tính, trường, hàm chức năng, tham biến, giá trị trả về), sự kiện.

Cách sử dụng thuộc tính trong C#

Có một số qui tắc bắt buộc phải tuân theo khi dùng thuộc tính để viết mã chương trình:

• Thuộc tính phải đặt trong dấu ngoặc vuông.

Ví dụ: Khi bạn tạo ra một ứng dụng loại Console trong VS.NET IDE, bạn sẽ thấy hàm Main được áp dụng thuộc tính STAThread như sau:

[STAThread]

static void Main(string[] args){

...

}

• Tên các lớp thuộc tính thường có đuôi là "Attribute" nhưng bạn có thể không ghi đuôi này.

Ví dụ: Hãy thử đổi [STAThread] thành [STAThreadAttribute] và biên dịch chương trình. Bạn sẽ thấy không có lỗi gì xảy ra.

• Thuộc tính có thể có nhiều biến thể ứng với nhiều bộ tham biến khác nhau. Khi cần truyền tham số cho thuộc tính, ghi chúng trong cặp ngoặc đơn. Riêng đối với biến thể không tham biến, có thể ghi hoặc không ghi cặp ngoặc rỗng "()". Ngoài ra, các tham số phải là các biểu thức hằng, biểu thức typeof hay biểu thức tạo mảng (như new Type[]{typeof(TargetException)}).

Ví dụ 1: Có thể thay [STAThread] bằng [STAThread()].

Ví dụ 2: Khi cần đánh dấu một lớp, hàm là "đã cũ, cần dùng phiên bản thay thế", ta có thể dùng thuộc tính ObsoleteAttribute. 1 trong 3 biến thể của thuộc tính này là:

[Obsolete(string message, bool error)]

Trong đó: message dùng để cung cấp thông tin chỉ dẫn về lớp, hàm thay thế. error dùng để hướng dẫn cho trình biên dịch biết cần làm gì khi biên dịch lớp, hàm sử dụng phần tử được áp dụng Obsolete. Nếu error bằng true, trình biên dịch báo lỗi và không biên dịch. Ngược lại, trình biên dịch chỉ cảnh báo và vẫn biên dịch bình thường.

Như vậy, ta có thể sử dụng như sau:

[Obsolete("Nên dùng lớp NewClass", false)]

public class OldClass{

...

}

// lớp này không được áp dụng thuộc tính Obsolete

public class ClientClass{

private OldClass a = new OldClass();

...

}

Khi biên dịch lớp ClientClass, VS.NET IDE sẽ thông báo ở cửa sổ Task List như hình 1:

Nếu bạn sửa false thành true thì bạn sẽ thấy bảng báo lỗi như hình 2:

Hình 2

Ví dụ 3: không thể dùng

private string s = "Nên dùng lớp NewClass";

[Obsolete(s, false)]

Nhưng nếu thêm const vào phần khai báo của s thì hợp lệ.

• Thuộc tính có mục tiêu áp dụng (do người viết ra thuộc tính qui định) xác định nên vị trí đặt cũng bị hạn chế. Nói chung, thuộc tính phải đặt trước mục tiêu áp dụng và không thể đứng bên trong thân hàm. Nếu thuộc tính có nhiều mục tiêu áp dụng được thì có thể chỉ định mục tiêu cụ thể bằng một trong các từ khoá: assembly, module, type, event, field, property, method, param, return.

Ví dụ:

[assembly: AssemblyTitle("Demo")] // Đúng chỗ

namespace Demo;

[assembly: AssemblyTitle("Demo")] // Sai chỗ

[type: Obsolete] // Đúng chỗ

// [method: Obsolete] // Sai chỗ

public class OldClass{

[type: Obsolete] // Sai chỗ

…

}

}

• Thuộc tính có thể đặt trong các cặp ngoặc vuông liên tiếp nhau hay đặt trong cùng một cặp ngoặc vuông nhưng cách nhau bởi dấu phẩy.

Ví dụ:

[type: Obsolete("Nên dùng lớp NewClass", false),Serializable]

tương đương với

[type: Obsolete("Nên dùng lớp NewClass", false)]

[Serializable]

• Có những thuộc tính có thể được áp dụng nhiều lần cho cùng một mục tiêu. Điều này cũng do người viết ra thuộc tính qui định.

Ví dụ 1:

// Trình biên dịch sẽ báo lỗi "Duplicate Obsolete attribute"

[type:Obsolete]

[type:Obsolete]

public class OldClass{

...

}

Ví dụ 2:

// Trình biên dịch không báo lỗi

// Thuộc tính ExpectedException ở đây là thuộc tính custom mà ta sẽ tự tạo trong phần 5-

[type: ExpectedException( typeof(xxxException) )]

[type: ExpectedException( typeof(xxxException) )]

public class OldClass{
...

}

• Một số thuộc tính có tính kế thừa. Khi bạn áp dụng những thuộc tính này cho một lớp nào đó, hãy nhớ là các lớp con của lớp đó cũng mặc nhiên được áp dụng các thuộc tính đó. Bạn sẽ thấy rõ điều này trong phần "Tạo một thuộc tính custom".

• Cuối cùng, khi sử dụng thuộc tính nào, nhớ tạo ra tham chiếu tới không gian kiểu chứa nó. Chẳng hạn như, để dùng các thuộc tính như AssemblyTitle, AssemblyVersion, cần thêm:

using System.Reflection;

Đặc điểm của thuộc tính

1. Khi thêm thuộc tính vào mã chương trình, ta đã tạo ra một đối tượng mà các thông tin của nó sẽ được lưu vào assembly chứa mục tiêu áp dụng của thuộc tính. Tùy theo thuộc tính thuộc loại custom hay p-custom (p- là pseudo) mà những thông tin này sẽ được lưu thành chỉ thị .custom hay khác (.ver, .hash, serializable,... ) trong tập mã IL.

Ví dụ: lớp OldClass sau sẽ có mã IL (xem bằng ILDasm.exe) như hình 3:

[Obsolete("Nen dung lop NewClass", false)]

[Serializable]

public class OldClass{
…

}

Hình 3

• Tuy được lưu trong assembly nhưng thuộc tính hoàn toàn không ảnh hưởng gì đến các mã lệnh khác. Thuộc tính chỉ có ý nghĩa khi có một chương trình nào đó cần đến và truy xuất nó thông qua tính năng Reflection của .NET. Dĩ nhiên, ý nghĩa của thuộc tính sẽ do chương trình đó qui định. Điều đó cũng có nghĩa là cùng một thuộc tính nhưng "dưới mắt" các chương trình đọc khác nhau sẽ có thể có công dụng khác nhau. Đây là đặc điểm đáng chú ý nhất của thuộc tính.
Ví dụ: thuộc tính Obsolete được trình biên dịch dùng để phát hiện những phần tử sẽ không được sử dụng nữa, [TestFixture] được NUnit dùng để chọn những lớp có chứa hàm kiểm tra cần được kích hoạt tự động,...

• Dữ liệu chỉ định trong thuộc tính gắn chặt với mục tiêu áp dụng của thuộc tính chứ không lỏng lẻo và do đó không linh hoạt như dữ liệu trong tập tin cấu hình. Nhờ vậy, dữ liệu mô tả lưu bằng thuộc tính an toàn hơn, khó sửa hơn.

• Thuộc tính còn có những đặc điểm khác như: có mục tiêu áp dụng xác định, có khả năng áp dụng nhiều lần cho cùng một mục tiêu, có thể được thừa kế.

Một số ví dụ minh họa ứng dụng của thuộc tính

a - Thuộc tính CLSCompliant:

Mục tiêu của .NET là tạo ra một nền tảng giao tiếp thống nhất giữa nhiều ngôn ngữ lập trình khác nhau. Để đạt được điều đó, .NET định ra 2 chuẩn là CTS và CLS, trong đó CTS bao gồm các kiểu cơ bản mà một ngôn ngữ .NET có thể chọn hỗ trợ còn CLS là một tập các qui tắc bắt buộc mọi ngôn ngữ .NET phải áp dụng cho các phần tử dùng để giao tiếp với nhau. Như vậy, một ngôn ngữ có thể hỗ trợ những kiểu mà ngôn ngữ khác không hỗ trợ. Kết quả là khi các ngôn ngữ muốn phối hợp với nhau thì những kiểu "không chung" này sẽ "phá đám", gây ra hiểu nhầm. Để tránh tình huống này, .NET tạo ra thuộc tính CLSCompliant dùng để nhờ trình biên dịch theo dõi và cảnh báo xem có phần tử nào vi phạm luật CLS hay không. Thuộc tính này có mục tiêu áp dụng là mọi phần tử.

Ví dụ:

// Kiểm tra xem mọi phần tử của assembly này có tương thích CLS không

[assembly: CLSCompliant(true)]

namespace Demo{

// Riêng: bỏ qua các phần tử của lớp này

[type: CLSCompliant(false)]

public class A{

private uint a;

public uint b;

}

public class B{

private uint a; // không bị coi là vi phạm vì có tầm vực private

public uint b; // vi phạm

}

}

b - Các thông tin mô tả về assembly:

Khi sử dụng VS.NET IDE để tạo một dự án, bạn sẽ thấy là luôn có một tập tin tên AssemblyInfo.xx (tùy theo ngôn ngữ, xx có thể là cs với C#, vb với VB.NET,...). Sau đây là nội dung tập tin AssemblyInfo.cs đã lược bỏ phần chú thích:

using System.Reflection;

using System.Runtime.CompilerServices;

[assembly: AssemblyTitle("")]

[assembly: AssemblyDescription("")]

[assembly: AssemblyConfiguration("")]

[assembly: AssemblyCompany("")]

[assembly: AssemblyProduct("")]

[assembly: AssemblyCopyright("")]

[assembly: AssemblyTrademark("")]

[assembly: AssemblyCulture("")]

[assembly: AssemblyVersion("1.0.*")]

[assembly: AssemblyDelaySign(false)]

[assembly: AssemblyKeyFile("")]

[assembly: AssemblyKeyName("")]

(Lưu ý: Có thể bạn ngộ nhận tập tin trên là bắt buộc phải có. Nhưng không, nó chẳng qua là một công cụ mà VS.NET cung cấp, giúp bạn tập trung các thông tin chung về assembly lại một chỗ. Bạn hoàn toàn có thể xóa bỏ tập tin trên và tạo lại các mục tương tự nhưng để rải rác ở các tập tin trong dự án.)

Như bạn thấy, tập tin trên chỉ chứa toàn các thuộc tính với mục tiêu áp dụng là assembly. Những thuộc tính ấy nằm trong 2 không gian kiểu System.Reflection và System.Runtime.CompilerServices. 8 thuộc tính đầu dùng để cung cấp các thông tin chung về assembly (có thể xem những thông tin này bằng ILDasm.exe hay Windows Explorer). AssemblyVersion dùng để ghi nhận số phiên bản cho assembly, số này sẽ được CLR cần đến. Cụ thể là nếu assembly A tham chiếu đến assembly B thì trong assembly A sẽ ghi nhận phiên bản của B mà A tham chiếu. Nhờ đó, khi CLR cần tải B để hỗ trợ cho A thì CLR có thể biết được và tải đúng phiên bản thích hợp của B.

AssemblyKeyFile dùng để chỉ định tập tin chứa cặp khóa chung/riêng mà trình biên dịch sẽ dựa vào để tạo ra assembly duy nhất. Nếu không dùng AssemblyKeyFile thì có thể dùng AssemblyKeyName thay thế, chỉ khác là cần chỉ định tên của khóa đã được cài đặt vào Crypto Service Provider trên máy. Cũng có thể dùng cùng lúc cả 2 thuộc tính để chỉ định khóa; khi ấy, AssemblyKeyName sẽ được ưu tiên dùng trước.

Cuối cùng, AssemblyDelaySign dùng để yêu cầu trình biên dịch tạo ra một assembly giả duy nhất (vì chỉ cần dựa vào khóa chung) giúp cho việc thử nghiệm dễ dàng hơn. Đến khi cần triển khai ứng dụng thực sự mới phải dùng khóa riêng để tạo ra assembly duy nhất. Nhờ có AssemblyDelaySign, khóa riêng có thể được giữ bí mật bởi một người nào đó mà không làm ảnh hưởng đến quá trình phát triển phần mềm chung của cả nhóm.

Tạo một thuộc tính custom

Trong các phần trước, chúng ta đã sử dụng các thuộc tính có sẵn của .NET. Trong phần này, chúng ta sẽ tìm hiểu cách tự tạo lấy các thuộc tính cho riêng mình "xài" thông qua quá trình xây dựng thuộc tính ExpectedException.

Cũng như những thuộc tính custom có sẵn, thuộc tính tự tạo của chúng ta phải là một lớp con của lớp System.Attribute:

// Theo qui ước, tên thuộc tính nên có đuôi là Attribute

public class ExpectedExceptionAttribute : System.Attribute{

...

}

Thuộc tính tự tạo có thể có các hàm tạo và hàm thuộc tính như một lớp thông thường:
...

private Type expected = null;

private string msg = "";

public ExpectedExceptionAttribute(Type expectedType):this(expectedType, ""){}

public ExpectedExceptionAttribute(Type expectedType, string message){

if (expectedType as Exception == null)

throw ...

expected = expectedType;

msg = message;

}

public Type ExpectedType{

get{

return expected;

}

}

public string Message{

get{

return msg;

}

set{

msg = value;

}

}
...

Khi sử dụng, các tham biến của hàm tạo trở thành các tham số vị trí (tức là bắt buộc có và được truyền theo đúng thứ tự khai báo), còn các hàm thuộc tính trở thành tham số có tên (tức không bắt buộc có và có thể được truyền theo thứ tự tùy ý, miễn là phải sau các tham số vị trí). Sau đây là một số cách dùng hợp lệ:

[ExpectedException(typeof(Exception))]

[ExpectedException(typeof(Exception), "Expected type: System.Exception")]

[ExpectedException(typeof(Exception), Message="Expected type: System.Exception")]

[ExpectedException(typeof(Exception), "Expected type: System.Exception"), Message="Expected type: System.Exception")]

Thuộc tính của ta chỉ cần áp dụng cho hàm tạo, hàm chức năng, hàm thuộc tính. Do đó, ta cần chỉ định mục tiêu áp dụng cho nó thông qua thuộc tính AttributeUsage như sau:

[AttributeUsage(AttributeTargets.Constructor | AttributeTargets.Method | AttributeTargets.Property)]

public class ExpectedExceptionAttribute:System.Attribute{...}

Mặt khác, một hàm có thể phát ra nhiều lỗi khác nhau, tức là thuộc tính ExpectedException có thể áp dụng nhiều lần cho cùng một mục tiêu. Ta chỉ định thêm:

[AttributeUsage(..., AllowMultiple = true)]

Cuối cùng, ta muốn rằng nếu các hàm virtual của lớp A được áp dụng thuộc tính ExpectedException thì các hàm override tương ứng của lớp con của A cũng kế thừa thuộc tính này. Do đó ta thêm:

[AttributeUsage(..., ..., Inherited = true)]

Xin lưu ý là chỉ khi cả AllowMultiple và Inherited đều bằng true thì lớp con mới được kế thừa toàn bộ thuộc tính với cùng giá trị đã áp dụng cho lớp cha.

Đến đây coi như ta đã hoàn tất phần định nghĩa thuộc tính. Ta đặt thuộc tính vừa tạo vào assembly tên DemoAttrLib.dll. Tiếp đến, ta xây dựng một chương trình sử dụng ExpectedExceptionAttribute. Ta đặt chương trình này trong assembly DemoAttrClient.exe.

/* Chương trình này gồm 2 lớp là DemoParentClient và DemoChildClient */

using System;

using System.Reflection;

using DemoAttrLib;

namespace DemoAttrClient

{

public class DemoParentClient

{

[method:ExpectedException(typeof(TargetException))]

public DemoParentClient(){...}

[method:ExpectedException(typeof(ArgumentException))]

[method:ExpectedException(typeof(TargetException))]

public void TestMethod1() {...}

[method:ExpectedException(typeof(TargetException))]

public virtual void TestMethod2() {...}

}

class DemoChildClient:DemoParentClient

{

[method:ExpectedException(typeof(ArgumentException))]

public override void TestMethod2() {...}

[method:ExpectedException(typeof(ArgumentException))]

public new void TestMethod1() {...}

}

}

Như đã nói, một thuộc tính chỉ có giá trị khi một chương trình nào đó dùng đến nó. Chương trình này sẽ dùng các lớp trong không gian kiểu System.Reflection để kiểm tra các thuộc tính đi kèm từng phần tử trước khi ra quyết định xử lý thích hợp đối với phần tử đó. Dưới đây là một ví dụ đơn giản về chương trình như thế (trong assembly DemoAttrReader.exe):

/* Đây là chương trình loại Console dùng để liệt kê các hàm được áp dụng thuộc tính ExpectedException trong assembly chỉ định. */

using System;

using System.Reflection;

using DemoAttrLib;

namespace DemoAttrReader

{

class DemoReader

{

// Hàm này trả về một chuỗi chứa thông tin báo cáo về mọi hàm được áp dụng thuộc tính ExpectedException trong assembly chỉ định.

public static string Read(string assemblyName)

{...}

// Hàm này trả về một chuỗi chứa thông tin báo cáo về mọi hàm được áp dụng thuộc tính ExpectedException trong kiểu chỉ định.

private static string AttrRead(Type t)

{...}

[STAThread]

static void Main(string[] args)

{

if (args.Length != 1)

{

Console.WriteLine("Hay chi dinh mot assembly nao do.");

return;

}

Console.WriteLine("BAO CAO:");

Console.WriteLine(DemoReader.Read(args[0]));

}

}

}

Kết quả chạy chương trình như ở hình 4- (chú ý là có tới 2 hàm TestMethod1 đối với lớp DemoChildClient):

Hình 4

Nếu bạn muốn có một ví dụ phức tạp hơn, mời bạn tham khảo mã nguồn của NUnit (www.nunit.org), chương trình kiểm tra tự động khá thông dụng với các lập trình viên .NET. Cách hoạt động của NUnit đơn giản là: dò trong assembly chỉ định những lớp nào có thuộc tính TestFixture và kích hoạt những hàm được đánh dấu bằng thuộc tính Test, SetUp, TearDown,... trong các lớp ấy.

Vậy là chúng ta đã cơ bản tìm hiểu xong về thuộc tính của .NET. Hy vọng những điều vừa trình bày sẽ giúp ích cho các bạn trong công việc lập trình của mình.

Nguyên Phương
Email: hungphung@hcm.fpt.vn
---------------------------------------
Tài liệu tham khảo
- "Applied .NET Attributes", tác giả: Tom Barnaby và Jason Bock, NXB: Appress.
- "C# Attributes", "Extending Metadata Using Attributes" và các bài liên quan trong thư viện MSDN.