object-to-object mapping

مقدمه

انواع کتابخانه‌های نگاشت

Mapster

شیوه دریافت

1. یکی از طریق package manager console که عبارت زیر را داخل آن تایپ می‌کنیم:

   Install-package mapster
2. یکی از طریق آدرس زیر:

   Tools > NuGet package manager > Manage NuGet packages for solution

   و بعد عبارت Mapster را در تب browse صفحه بازشده، جستجو می‌کنیم.
   تا زمان نوشتن این مطلب mapster تعداد 347 هزار بار در پروژه‌های مختلف دانلود و نصب‌شده است.

شیوه استفاده

1. در حالت ارث‌بری: طبق کد انجام می‌شود.

    
           public class Person
           {
               public string Firstname { get; set; }
               public string Lastname { get; set; }
               public int Age { get; set; }
           }
   
           public class LegalInformation : Person
           {
               public bool IsLegalAge
               {
                   get { return Age > 18; }
               }
           }
           
           static void SimpleMapping()
           {
               var person = new Person()
               {
                   Firstname = "joe",
                   Lastname = "smith",
                   Age = 30
               };
   
               var personWithLegalInfo = person.Adapt<Person, LegalInformation>();
               Console.WriteLine(string.Format("Firstname: {0}, Lastname: {1}, Age: {2}, is legal Age: {3}", personWithLegalInfo.Firstname, personWithLegalInfo.Lastname, personWithLegalInfo.Age, personWithLegalInfo.IsLegalAge));
           }
   

2. در حالت ویژگی‌های همنام:

   • در حالتی که هردو آبجکت از یک نوع کلاس باشند: برای clone کردن یک آبجکت بدون ارث‌بری از ICloneable مناسب است.
   • آبجکت با نوع کلاس‌های متفاوت با ویژگی‌های هم نام و هم نوع: جدای از نوع ویژگی، اگر کوچک و بزرگ بودن نام ویژگی را رعایت کرده باشیم، نگاشت صورت می‌گیرد. اگر نام ویژگی‌ها کاملاً مشابه بوده ولی نوع داده‌های متفاوت داشته باشند، با اکسپشن مواجه می‌شویم و باید با استفاده از پیکره‌بندی (Config) مناسب از بروز خطا جلوگیری کنیم.
3. با پیکره‌بندی: استفاده از Mapster با تعریف پیکره‌بندی از دو راه صورت می‌گیرد:

   • استفاده از یک آبجکت TypeAdapterConfig که تنظیمات مناسب را در اختیار Mapster قرار می‌دهد.

             static void ConfigMapping()
                 {
                     var person = new Person()
                     {
                         Firstname = "joe",
                         Lastname = "smith",
                         Age = 30
                     };
         
                     var personWithLegalInfo = person.Adapt<person,>(
                         new TypeAdapterConfig()
                         .Default
                         .IgnoreMember((member, side) => (member.Name == "Age" && side == MemberSide.Source))
                         .EnableNonPublicMembers(true)
                         .MaxDepth(1)
                         .IgnoreNullValues(true)
                         .Config
                         );
         
                     Console.WriteLine(string.Format("Firstname: {0}, Lastname: {1}, Age: {2}, is legal Age: {3}", personWithLegalInfo.Firstname, personWithLegalInfo.Lastname, personWithLegalInfo.Age, personWithLegalInfo.IsLegalAge));
                 }
     </person,>

   • دیگری استفاده از دو صفت (Attribute) زیر در کلاس مدل:

     • [AdaptIgnore] همان‌طور که از نام صفت پیداست، در زمان نگاشت ویژگی موردنظر را نگاشت نمی‌کند.
     • [(AdaptMember(name]: این صفت یک String قبول می‌کند که نام ویژگی هدف در زمان نگاشت شدن اشاره دارد. به عبارتی با ویژگی هم نام خود نگاشت نمی‌شود و در کلاس هدف ویژگی با این عنوان را پیدا می‌کند.

Auto mapper

شیوه دریافت

شیوه استفاده

Mapper.Initialize(cfg => cfg.CreateMap<person,>());

        var person = new Person()
            {
                Firstname = "joe",
                Lastname = "smith",
                Age = 30
            };

            var config = new MapperConfiguration(cfg =>
            {
                cfg.ShouldMapProperty = info => info.GetMethod.IsPublic;
                cfg.CreateMap<person,>().MaxDepth(2)
                    .ForMember(destination => destination.Age, option => option.Condition(source => source.Age < 5)) //will be mapped if source age is less than 5
                    ;
            });

            var myMapper = new Mapper(config);

             var personWithLegalInfo = myMapper.DefaultContext.Mapper.Map<LegalInformation>(person);

            Console.WriteLine(string.Format("Firstname: {0}, Lastname: {1}, Age: {2}, is legal Age: {3}", personWithLegalInfo.Firstname, personWithLegalInfo.Lastname, personWithLegalInfo.Age, personWithLegalInfo.IsLegalAge));

1. در حالت ارث‌بری: طبق روال انجام می‌شود.

            static void SimpleMapping()
           {
               var person = new Person()
               {
                   Firstname = "joe",
                   Lastname = "smith",
                   Age = 30
               };
   
               var personWithLegalInfo = person.Adapt<Person, LegalInformation>();
               Console.WriteLine(string.Format("Firstname: {0}, Lastname: {1}, Age: {2}, is legal Age: {3}", personWithLegalInfo.Firstname, personWithLegalInfo.Lastname, personWithLegalInfo.Age, personWithLegalInfo.IsLegalAge));
           }

2. در حالت ویژگی‌های همنام:

   • در حالتی که هردو آبجکت از یک نوع کلاس باشند : برای clone کردن یک آبجکت بدون ارث‌بری از ICloneable مناسب است.
   • آبجکت با نوع کلاس‌های متفاوت با ویژگی‌های هم نام و هم نوع: جدای از نوع ویژگی، اگر کوچک و بزرگ بودن نام ویژگی را رعایت کرده باشیم، نگاشت صورت می‌گیرد. اگر نام ویژگی‌ها کاملاً مشابه بوده ولی نوع داده‌های متفاوت داشته باشند با اکسپشن مواجه می‌شویم و باید با استفاده از پیکره‌بندی مناسب از بروز خطا جلوگیری کنیم.
   • با پیکره‌بندی: AutoMapper از همان ابتدا به پیکره‌بندی احتیاج دارد که در کد زیر برخی از موارد استفاده آن را می‌بینیم. برای مثال‌های بیشتر به لینک منبع مراجعه کنید.

           static void ConfigMappingAutoMapper()
           {
               var person = new Person()
               {
                   Firstname = "joe",
                   Lastname = "smith",
                   Age = 30
               };
   
               var config = new MapperConfiguration(cfg =>
               {
                   cfg.ShouldMapProperty = info => info.GetMethod.IsPublic;
                   cfg.CreateMap<person,>().MaxDepth(2)
                       .ForMember(destination => destination.Age, option => option.Condition(source => source.Age < 5)) //will be mapped if source age is less than 5
                       ;
               });
   
               var myMapper = new Mapper(config);
   
                var personWithLegalInfo = myMapper.DefaultContext.Mapper.Map<LegalInformation>(person);
   
               Console.WriteLine(string.Format("Firstname: {0}, Lastname: {1}, Age: {2}, is legal Age: {3}", personWithLegalInfo.Firstname, personWithLegalInfo.Lastname, personWithLegalInfo.Age, personWithLegalInfo.IsLegalAge));
           }
   

مقایسه

1. AutoMapper برای استفاده به پیکره‌بندی پیچیده‌تری نیاز دارد.
2. گفته‌شده که mapster تا 2.5 برابر سریع‌تر از automapper و هر Mapper شناخته‌شده دیگری است.
3. حجم فایل mapster، 232kb و حجم فایل autoMapper، 335kb است.
4. Automapper به‌صورت پیش‌فرض فقط ویژگی‌های پابلیک را نگاشت می‌کند و اگر بخواهیم ویژگی با سایر accessor ها را نگاشت کند، باید در پیکره‌بندی تنظیمات مناسب را انجام دهیم.
5. در مقایسه کارایی (Performance) برای نگاشت کردن یک نوع کلاس و در یک متد، Mapster تا 44% سرعت بالاتر دارد؛ اما از CPU به مقدار بسیار کمی، بیشتر کار می‌کشد.
6. در مقایسه کارایی برای نگاشت کردن یک نوع کلاس و در یک متد، Automapper کندتر عمل می‌کند اما لود آن بر CPU به مقدار بسیار اندک، کمتر است.

کارایی Mapster:

کارایی AutoMapper:

نتیجه

منابع