ویرگول
ورودثبت نام
پرووید
پرووید
پرووید
پرووید
خواندن ۷ دقیقه·۶ سال پیش

عدم شرکت یک Property خاص (Ignore کردن) در AutoMapper

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

به طور پیش فرض AutoMapper سعی می کند تمامی property های موجود در source type را به تمامی property های موجود در destination type البته با در نظر گرفتن یکسان بودن نام آنها نگاشت بکند. اگر می‌خواهیم برخی از property ها در مکانیزم نگاشت شرکت داده نشوند می توانیم از پروپرتی Ignore در AutoMapper استفاده کنیم.

نکته بسیار مهم اینکه اگر برخی از property ها در destination type موجود نباشند سپس AutoMapper هیچ exception خاصی را در زمان انجام عملیات نگاشت ایجاد نخواهد کرد. ضمناً توصیه می کنیم از بسته ی آموزش ویدئویی مدیریت خطاها در سی شارپ با Exception Handling استفاده کنید. اما در زمانی که از ValidateMapperConfiguration که در قسمت بعدی از آن صحبت می‌کنیم استفاده کنید یک exception ایجاد خواهد شد. در ادامه در رابطه با استفاده کردن از پروپرتی Ignore در AutoMapper صحبت خواهیم کرد.

استفاده از پروپرتی Ignore در AutoMapper

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

public class Employee

{

public int ID { get; set; }

public string Name { get; set; }

public string Address { get; set; }

}

public class EmployeeDTO

{

public int ID { get; set; }

public string Name { get; set; }

public string Address { get; set; }

}

حال فرض کنید به عنوان یک نیازمندی در این پروژه ما نیازی نداریم که پروپرتی Address را در مکانیزم نگاشت شرکت بدهیم. به عبارت دیگر می‌خواهیم در زمان نگاشت کردن Employee به EmployeeDTO از شرکت دادن پروپرتی Address صرف‌نظر کنیم. جالب است بدانید که واژه‌ی Ignore در زبان انگلیسی به معنی صرف نظر کردن است.

برای انجام این کار می بایست از متد Ignore استفاده کرده و پروپرتی Address را برای آن لحاظ کنیم. این موضوع در تصویر زیر نشان داده شده است.

Mapper.Initialize(config =>

{

config.CreateMap<Employee, EmployeeDTO>()

//Ignoring the Address property of the destination type

.ForMember(dest => dest.Address, act => act.Ignore());

});

همانطور که در تصویر بالا مشاهده می کنید ما از متد ForMember برای Ignore کردن پروپرتی Address در زمان انجام عملیات mapping استفاده کرده‌ایم. کدی که در قسمت زیر مشاهده می کنید دقیقاً همین موضوع را نشان می‌دهد.

using AutoMapper;

namespace AutoMapperDemo

{

class Program

{

static void Main(string[] args)

{

InitializeAutomapper();

Employee employee = new Employee()

{

ID = 101,

Name = "James",

Address = "Mumbai"

};

var empDTO = Mapper.Map<Employee, EmployeeDTO>(employee);

Console.WriteLine("After Mapping : Employee");

Console.WriteLine("ID : " + employee.ID + ", Name : " + employee.Name + ", Address : " + employee.Address);

Console.WriteLine();

Console.WriteLine("After Mapping : EmployeeDTO");

Console.WriteLine("ID : " + empDTO.ID + ", Name : " + empDTO.Name + ", Address : " + empDTO.Address);

Console.ReadLine();

}

static void InitializeAutomapper()

{

Mapper.Initialize(config =>

{

config.CreateMap<Employee, EmployeeDTO>()

//Ignoring the Address property of the destination type

.ForMember(dest => dest.Address, act => act.Ignore());

});

}

}

public class Employee

{

public int ID { get; set; }

public string Name { get; set; }

public string Address { get; set; }

}

public class EmployeeDTO

{

public int ID { get; set; }

public string Name { get; set; }

public string Address { get; set; }

}

}

با اجرا کردن برنامه خروجی مورد نظر را دریافت خواهید کرد.

حال اگر به پنجره output نگاه کنید مشاهده می کنید که مقدار درون پروپرتی Address خالی است. هر چند که پروپرتی Address در source type دارای مقدار معتبری بود. بنابراین با استفاده از AutoMapper و پروپرتی Ignore توانسته ایم که از شرکت داده شدن پروپرتی Address در مکانیزم mapping کاملاً صرف نظر کنیم.

نکته دیگر اینکه property صرف نظر شده می‌تواند هم در source type و هم در destination type باشد. نکته دیگر اینکه اگر قرار است تعداد زیادی از property ها را در مکانیزم نگاشت Ignore کنید بهتر است که یک کلاس شبیه به آنچه که در قسمت زیر مشاهده می کنید ایجاد کنید تا بتوانید property ها را بر اساس data attribute لحاظ شده بر روی آنها Ignore کنید. برای مثال در ابتدا یک attribute به نام NoMap را شبیه به تصویر زیر ایجاد کنید. ضمناً توصیه می‌کنیم از بسته ی آموزش ویدئویی Attribute ها در سی شارپ استفاده کنید.

public class NoMapAttribute : System.Attribute

{

}

دقت کنید که این attribute که NoMap نام دارد پس از این می تواند بر روی property های موجود در source type که قرار است در مکانیزم نگاشت شرکت داده نشوند لحاظ بشود. این موضوع در تصویر زیر نشان داده شده است.


public class Employee

{

public int ID { get; set; }

public string Name { get; set; }

[NoMap]

public string Address { get; set; }

[NoMap]

public string Email { get; set; }

}

در مرحله بعد یک کلاس ایجاد می کنید که property هایی که توسط این attribute یعنی همان NoMap تزیین شده‌اند را در عملیات نگاشت شرکت ندهد. در ابتدا System.ComponentModel را با استفاده از یک جمله using شبیه به تصویر زیر اضافه کنید.

using System.ComponentModel;

در مرحله بعدی از متد IgnoreNoMap در زمان تعریف کردن mapping استفاده کنید. این موضوع در تصویر زیر نشان داده شده است.


Mapper.Initialize(config =>

{

config.CreateMap<Employee, EmployeeDTO>()

.IgnoreNoMap();

});

ضمناً کدی که در قسمت زیر مشاهده می کنید نحوه انجام دادن این کار را نشان می دهد.


using AutoMapper;

using System.ComponentModel;

namespace AutoMapperDemo

{

class Program

{

static void Main(string[] args)

{

InitializeAutomapper();

Employee employee = new Employee()

{

ID = 101,

Name = "James",

Address = "Mumbai"

};

var empDTO = Mapper.Map<Employee, EmployeeDTO>(employee);

Console.WriteLine("After Mapping : Employee");

Console.WriteLine("ID : " + employee.ID + ", Name : " + employee.Name + ", Address : " + employee.Address + ", Email : "+employee.Email);

Console.WriteLine();

Console.WriteLine("After Mapping : EmployeeDTO");

Console.WriteLine("ID : " + empDTO.ID + ", Name : " + empDTO.Name + ", Address : " + empDTO.Address + ", Email : " + empDTO.Email);

Console.ReadLine();

}

static void InitializeAutomapper()

{

Mapper.Initialize(config =>

{

config.CreateMap<Employee, EmployeeDTO>()

.IgnoreNoMap();

});

}

}

public class NoMapAttribute : System.Attribute

{

}

public static class IgnoreNoMapExtensions

{

public static IMappingExpression<TSource, TDestination> IgnoreNoMap<TSource, TDestination>(

this IMappingExpression<TSource, TDestination> expression)

{

var sourceType = typeof(TSource);

foreach (var property in sourceType.GetProperties())

{

PropertyDescriptor descriptor = TypeDescriptor.GetProperties(sourceType)[property.Name];

NoMapAttribute attribute = (NoMapAttribute)descriptor.Attributes[typeof(NoMapAttribute)];

if (attribute != null)

expression.ForMember(property.Name, opt => opt.Ignore());

}

return expression;

}

}

public class Employee

{

public int ID { get; set; }

public string Name { get; set; }

[NoMap]

public string Address { get; set; }

[NoMap]

public string Email { get; set; }

}

public class EmployeeDTO

{

public int ID { get; set; }

public string Name { get; set; }

public string Address { get; set; }

public string Email { get; set; }

}

}

حال اگر برنامه را اجرا کنید خروجی را مشاهده خواهید کرد.

در مثال بالا دیدید که توانستیم یک custom attribute به نام NoMap را با ارث بری کردن از کلاس Attribute ایجاد کنیم. در رابطه با ارث بری توصیه می‌کنیم حتماً از بسته ی آموزش ویدئویی شی گرایی در سی شارپ استفاده کنید. پس از آن توانستیم property هایی که در source type وجود دارند و نمی خواهیم در مکانیزم نگاشت شرکت داده شوند را با این attribute یعنی NoMap تزیین کنیم.

سپس با استفاده از یک extension method به راحتی چک کردیم که آیا هر property دارای این attribute است یا خیر. اگر این property توسط این attribute تزئین شده باشد سپس به راحتی آن property را Ignore خواهیم کرد. در مقاله بعدی از این سری آموزشی که به عنوان آخرین درس از این آموزش در اختیار شما قرار خواهد گرفت در رابطه با UseValue و ResolveUsing و Null Substitution Using صحبت خواهیم کرد.

۱
۰
پرووید
پرووید
شاید از این پست‌ها خوشتان بیاید