0
عضویت / ورود
يکشنبه، 2 دی 1403 ( جهش تولید با مشارکت مردم )

آموزش MVC

 
mtk_designer
mtk_designer
کاربر برنزی
تاریخ عضویت : آذر 1390 
تعداد پست ها : 157

روشی برای DeSerialize کردن QueryString به یک کلاس
پنج شنبه 28 آبان 1394  8:08 AM

چند روز پیش در حال استفاده از افزونه‌ی jQuery Bootgrid بودم که داده‌های خود را در قالب زیر به صورت کوئری استرینگ ارسال می‌کند.

1
current=1&rowCount=10&sort[sender]=asc&searchPhrase=&id=b0df282a-0d67-40e5-8558-c9e93b7befed

 

قبلا هم با کوئری استرینگ‌ها کار کرده‌ایم و نحوه دریافت آن را یاد گرفته‌ایم و میدانیم که اگر کلاس شما شامل پراپرتی‌های همنام با کلید‌های کوئری استرینگ باشد مستقیما در کلاس شما جا می‌گیرند؛ ولی من دوست داشتم که پراپرتی‌های کلاسم نام دلخواه من را داشته باشد و اجباری به استفاده از نام‌های کوئری استرینگ نداشته باشد. اصلا ممکن است افراد Back End یک سری کد نوشته‌اند و کلاسشان را هم ساخته‌اند و اصلا کاری با من ندارند که چطوری داده‌ها را و با چه اسامی از آن‌ها دریافت می‌کنم و فقط انتظار دارند که کلاس آن‌ها را با اطلاعات دریافتی پر کنم و ارسال کنم. اگر بخواهیم به طور دستی هر یک از کلید‌ها را چک کنیم، هم کدنویسی طولانی می‌شود و هم کد قابلیت استفاده مجدد ندارد. پس بهترین کار این است که یک کد با قابلیت استفاده مجدد بنویسیم.

 

دوست دارم چیزی شبیه به DeSerialize کردن فرمت json توسط کتابخانه Json.net داشته باشم؛ پس در اولین قدم یک attribute با مشخصات زیر می‌سازیم:
1
2
3
4
5
6
7
8
9
[AttributeUsage(AttributeTargets.Property,Inherited = true)]
public class RequestBodyField:Attribute
{
    public string Field;
    public RequestBodyField(string field)
    {
        this.Field = field;
    }
}
سپس در کلاس اصلی، ما این خصوصیت‌ها را در بالای propertyها تعریف کرده و با کلید‌های موجود در کوئری استرینگ برابر می‌کنیم:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
public class EmployeesRequestBody
{
    [RequestBodyField("current")]
    public  int CurrentPage { get; set; }
 
    [RequestBodyField("rowcount")]
    public int RowCount { get; set; }
 
    [RequestBodyField("searchPhrase")]
    public string SearchPhrase { get; set; }
 
    [RequestBodyField("sort")]
    public NameValueCollection SortDictionary { get; set; }
}
سپس کلاس زیر را می‌نویسیم که وظیفه دارد کلاس‌های از جنس بالا را با query string‌ها رسیده در درخواست مطابقت دهد:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public T GetFromQueryString<T>() where T : new()
       {
           var obj = new T();
 
           var queryString = HttpContext.Current.Request.QueryString;
           var queries = HttpUtility.ParseQueryString(queryString.ToString());
 
           var properties = typeof(T).GetProperties();
           foreach (var property in properties)
           {
               foreach (Attribute attribute in property.GetCustomAttributes(true))
               {
                   var requestBodyField = attribute as RequestBodyField;
                   if (requestBodyField == null) continue;
 
                   //get value of query string
                   var valueAsString = queries[requestBodyField.Field];
 
                   var converter = TypeDescriptor.GetConverter(property.PropertyType);
                   var value = converter.ConvertFrom(valueAsString);
 
                   if (value == null)
                       continue;
 
                   property.SetValue(obj, value, null);
               }
           }
           return obj;
       }
این متد یک تعریف کلاس را دریافت می‌کند. سپس رشته‌ی کوئری استرینگ موجود در بدنه درخواست را دریافت کرده و با استفاده از کد زیر اشیا را به صورت nameValueCollection دریافت می‌کنیم.
1
HttpContext.Current.Request.QueryString
نکته: همچنین متد httputility.parseQueryString یک رشته کوئری استرینگ دریافت می‌کند و کوئری استرینگ را به زوج نام و مقدار nameValueCollection تبدیل میکند.

 سپس در مرحله‌ی بعدی با استفاده از Reflection پراپرتی‌هایی را که دارای attribute تعریف شده هستند، پیدا می‌کنیم.
مقدار داده شده به attribute را در nameValueCollection بررسی می‌کنیم و در صورت موجود بودن، مقدار آن را می‌گیریم. از آنجا که این مقدار از نوع رشته است و ممکن است مقدار داخل آن عددی یا هر نوع دیگری باشد، باید آن را به نوع صحیح تبدیل کنیم که خطوط زیر کار تبدیل را انجام می‌دهند:
1
2
var converter = TypeDescriptor.GetConverter(property.PropertyType);
var value = converter.ConvertFrom(valueAsString);

در خط اول بر اساس نوع property کلاس، یک converter دریافت می‌کنیم و سپس مقدار ارسال شده را به آن می‌دهیم تا مقدار جدید را با نوع صحیح خود، دریافت کنیم.
سپس در صورتی که مقدار صحیح دریافت شود و برابر null نباشد، مقدار را در پراپرتی مربوطه جا می‌دهیم.

نکته‌ای که در اینجا نیاز به تلاش بیشتر دارد، کلید sort در کوئری استرینگ است. با نگاهی دقیق‌تر متوجه می‌شوید که خود کلید دو مقدار دارد که یکی از مقادیرش با کلید ترکیب شده است. این حالت روش ارسال آرایه‌ها با نام کلیدی متفاوت در کوئری استرینگ است. این حالت ارسال باعث می‌شود که گرید بتواند حالت multi sort را نیز پیاده سازی کند.
پس برای دریافت این نوع مقادیر کمی کد به آن اضافه می‌کنیم. برای دریافت مقادیر آرایه‌ای کد زیر را به سیستم اضافه می‌کنیم:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
if (valueAsString == null)
                    {
                        var keys = from key in queries.AllKeys where key.StartsWith(requestBodyField.Field) select key;
 
                        var collection = new NameValueCollection();
 
                        foreach (var key in keys)
                        {
                            var openBraketIndex = key.IndexOf("[", StringComparison.Ordinal);
                            var closeBraketIndex = key.IndexOf("]", StringComparison.Ordinal);
 
                            if (openBraketIndex < 0 || closeBraketIndex < 0)
                                throw new Exception("query string is corrupted.");
 
                            openBraketIndex++;
                            //get key in [...]
                            var fieldName = key.Substring(openBraketIndex, closeBraketIndex - openBraketIndex);
                            collection.Add(fieldName, queries[key] );
                        }
                        property.SetValue(obj, collection, null);
                        continue;
                    }
در صورتیکه شما کلید sort را درخواست کنید و از آنجا که کلید اصلی با نام [sort[sender است، مقدار null بازگشت می‌دهد. پس ما می‌توانیم به این مقدار شک کنیم که شاید این کلید حاوی مقدار مورد نظر ماست؛ پس این حالت را بررسی میکنیم.  برای بررسی، با استفاده از linq بررسی می‌کنیم که اگر کلید‌های namValueCollection با این کلید (در اینجا sort) آغاز می‌شوند، پس به احتمال زیاد همان حالت مورد نظر ما رخ داه است. پس اندیس‌های [ و ] را می‌گیریم و اگر اندیس هر دو بزرگتر از صفر بود مقدار ما بین آن را به عنوان کلید بیرون می‌کشیم و در یک namValueCollection جدید قرار می‌دهیم و در نهایت به پراپرتی پاس می‌دهیم. کد نهایی این متد به شکل زیر است:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
public T GetFromQueryString<T>() where T : new()
{
    var obj = new T();
    var properties = typeof(T).GetProperties();
 
    var queryString = HttpContext.Current.Request.QueryString;
    var queries = HttpUtility.ParseQueryString(queryString.ToString());
 
    foreach (var property in properties)
    {
        foreach (Attribute attribute in property.GetCustomAttributes(true))
        {
            var requestBodyField = attribute as RequestBodyField;
            if (requestBodyField == null) continue;
 
            //get value of query string
            var valueAsString = queries[requestBodyField.Field];
 
            if (valueAsString == null)
            {
                var keys = from key in queries.AllKeys where key.StartsWith(requestBodyField.Field) select key;
 
                var collection = new NameValueCollection();
 
                foreach (var key in keys)
                {
                    var openBraketIndex = key.IndexOf("[", StringComparison.Ordinal);
                    var closeBraketIndex = key.IndexOf("]", StringComparison.Ordinal);
 
                    if (openBraketIndex < 0 || closeBraketIndex < 0)
                        throw new Exception("query string is corrupted.");
 
                    openBraketIndex++;
                    //get key in [...]
                    var fieldName = key.Substring(openBraketIndex, closeBraketIndex - openBraketIndex);
                    collection.Add(fieldName, queries[key]);
                }
                property.SetValue(obj, collection, null);
                continue;
            }
 
            var converter = TypeDescriptor.GetConverter(property.PropertyType);
            var value = converter.ConvertFrom(valueAsString);
 
            if (value == null)
                continue;
 
            property.SetValue(obj, value, null);
        }
    }
    return obj;
}

حال  به صورت زیر این متد را صدا می‌زنیم:
1
2
3
4
public virtual ActionResult GetEmployees()
{
     var request = new Requests().GetFromQueryString<EmployeesRequestBody>();
}

 
تشکرات از این پست
دسترسی سریع به انجمن ها