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

چرا نیاز به استفاده از AutoMapper داریم؟

در اولین قسمت از این دوره آموزشی در رابطه با اهمیت استفاده کردن از AutoMapper در قالب یک مثال صحبت خواهیم کرد. فرض کنید که دو کلاس با نام‌های Employee و EmployeeDTO شبیه به قسمت زیر در برنامه وجود دارند.

public class Employee

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

public class EmployeeDTO

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

اگر بخواهیم داده های موجود در کلاس Employee را به درون کلاس EmployeeDTO منتقل کنیم می بایست به صورت سنتی و دستی یک object از کلاس Employee را ایجاد کرده و سپس عملیات کپی کردن داده ها را به صورت دستی انجام بدهیم. پس از ایجاد کردن object مورد نظر از کلاس Employee باید یک object دیگر از کلاس EmployeeDTO را ایجاد کرده و داده های درون object اول را به درون این DTO شبیه به چیزی که در کد زیر می بینید کپی کنید.

namespace AutoMapperDemo

{

class Program

{

static void Main(string[] args)

{

Employee emp = new Employee();

emp.Name = "James";

emp.Salary = 20000;

emp.Address = "London";

emp.Department = "IT";

EmployeeDTO empDTO = new EmployeeDTO();

empDTO.Name = emp.Name;

empDTO.Salary = emp.Salary;

empDTO.Address = emp.Address;

empDTO.Department = emp.Department;

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

Console.ReadLine();

}

}

public class Employee

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

public class EmployeeDTO

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

}

این کار نیز کاملاً به درستی عمل می کند؛ اما فرض کنید که در زمان رشد برنامه property های جدیدی در این دو کلاس یعنی Employee و EmployeeDTO وارد می شوند. بنابراین نیاز است که به ازای property های جدیدتر عملیات کپی کردن داده ها از کلاس Employee به کلاس EmployeeDTO را باری دیگر به روز رسانی کرده و property های جدید را لحاظ کنید. این به این معنی است که نگاشت و یا map کردن داده ها از یک کلاس به کلاس دیگر به صورت دستی انجام شده و با اضافه شدن property های جدید می بایست کد جدید بنویسید. در پروژه های واقعی انجام چنین نگاشت ها و یا mapping هایی مکرراً رخ می‌دهند. در بسیاری از شرایط نیاز است که کلاس‌های مربوط به لایه‌های UIو یا Domain به کلاس های مربوط به لایه service نگاشت بشوند. اگر بخواهیم از روشی که تا به اینجای کار دیدیم این نگاشت را انجام بدهیم کار برنامه بسیار پیچیده خواهد شد. بنابراین باید به دنبال روشی ساده تر بود که این mapping را به صورت خودکار انجام بدهد و همانطور که از نام این ابزار مشخص است AutoMapper به صورت خودکار این mapping را انجام می دهد.

مفهوم AutoMapper چیست؟

همانطور که تا به اینجای کار متوجه شده اید AutoMapper نگاشت کننده و یا mapper می باشد که در بین دو کلاس قرار می گیرد. به عبارت دیگر AutoMapper یک object-object mapper است و property های مربوط به دو object مختلف را از object ورودی دریافت و به درون object خروجی کپی می کند.

علاوه بر این عملکرد ابتدایی قابلیت های جذاب دیگری نیز در AutoMapper وجود دارد که زحمت انجام دادن دستی نگاشت مربوط به property های دو object را برای برنامه نویس بسیار ساده می کند. البته این موضوع ها که تحت عنوان convention ها و یا پیکربندی های پیش فرض نیز شناخته می شوند زمانی کاربرد پیدا می کنند که نام property های مربوط به دو کلاس از قوانین خاصی که در ادامه از آنها صحبت می‌کنیم تبعیت کنند.

چگونه از AutoMapper استفاده کنیم؟

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

نصب کردن AutoMapper

در کل AutoMapper یک کتابخانه و یا library متن باز و یا open-source است که به راحتی در GitHub قابل استفاده است. ضمناً توصیه می‌کنیم که از بسته ی آموزش ویدئویی گیت هاب (GitHub) و مبانی استفاده کردن از آن استفاده کنید. برای نصب کردن این کتابخانه می توانید Package Manager Console را در ویژوال استودیو باز کنید و اقدام به نصب کردن AutoMapper کنید. این موضوع با دستور زیر انجام خواهد شد.

[console]
PM> Install-Package AutoMapper
[/console]

پس از نصب کردن AutoMapper خواهید دید که reference های مربوط به AutoMapper شبیه به چیزی که در تصویر زیر مشاهده می کنید به پروژه اضافه خواهند شد.


پس از نصب کردن AutoMapper در پروژه به راحتی می توانیم از آن به روش های مختلف استفاده کنیم. در این مقاله و مقاله های بعدی از این سری آموزشی در رابطه با روش های مختلف استفاده از AutoMapper صحبت خواهیم کرد و در قالب مثال هایی عملکرد AutoMapper را به شما توضیح خواهیم داد.

همانطور که گفتیم در ابتدا می خواهیم با همان مثال ساده از AutoMapper برای نگاشت کردن Employee و EmployeeDTO صحبت کنیم.

راه اندازی و پیکربندی کردن AutoMapper

به منظور استفاده کردن از AutoMapper برای انجام عملیات نگاشت property ها می بایست که از کلاس Mapper و یا MapperConfiguration و متد CreateMap استفاده کنیم. نکته مهم اینکه به ازای هر AppDomain می توانیم فقط یک object از MapperConfiguration داشته باشید و این object باید در زمان آغاز شدن برنامه instantiated بشود. در رابطه با اینگونه مفاهیم در بسته ی آموزش ویدئویی شی گرایی پیشرفته در سی شارپ صحبت کرده ایم. علاوه بر این می‌توانید از متد Mapper.Initialize نیز استفاده کنید. قسمت زیر جزئیات مربوط به این موضوع را نشان می دهد.

Mapper.Initialize(cfg =>

{

cfg.CreateMap<Employee, EmployeeDTO>();

});

نوع داده ای و یا type تعریف شده در قسمت سمت چپ source type است که به صورت TSource نشان داده شده است. در واقع در مثال ما این همان کلاس Employee خواهد بود و type نشان داده شده در قسمت راست destination type خواهد بود که به صورت TDestination نشان داده شده است. در مثال ما این کلاس EmployeeDTO خواهد بود. منظور از source type آن کلاسی است که می‌خواهید داده‌هایی را از آن بخوانید و منظور ازdestination type کلاسی است که می خواهید داده های خوانده شده را در آن قرار بدهید تصویر زیر نیز این موضوع را نشان می‌دهد.

برای استفاده کردن از AutoMapper در ابتدا می بایست یک namespace با نام AutoMapper را وارد کنیم. این موضوع و جزئیات مربوط به آن در کد زیر نشان داده شده اند.

using AutoMapper;

namespace AutoMapperDemo

{

class Program

{

static void Main(string[] args)

{

//Step1: Initialize the mapper

Mapper.Initialize(cfg =>

{

cfg.CreateMap<Employee, EmployeeDTO>();

});

//Step2: Create the source object

Employee emp = new Employee();

emp.Name = "James";

emp.Salary = 20000;

emp.Address = "London";

emp.Department = "IT";

//Step3: use the mapper to map the source and destination object

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

//OR

//var empDTO = Mapper.Map<EmployeeDTO>(emp);

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

Console.ReadLine();

}

}

public class Employee

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

public class EmployeeDTO

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

}

سوالی که ممکن است در این قسمت مطرح شود این است که اگر نام property های موجود در کلاس Employee و EmployeeDTO متفاوت باشند چه اتفاقی خواهد افتاد. بگذارید همین را در قالب یک مثال بررسی کنیم. فرض کنید که در کلاس EmployeeDTO پروپرتی های Name و Department را به FullName و Dept تغییر می دهیم و سپس برنامه را اجرا خواهیم کرد. این موضوع در کد زیر نشان داده شده است.

using AutoMapper;

namespace AutoMapperDemo

{

class Program

{

static void Main(string[] args)

{

//Step1: Initialize the mapper

Mapper.Initialize(cfg =>

{

cfg.CreateMap<Employee, EmployeeDTO>();

});

//Step2: Create the source object

Employee emp = new Employee();

emp.Name = "James";

emp.Salary = 20000;

emp.Address = "London";

emp.Department = "IT";

//Step3: use the mapper to map the source and destination object

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

//OR

//var empDTO = Mapper.Map<EmployeeDTO>(emp);

Console.WriteLine("Name:" + empDTO.FullName + ", Salary:" + empDTO.Salary + ", Address:" + empDTO.Address + ", Department:" + empDTO.Dept);

Console.ReadLine();

}

}

public class Employee

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

public class EmployeeDTO

{

public string FullName { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Dept { get; set; }

}

}

پس از اجرای برنامه می توان دید که property های Name و Department خالی هستند و این به این معنی است که این دو property توسط property های موجود در کلاس Employee مقدار نگرفته اند. نکته‌ای که در این قسمت مشخص است این است که اگر نام property ها در source type وdestination type متفاوت باشند AutoMapper نمی‌تواند به صورت خودکار مقادیر موجود در property ها را تشخیص داده و آنها را نگاشت کند.

بنابراین سوالی که مطرح است این است که در چنین شرایطی چه کاری باید انجام داد؟! برای حل کردن این مشکل می توانیم از ForMember استفاده کنیم. به عبارت دیگر می‌توانیم با استفاده از ForMember پروپرتی Name را به پروپرتی FullName و پروپرتی Department را به پروپرتی Dept نگاشت کنیم. این موضوع در قسمت زیر نشان داده شده است.

cfg.CreateMap<Employee, EmployeeDTO>()

.ForMember(dest => dest.FullName, act => act.MapFrom(src => src.Name))

.ForMember(dest => dest.Dept, act => act.MapFrom(src => src.Department));

});

در رابطه با ForMember و MapForm که گزینه های مربوط به پیکربندی AutoMapper می باشد در قسمت های بعدی به طور مفصل تر صحبت خواهیم کرد. کد زیر استفاده کردن از این موضوع را نشان می‌دهد.

using AutoMapper;

namespace AutoMapperDemo

{

class Program

{

static void Main(string[] args)

{

//Step1: Initialize the mapper

Mapper.Initialize(cfg =>

{

cfg.CreateMap<Employee, EmployeeDTO>()

.ForMember(dest => dest.FullName, act => act.MapFrom(src => src.Name))

.ForMember(dest => dest.Dept, act => act.MapFrom(src => src.Department));

});

//Step2: Create the source object

Employee emp = new Employee();

emp.Name = "James";

emp.Salary = 20000;

emp.Address = "London";

emp.Department = "IT";

//Step3: use the mapper to map the source and destination object

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

//OR

//var empDTO = Mapper.Map<EmployeeDTO>(emp);

Console.WriteLine("Name:" + empDTO.FullName + ", Salary:" + empDTO.Salary + ", Address:" + empDTO.Address + ", Department:" + empDTO.Dept);

Console.ReadLine();

}

}

public class Employee

{

public string Name { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Department { get; set; }

}

public class EmployeeDTO

{

public string FullName { get; set; }

public int Salary { get; set; }

public string Address { get; set; }

public string Dept { get; set; }

}

}

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

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