آموزش کامل
AutoMapper قبلا در سایت dotnettips ارائه شده است. در این مقاله میخواهیم Mapping نوعهای مختلف بین Dto و Entityهای پروژه را توسط Reflection به صورت خودکار انجام دهیم. سورس کامل مثال را میتوانید در این
ریپازیتوری مشاهده کنید. با
ما همراه شوید.
در این روش ما یک کلاس جنریک را به نام BaseDto داریم که تمام Dtoهای ما برای نگاشت خودکار باید از آن ارث بری کنند. در مثال زیر کلاس PostDto لازم است به کلاس Post نگاشت شود. پس خواهیم داشت :
public class PostDto : BaseDto { public string Title public string Text public int CategoryId public string CategoryName //=> Category.Name }
کلاس PostDto خودش را به عنوان اولین پارامتر جنریک BaseDto معرفی میکند. به عنوان پارامتر دوم، باید کلاس Entity ایی که قرار است به آن نگاشت شود (Post) را معرفی کنیم. پارامتر سوم، نوع فیلد Id است که در اینجا خاصیت Id کلاسهای Post و PostDto ما، از نوع long است. نهایتا خواصی را که برای نگاشت لازم داریم، تعریف میکنیم مثل Title و… همچنین میتوانیم خواصی برای نگاشت با خواص Navigation Propertyهای Post هم تعریف کنیم؛ مانند CategoryName که به خاصیت Name از Category پست مربوطه اشاره میکند و AutoMapper به صورت هوشمندانه آنها را به هم نگاشت میکند.
تعریف کلاس جنریک BaseDto هم به نحو زیر است.
public abstract class BaseDto where TDto : class, new() where TEntity : BaseEntity, new() { [Display(Name = "ردیف")] public TKey Id public TEntity ToEntity() { return Mapper.Map(CastToDerivedClass(this)); } public TEntity ToEntity(TEntity entity) { return Mapper.Map(CastToDerivedClass(this), entity); } public static TDto FromEntity(TEntity model) { return Mapper.Map(model); } protected TDto CastToDerivedClass(BaseDto baseInstance) { return Mapper.Map(baseInstance); } }
نوع TDto به کلاس Dto ما اشاره میکند؛ مثلا PostDto نوع TEntity به کلاس Entity ما اشاره میکند؛ مثلا Post نوع TKey به نوع خاصیت Id اشاره میکند. شرط لازم برای نوع TEntity این است که از { var arguments = type.BaseType.GetGenericArguments(); return new { DtoType = arguments[0], EntityType = arguments[1] }; }).ToList(); foreach (var mappingType in mappingTypes) config.CreateMappingAndIgnoreUnmappedProperties(mappingType.EntityType, mappingType.DtoType); } public static void CreateMappingAndIgnoreUnmappedProperties(this IMapperConfigurationExpression config, Type entityType, Type dtoType) { var mappingExpression = config.CreateMap(entityType, dtoType).ReverseMap(); //Ignore mapping to any property of source (like Post.Categroy) that dose not contains in destination (like PostDto) //To prevent from wrong mapping. for example in mapping of "PostDto -> Post", automapper create a new instance for Category (with null catgeoryName) because we have CategoryName property that has null value foreach (var property in entityType.GetProperties()) { if (dtoType.GetProperty(property.Name) == null) mappingExpression.ForMember(property.Name, opt => opt.Ignore()); } } public static IEnumerable GetDtoTypes(params Assembly[] assemblies) { var allTypes = assemblies.SelectMany(a => a.ExportedTypes); var dtoTypes = allTypes.Where(type => type.IsClass !type.IsAbstract type.BaseType != null type.BaseType.IsGenericType (type.BaseType.GetGenericTypeDefinition() == typeof(BaseDto) || type.BaseType.GetGenericTypeDefinition() == typeof(BaseDto))); return dtoTypes; } }
عملیات با فراخوانی متد ایستا InitializeAutoMapper شروع میشود و باید این متد فقط یکبار در اجرای پروژه فراخوانی شود. (مثلا در سازنده کلاس Startup.cs)
public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; AutoMapperConfiguration.InitializeAutoMapper(); }
– درون این متد کانفیگ، Mapping نوعهای مختلف قابل نگاشت برای AutoMapper توسط Mapper.Initialize انجام میشود.
– متد ConfigureAutoMapperForDto متد دیگری را به همین نام، فراخوانی میکند؛ با این تفاوت که Assembly ورودی پروژه را توسط متد ()Assembly.GetEntryAssembly، یافته و به آن پاس میدهد.
– EntryAssembly به اسمبلی ای که به عنوان نقطه ورود برنامه است، اشاره میکند. در این سورس کد چون پروژه ما از نوع ASP.NET Core است، اسمبلی این پروژه به عنوان EntryAssmebly شناخته میشود؛ یعنی همان لایهای که کلاسهای Dto ما (مانند PostDto) داخل آن تعریف شدهاست. ما به این اسمبلی از این جهت نیاز داریم که میخواهیم توسط Reflection، تمام نوعهایی که از BaseDto ارث بری میکنند (مانند PostDto) را یافته و Mapping آنها را به AutoMapper معرفی و اعمال کنیم.
نکته : اگر در پروژه شما Dtoها در لایه/لایههای دیگری تعریف شدهاند باید اسمبلی آن لایهها را به آن پاس دهید.
در این مرحله توسط متد GetDtoTypes کار یافتن نوعهای Dto موجود در اسمبلی/اسمبلیهای مشخص شده انجام میشود.
public static IEnumerable GetDtoTypes(params Assembly[] assemblies) { var allTypes = assemblies.SelectMany(a => a.ExportedTypes); var dtoTypes = allTypes.Where(type => type.IsClass !type.IsAbstract type.BaseType != null type.BaseType.IsGenericType (type.BaseType.GetGenericTypeDefinition() == typeof(BaseDto) || type.BaseType.GetGenericTypeDefinition() == typeof(BaseDto))); return dtoTypes; }
در خط اول ابتدا تمامی نوعهای قابل دسترس از بیرون (ExportedTypes) از assemblyهای دریافتی واکشی میشود. سپس توسط Where، نوعهایی که کلاس بوده، abstract نیستند و از BaseDto ارث بری کردهاند، فیلتر شده و بازگردانده میشوند.
در ادامه، از لیست نوعهای Dto یافت شده، پارامترهای جنریک TDto و TEntity به ازای هر نوع استخراج میشوند.