برای ایجاد «خواص الحاقی» قبلا در سایت مطلب ایجاد «خواص الحاقی» تهیه شده‌است. در این مطلب قصد داریم راه حل ارائه شده‌ی در مطلب مذکور را با یک TypeDescriptionProvider سفارشی ترکیب کرده تا به صورت یکدست، از طریق TypeDescriptor بتوان به آن خواص نیز دسترسی داشته باشیم.
فرض کنید در یک سیستم Modular Monolith، نیاز جدیدی به دست شما رسیده است که به شرح زیر میباشد:
نیاز داریم در گریدی از صفحه‌ی X مربوط به «مؤلفه 1»، ستونی جدید را اضافه کنید و دیتای مربوط به این ستون، توسط «مؤلفه 2» مهیا خواهد شد.
شرایط زیر می‌تواند در سیستم حاکم باشد:
- قبلا «مؤلفه 2» ارجاعی را به «مؤلفه 1» داده است؛ لذا امکان ارجاع معکوس را در این حالت، نداریم.
- «مؤلفه 1» باید بتواند مستقل از «مؤلفه 2» نیز توزیع شده و کار کند؛ لذا این نیاز برای زمانی است که «مؤلفه 2» برای توزیع در Component Model ما وجود داشته باشد.
- نمی‌خواهیم در آینده برای نیازهای مشابه در همان صفحه‌ی X، تغییر جدیدی را در «مؤلفه 1» داشته باشیم (اضافه کردن خصوصیت مورد نظر به مدل نمایشی یا اصطلاحا ویو-مدل متناظر با گرید در در زمان طراحی، جواب مساله نمی‌باشد)
- میخواهیم به یک طراحی با Loose Coupling (اتصال سست و ضعیف، وابستگی ضعیف) دست پیدا کنیم.
راه حل چیست؟
با توجه به شرایط حاکم، بدون شک برای مهیا کردن دیتای ستون مذکور نمی‌توان به «مؤلفه 2» مستقیما ارجاع داده و «مؤلفه 1» را به «مؤلفه 2» وابسته کنیم. از طرفی چه بسا در نیازهای آتی نیز لازم باشد ستون جدید دیگری برای نمایش دیتای خاصی در گرید مذکور، اضافه شود. راه حل پیشنهادی، معکوس سازی این وابستگی میباشد. به عنوان مثال با استفاده از Expose کردن یک Interface توسط «مؤلفه 1» و پیاده سازی آن توسط سایر مؤلفه‌ها و استفاده از این پیاده سازی‌ها در زمان اجرا، می‌تواند راه حلی برای این معکوس سازی باشد.
نمودار UML بالا، نشان دهنده‌ی راه حل پیشنهادی میباشد.
در این حالت «مؤلفه 1» بدون آگاهی از سایر مؤلفه‌ها، همه‌ی پیاده سازی‌های IExtraColumnConenvtion را در زمان اجرا یافته و از آنها برای ایجاد ستون‌های جدید، استفاده خواهد کرد.
واسط مذکور به شکل زیر میباشد:
public interface IConvention
{
}
public interface IExtraColumnConvention<T> : IConvention
{
string Name { get; }
string Title { get; }
void Populate(IEnumerable<T> list);
} البته این واسط می‌تواند جزئیات بیشتری را هم شامل شود.
گام اول: طراحی TypeDescriptionProvider
در .NET به دو طریق میتوان به متادیتای یک Type دسترسی داشت:
- استفاده از API Reflection موجود در فضای نام System.Reflection
- کلاس TypeDescriptor
به طور کلی هدف از این کلاس در دات نت، ارائه اطلاعاتی در خصوص یک وهله از جمله: Attributeها، Propertyها، Eventهای آن و غیره، میباشد. هنگام استفاده از Reflection، اطلاعات بدست آمده از Type، به دلیل اینکه بعد از کامپایل نمی‌توانند تغییر کنند، لذا قابلیت توسعه پذیری را هم ندارند. در مقابل، با استفاده از کلاس TypeDescriptor این توسعه پذیری را برای وهله‌های مختلف میتوانید داشته باشید.
برای مهیا کردن متادیتای سفارشی (در اینجا اطلاعات مرتبط با خصوصیات الحاقی) برای TypeDescriptor، نیاز است یک TypeDescriptionProvider سفارشی را طراحی کنیم.
/// <summary>
/// Use this provider when you need access ExtraProperties with TypeDescriptor.GetProperties(instance)
/// </summary>
public class ExtraPropertyTypeDescriptionProvider<T> : TypeDescriptionProvider where T : class
{
private static readonly TypeDescriptionProvider Default =
TypeDescriptor.GetProvider(typeof(T));
public ExtraPropertyTypeDescriptionProvider() : base(Default)
{
}
public override ICustomTypeDescriptor GetTypeDescriptor(Type instanceType, object instance)
{
var descriptor = base.GetTypeDescriptor(instanceType, instance);
return instance == null ? descriptor : new ExtraPropertyCustomTypeDescriptor(descriptor, instance);
}
private sealed class ExtraPropertyCustomTypeDescriptor : CustomTypeDescriptor
{
//...
}
} در تکه کد بالا، ابتدا تامین کننده‌ی پیش‌فرض مرتبط با نوع جنریک مورد نظر را یافته و به عنوان تامین کننده‌ی پایه معرفی کرده‌ایم. سپس برای معرفی CustomTypeDescritpr باید متد GetTypeDescriptor را بازنویسی کنیم. در اینجا لازم است برای معرفی متادیتا مرتبط با یک نوع، یک پیاده سازی از واسط ICustomTypeDescriptor را ارائه کنیم:
private sealed class ExtraPropertyCustomTypeDescriptor : CustomTypeDescriptor
{
private readonly IEnumerable<ExtraPropertyDescriptor<T>> _instanceExtraProperties;
public ExtraPropertyCustomTypeDescriptor(ICustomTypeDescriptor defaultDescriptor, object instance)
: base(defaultDescriptor)
{
_instanceExtraProperties = instance.ExtraPropertyList<T>();
}
public override PropertyDescriptorCollection GetProperties(Attribute[] attributes)
{
var properties = new PropertyDescriptorCollection(null);
foreach (PropertyDescriptor property in base.GetProperties(attributes))
{
properties.Add(property);
}
foreach (var property in _instanceExtraProperties)
{
properties.Add(property);
}
return properties;
}
public override PropertyDescriptorCollection GetProperties()
{
return GetProperties(null);
}
} متد الحاقی ExtraPropertList به شکل زیر پیاده‌سازی شده‌است:
public static class ExtraProperties
{
//...
public static IEnumerable<ExtraPropertyDescriptor<T>> ExtraPropertyList<T>(this object instance) where T : class
{
if (!PropertyCache.TryGetValue(instance, out var properties))
throw new KeyNotFoundException($"key: {instance.GetType().Name} was not found in dictionary");
return properties.Select(p =>
new ExtraPropertyDescriptor<T>(p.PropertyName, p.PropertyValueFunc, p.SetPropertyValueFunc,
p.PropertyType,
p.Attributes));
}
} در اینجا از همان مکانیزم افزودن خواص الحاقی که در ابتدای مطلب اشاره شد، استفاده شده است.
ExtraPropertyDescriptor به شکل زیر طراحی شده است:
public sealed class ExtraPropertyDescriptor<T> : PropertyDescriptor where T : class
{
private readonly Func<object, object> _propertyValueFunc;
private readonly Action<object, object> _setPropertyValueFunc;
private readonly Type _propertyType;
public ExtraPropertyDescriptor(
string propertyName,
Func<object, object> propertyValueFunc,
Action<object, object> setPropertyValueFunc,
Type propertyType,
Attribute[] attributes) : base(propertyName, attributes)
{
_propertyValueFunc = propertyValueFunc;
_setPropertyValueFunc = setPropertyValueFunc;
_propertyType = propertyType;
}
public override void ResetValue(object component)
{
}
public override bool CanResetValue(object component) => true;
public override object GetValue(object component) => _propertyValueFunc(component);
public override void SetValue(object component, object value) => _setPropertyValueFunc(component, value);
public override bool ShouldSerializeValue(object component) => true;
public override Type ComponentType => typeof(T);
public override bool IsReadOnly => _setPropertyValueFunc == null;
public override Type PropertyType => _propertyType;
} [TypeDescriptionProvider(typeof(ExtraPropertyTypeDescriptionProvider<Person>))]
private class Person
{
public string Name { get; set; }
public string Family { get; set; }
} [Test]
public void Should_TypeDescriptor_GetProperties_Returns_ExtraProperties_And_PredefinedProperties()
{
//Arrange
var rabbal = new Person {Name = "GholamReza", Family = "Rabbal"};
const string propertyName = "Title";
const string propertyValue = "Software Engineer";
//Act
rabbal.ExtraProperty(propertyName, propertyValue);
var title = TypeDescriptor.GetProperties(rabbal).Find(propertyName, true);
//Assert
rabbal.ExtraProperty<string>(propertyName).ShouldBe(propertyValue);
title.ShouldNotBeNull();
title.GetValue(rabbal).ShouldBe(propertyValue);
} گام دوم: استفاده از IExtraColumnConvention برای نمایش ستون‌های الحاقی
فرض کنیم 3 پیاده‌سازی از واسط IExtraColumnConvention را توسط مؤلفه‌های مختلف، به شکل داشته باشیم:
public class Column4Convention : IExtraColumnConvention<Product>
{
public string Name => "Column4";
public string Title => "Column 4"
public void Populate(IEnumerable<Product> list)
{
//TODO: forEach on list and set ExtraProperty
// item.ExtraProperty(Name,value)
// item.ExtraProperty(Name,(obj)=> value)
// item.ExtraProperty(Name,(obj)=> value, (obj,value)=>)
}
}
public class Column2Convention : IExtraColumnConvention<Product>
{
public string Name => "Column2";
public string Title => "Column 2"
public void Populate(IEnumerable<Product> list)
{
//TODO: forEach on list and set ExtraProperty
}
}
public class Column3Convention : IExtraColumnConvention<Product>
{
public string Name => "Column3";
public string Title => "Column 3"
public void Populate(IEnumerable<Product> list)
{
//TODO: forEach on list and set ExtraProperty
}
} سپس این پیاده‌سازی‌ها از طریق مکانیزمی مانند معرفی آنها به یک IoC Container، توسط میزبان (مؤلفه 1) قابل دسترسی خواهد بود. در نهایت میزبان، قبل از نمایش محصولات، به شکل زیر عمل خواهد کرد:
var products = _productService.PagedList(page:1, pageSize:10);
var columns = _provider.GetServices<IExtraColumnConvention<Product>>();
foreach(var column in columns)
{
column.Populate(products);
} از این پس خصوصیات الحاقی اضافه شده‌ی توسط مؤلفه‌های دیگر نیز جزئی از خصوصیات محصولات بوده و از طریق TypeDescriptor.GetProperties قابل دسترسی میباشد. البته مشخص است راهکاری که در اینجا مطرح شد، وابستگی خیلی زیادی را به مکانیزم استفاده شده در لایه Presentation برای نمایش اطلاعات دارد.
نکته: امکان تهیه ContractResolver سفارشی برای کتابخانه JSON.NET به منظور Serialize خواص الحاقی اضافه شده در زمان اجرا، نیز وجود دارد.
تامین کننده طراحی شده‌ی در این مطلب، به زیرساخت DNTFrameworkCore اضافه شد.
