Attribute và reflection

Thuộc phần Lập trình hướng đối tượng trong hành trình C# của Coddy. Bài học 44 trên 70.

Thuộc tính là các thẻ siêu dữ liệu bạn gắn vào những phần tử code như lớp, phương thức hoặc thuộc tính. Chúng không trực tiếp thay đổi cách code chạy, nhưng cung cấp thông tin có thể đọc được khi chạy chương trình. Reflection là cơ chế đọc siêu dữ liệu này.

Bạn áp dụng một thuộc tính bằng cách đặt nó trong dấu ngoặc vuông phía trên phần tử mục tiêu:

[Obsolete("Use NewMethod instead")]
public void OldMethod() { }

[Serializable]
public class Person
{
    public string Name { get; set; }
}

Bạn có thể tạo thuộc tính tùy chỉnh bằng cách kế thừa từ Attribute:

public class AuthorAttribute : Attribute
{
    public string Name { get; }
    public AuthorAttribute(string name) => Name = name;
}

[Author("John")]
public class Calculator { }

Reflection giúp bạn kiểm tra kiểu và đọc thuộc tính trong lúc chạy bằng không gian tên System.Reflection:

Type type = typeof(Calculator);
var attr = type.GetCustomAttribute<AuthorAttribute>();
Console.WriteLine(attr.Name);  // John

Bạn cũng có thể tìm hiểu các phương thức, thuộc tính và gọi chúng một cách linh hoạt:

MethodInfo[] methods = type.GetMethods();
foreach (var method in methods)
    Console.WriteLine(method.Name);

Thuộc tính và reflection giúp nhiều framework hoạt động mạnh mẽ: các thư viện tuần tự hóa dùng chúng để kiểm soát đầu ra JSON, framework kiểm thử dùng chúng để tìm các phương thức kiểm thử, còn các vùng chứa dependency injection dùng chúng để tự động kết nối dịch vụ.

Thử thách

Dễ

Hãy xây dựng một hệ thống tìm plugin dùng các thuộc tính tùy chỉnh và reflection để tự động tìm, mô tả những lớp được đánh dấu là plugin. Cách này tương tự như cách các framework thực tế tìm thành phần, phương thức kiểm thử hoặc điểm cuối API trong thời gian chạy.

Bạn sẽ sắp xếp code trong ba tệp:

PluginAttribute.cs: Tạo một thuộc tính tùy chỉnh tên là PluginAttribute trong namespace PluginSystem. Thuộc tính này cần:
- Kế thừa từ Attribute
- Có hai thuộc tính chỉ đọc: Name (string) và Version (string)
- Nhận cả hai giá trị thông qua hàm khởi tạo
Plugins.cs: Tạo một số lớp plugin trong namespace PluginSystem. Một số lớp cần được trang trí bằng PluginAttribute, còn một lớp thì không:
- ImageProcessor - được đánh dấu bằng [Plugin("Image Processor", "1.0")]
- DataExporter - được đánh dấu bằng [Plugin("Data Exporter", "2.5")]
- HelperUtility - KHÔNG được đánh dấu bằng bất kỳ thuộc tính nào (đây chỉ là một lớp thông thường)
Các lớp có thể để trống, vì ta chỉ cần tìm siêu dữ liệu của chúng thông qua reflection.
Program.cs: Trong tệp chính, dùng reflection để tìm tất cả các lớp có PluginAttribute. Với mỗi plugin tìm được, hãy in thông tin của nó. Bạn cần:
- Lấy tất cả các kiểu từ assembly hiện tại
- Kiểm tra từng kiểu xem có PluginAttribute hay không
- Lấy và hiển thị các thuộc tính Name và Version của thuộc tính đó

Dùng System.Reflection để kiểm tra các kiểu và lấy các thuộc tính tùy chỉnh. Phương thức GetCustomAttribute<T>() trả về null nếu không có thuộc tính, vì vậy bạn có thể dùng cách này để lọc ra những lớp thực sự là plugin.

In từng plugin tìm được theo định dạng sau, mỗi plugin trên một dòng:

Plugin: {Name} (v{Version})

In các plugin theo thứ tự sau: ImageProcessor trước, rồi đến DataExporter. Lớp HelperUtility không nên xuất hiện trong đầu ra vì lớp này không có thuộc tính.

Đầu ra dự kiến:

Plugin: Image Processor (v1.0)
Plugin: Data Exporter (v2.5)

Thử thách này minh họa cách các framework dùng thuộc tính làm dấu hiệu và dùng reflection để tìm chúng. Kỹ thuật tương tự cũng là nền tảng cho các bộ chứa dependency injection, thư viện tuần tự hóa và framework kiểm thử!

Tự làm thử

using System;
using System.Reflection;
using PluginSystem;

class Program
{
    public static void Main(string[] args)
    {
        // TODO: Lấy tất cả các kiểu từ assembly hiện tại
        // Gợi ý: Dùng Assembly.GetExecutingAssembly().GetTypes()
        
        // TODO: Duyệt qua từng kiểu và kiểm tra xem kiểu đó có thuộc tính (attribute) PluginAttribute không
        // Gợi ý: Dùng type.GetCustomAttribute<PluginAttribute>()
        
        // TODO: Nếu thuộc tính tồn tại, in ra thông tin plugin theo định dạng:
        // Plugin: {Name} (v{Version})
        
    }
}