本系列將和大家分享下ASP.NET Core Web 應用程式的一些基礎知識，本章主要簡單介紹下在ASP.NET Core中如何使用AutoMapper進行實體映射。 ...
本章主要簡單介紹下在ASP.NET Core中如何使用AutoMapper進行實體映射。在正式進入主題之前我們來看下幾個概念：
1、資料庫持久化對象PO（Persistent Object）：顧名思義，這個對象是用來將我們的數據持久化到資料庫，一般來說，持久化對象中的欄位會與資料庫中對應的 table 保持一致。
2、視圖對象VO（View Object）：視圖對象 VO 是面向前端用戶頁面的，一般會包含呈現給用戶的某個頁面/組件中所包含的所有數據欄位信息。
3、數據傳輸對象DTO（Data Transfer Object）：數據傳輸對象 DTO 一般用於前端展示層與後臺服務層之間的數據傳遞，以一種媒介的形式完成 資料庫持久化對象 與 視圖對象 之間的數據傳遞。
4、AutoMapper 是一個 OOM(Object-Object-Mapping) 組件，從名字上就可以看出來，這一系列的組件主要是為了幫助我們實現實體間的相互轉換，從而避免我們每次都採用手工編寫代碼的方式進行轉換。
接下來正式進入本章主題，我們直接通過一個使用案例來說明在ASP.NET Core中如何使用AutoMapper進行實體映射。
在之前的基礎上我們再添加一個web項目TianYa.DotNetShare.AutoMapperDemo用於演示AutoMapper的使用，首先來看一下我們的解決方案：
分別對上面的工程進行簡單的說明：
1、TianYa.DotNetShare.Model：為demo的實體層
2、TianYa.DotNetShare.Repository：為demo的倉儲層即數據訪問層
3、TianYa.DotNetShare.Service：為demo的服務層即業務邏輯層
4、TianYa.DotNetShare.SharpCore：為demo的Sharp核心類庫
5、TianYa.DotNetShare.AutoMapperDemo：為demo的web層項目，MVC框架
約定：
1、公共的類庫，我們選擇.NET Standard 2.0作為目標框架，可與Framework進行共用。
2、本demo的web項目為ASP.NET Core Web 應用程式（.NET Core 2.2） MVC框架。
除了上面提到的這些，別的在之前的文章中就已經詳細的介紹過了，本demo沒有用到就不做過多的闡述了。
一、實體層
為了演示接下來我們創建一些實體，如下圖所示：
1、學生類資料庫持久化對象Student（PO）
using System; using System.Collections.Generic; using System.Text; namespace TianYa.DotNetShare.Model { /// <summary> /// 學生類 /// </summary> public class Student { /// <summary> /// 唯一ID /// </summary> public string UUID { get; set; } = Guid.NewGuid().ToString().Replace("-", ""); /// <summary> /// 學號 /// </summary> public string StuNo { get; set; } /// <summary> /// 姓名 /// </summary> public string Name { get; set; } /// <summary> /// 年齡 /// </summary> public int Age { get; set; } /// <summary> /// 性別 /// </summary> public string Sex { get; set; } /// <summary> /// 出生日期 /// </summary> public DateTime Birthday { get; set; } /// <summary> /// 年級編號 /// </summary> public short GradeId { get; set; } /// <summary> /// 是否草稿 /// </summary> public bool IsDraft { get; set; } = false; /// <summary> /// 學生髮布的成果 /// </summary> public virtual IList<TecModel> Tecs { get; set; } } }
2、學生類視圖對象V_Student（VO）
using System; using System.Collections.Generic; using System.Text; namespace TianYa.DotNetShare.Model.ViewModel { /// <summary> /// 學生視圖對象 /// </summary> public class V_Student { /// <summary> /// 唯一ID /// </summary> public string UUID { get; set; } /// <summary> /// 學號 /// </summary> public string StuNo { get; set; } /// <summary> /// 姓名 /// </summary> public string Name { get; set; } /// <summary> /// 年齡 /// </summary> public int Age { get; set; } /// <summary> /// 性別 /// </summary> public string Sex { get; set; } /// <summary> /// 出生日期 /// </summary> public string Birthday { get; set; } /// <summary> /// 年級編號 /// </summary> public short GradeId { get; set; } /// <summary> /// 年級名稱 /// </summary> public string GradeName => GradeId == 1 ? "大一" : "未知"; /// <summary> /// 發佈的成果數量 /// </summary> public short TecCounts { get; set; } /// <summary> /// 操作 /// </summary> public string Operate { get; set; } } }
3、用於配合演示的成果實體
using System; using System.Collections.Generic; using System.Text; namespace TianYa.DotNetShare.Model { /// <summary> /// 成果 /// </summary> public class TecModel { /// <summary> /// 唯一ID /// </summary> public string UUID { get; set; } = Guid.NewGuid().ToString().Replace("-", ""); /// <summary> /// 成果名稱 /// </summary> public string TecName { get; set; } } }
二、服務層
本demo的服務層需要引用以下幾個程式集：
1、我們的實體層TianYa.DotNetShare.Model
2、我們的倉儲層TianYa.DotNetShare.Repository
3、需要從NuGet上添加AutoMapper
約定：
1、服務層介面都以“I”開頭，以“Service”結尾。服務層實現都以“Service”結尾。
為了演示，我們新建一個Student的服務層介面IStudentService.cs
using System; using System.Collections.Generic; using System.Text; using TianYa.DotNetShare.Model; using TianYa.DotNetShare.Model.ViewModel; namespace TianYa.DotNetShare.Service { /// <summary> /// 學生類服務層介面 /// </summary> public interface IStudentService { /// <summary> /// 根據學號獲取學生信息 /// </summary> /// <param name="stuNo">學號</param> /// <returns>學生信息</returns> Student GetStuInfo(string stuNo); /// <summary> /// 獲取學生視圖對象 /// </summary> /// <param name="stu">學生資料庫持久化對象</param> /// <returns>學生視圖對象</returns> V_Student GetVStuInfo(Student stu); } }
接著我們同樣在Impl中新建一個Student的服務層實現StudentService.cs，該類實現了IStudentService介面
using System; using System.Collections.Generic; using System.Text; using TianYa.DotNetShare.Model; using TianYa.DotNetShare.Model.ViewModel; using TianYa.DotNetShare.Repository; using AutoMapper; namespace TianYa.DotNetShare.Service.Impl { /// <summary> /// 學生類服務層 /// </summary> public class StudentService : IStudentService { /// <summary> /// 定義倉儲層學生抽象類對象 /// </summary> protected IStudentRepository StuRepository; /// <summary> /// 實體自動映射 /// </summary> protected readonly IMapper _mapper; /// <summary> /// 空構造函數 /// </summary> public StudentService() { } /// <summary> /// 構造函數 /// </summary> /// <param name="stuRepository">倉儲層學生抽象類對象</param> /// <param name="mapper">實體自動映射</param> public StudentService(IStudentRepository stuRepository, IMapper mapper) { this.StuRepository = stuRepository; _mapper = mapper; } /// <summary> /// 根據學號獲取學生信息 /// </summary> /// <param name="stuNo">學號</param> /// <returns>學生信息</returns> public Student GetStuInfo(string stuNo) { var stu = StuRepository.GetStuInfo(stuNo); return stu; } /// <summary> /// 獲取學生視圖對象 /// </summary> /// <param name="stu">學生資料庫持久化對象</param> /// <returns>學生視圖對象</returns> public V_Student GetVStuInfo(Student stu) { return _mapper.Map<Student, V_Student>(stu); } } }
最後添加一個實體映射配置類MyProfile，該類繼承於AutoMapper的Profile類，在配置類MyProfile的無參構造函數中通過泛型的 CreateMap 方法寫映射規則。
using System; using System.Collections.Generic; using TianYa.DotNetShare.Model; using TianYa.DotNetShare.Model.ViewModel; namespace TianYa.DotNetShare.Service.AutoMapperConfig { /// <summary> /// 實體映射配置類 /// </summary> public class MyProfile : AutoMapper.Profile { /// <summary> /// 構造函數 /// </summary> public MyProfile() { // 配置 mapping 規則 CreateMap<Student, V_Student>(); } } }
服務層就這樣了，接下來就是重頭戲了，如果有多個實體映射配置類，那麼要如何實現一次性依賴註入呢，這個我們在Sharp核心類庫中去統一處理。
三、Sharp核心類庫
在之前項目的基礎上，我們還需要從NuGet上引用以下2個程式集用於實現實體自動映射：
//AutoMapper基礎組件 AutoMapper //AutoMapper依賴註入輔助組件 AutoMapper.Extensions.Microsoft.DependencyInjection
1、首先我們添加一個反射幫助類ReflectionHelper
using System; using System.Collections.Generic; using System.Reflection; using System.Linq; using System.Runtime.Loader; using Microsoft.Extensions.DependencyModel; namespace TianYa.DotNetShare.SharpCore { /// <summary> /// 反射幫助類 /// </summary> public static class ReflectionHelper { /// <summary> /// 獲取類以及類實現的介面鍵值對 /// </summary> /// <param name="assemblyName">程式集名稱</param> /// <returns>類以及類實現的介面鍵值對</returns> public static Dictionary<Type, List<Type>> GetClassInterfacePairs(this string assemblyName) { //存儲 實現類 以及 對應介面 Dictionary<Type, List<Type>> dic = new Dictionary<Type, List<Type>>(); Assembly assembly = GetAssembly(assemblyName); if (assembly != null) { Type[] types = assembly.GetTypes(); foreach (var item in types.AsEnumerable().Where(x => !x.IsAbstract && !x.IsInterface && !x.IsGenericType)) { dic.Add(item, item.GetInterfaces().Where(x => !x.IsGenericType).ToList()); } } return dic; } /// <summary> /// 獲取指定的程式集 /// </summary> /// <param name="assemblyName">程式集名稱</param> /// <returns>程式集</returns> public static Assembly GetAssembly(this string assemblyName) { return GetAllAssemblies().FirstOrDefault(assembly => assembly.FullName.Contains(assemblyName)); } /// <summary> /// 獲取所有的程式集 /// </summary> /// <returns>程式集集合</returns> private static List<Assembly> GetAllAssemblies() { var list = new List<Assembly>(); var deps = DependencyContext.Default; var libs = deps.CompileLibraries.Where(lib => !lib.Serviceable && lib.Type != "package");//排除所有的系統程式集、Nuget下載包 foreach (var lib in libs) { try { var assembly = AssemblyLoadContext.Default.LoadFromAssemblyName(new AssemblyName(lib.Name)); list.Add(assembly); } catch (Exception) { // ignored } } return list; } } }
2、接著我們添加一個AutoMapper擴展類
using Microsoft.Extensions.DependencyInjection; using System; using System.Collections.Generic; using System.Linq; using AutoMapper; namespace TianYa.DotNetShare.SharpCore.Extensions { /// <summary> /// AutoMapper擴展類 /// </summary> public static class AutoMapperExtensions { /// <summary> /// 通過反射批量註入AutoMapper映射規則 /// </summary> /// <param name="services">服務</param> /// <param name="assemblyNames">程式集數組 如:["TianYa.DotNetShare.Repository","TianYa.DotNetShare.Service"]，無需寫dll</param> public static void RegisterAutoMapperProfiles(this IServiceCollection services, params string[] assemblyNames) { foreach (string assemblyName in assemblyNames) { var listProfile = new List<Type>(); var parentType = typeof(Profile); //所有繼承於Profile的類 var types = assemblyName.GetAssembly().GetTypes() .Where(item => item.BaseType != null && item.BaseType.Name == parentType.Name); if (types != null && types.Count() > 0) { listProfile.AddRange(types); } if (listProfile.Count() > 0) { //映射規則註入 services.AddAutoMapper(listProfile.ToArray()); } } } /// <summary> /// 通過反射批量註入AutoMapper映射規則 /// </summary> /// <param name="services">服務</param> /// <param name="profileTypes">Profile的子類</param> public static void RegisterAutoMapperProfiles(this IServiceCollection services, params Type[] profileTypes) { var listProfile = new List<Type>(); var parentType = typeof(Profile); foreach (var item in profileTypes) { if (item.BaseType != null && item.BaseType.Name == parentType.Name) { listProfile.Add(item); } } if (listProfile.Count() > 0) { //映射規則註入 services.AddAutoMapper(listProfile.ToArray()); } } } }
不難看出，該類實現AutoMapper一次性註入的核心思想是：通過反射獲取程式集中繼承了AutoMapper.Profile類的所有子類，然後利用AutoMapper依賴註入輔助組件進行批量依賴註入。
四、Web層
本demo的web項目需要引用以下幾個程式集：
1、TianYa.DotNetShare.Model 我們的實體層
2、TianYa.DotNetShare.Service 我們的服務層
3、TianYa.DotNetShare.SharpCore 我們的Sharp核心類庫
到了這裡我們所有的工作都已經準備好了，接下來就是開始做註入工作了。
打開我們的Startup.cs文件進行註入工作：
using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using TianYa.DotNetShare.SharpCore.Extensions; using TianYa.DotNetShare.Service.AutoMapperConfig; namespace TianYa.DotNetShare.AutoMapperDemo { public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; } public IConfiguration Configuration { get; } // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.Configure<CookiePolicyOptions>(options => { // This lambda determines whether user consent for non-essential cookies is needed for a given request. options.CheckConsentNeeded = context => true; options.MinimumSameSitePolicy = SameSiteMode.None; }); services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2); //DI依賴註入，批量註入指定的程式集 services.RegisterTianYaSharpService(new string[] { "TianYa.DotNetShare.Repository", "TianYa.DotNetShare.Service" }); //註入AutoMapper映射規則 //services.RegisterAutoMapperProfiles(typeof(MyProfile)); //如果MyProfile寫在Web項目中可通過該方式註入AutoMapper映射規則 services.RegisterAutoMapperProfiles(new string[] { "TianYa.DotNetShare.Service" }); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IHostingEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } else { app.UseExceptionHandler("/Home/Error"); } app.UseStaticFiles(); app.UseCookiePolicy(); app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); } } }
其中用來實現批量依賴註入的只要簡單的幾句話就搞定了，如下所示：
//DI依賴註入，批量註入指定的程式集 services.RegisterTianYaSharpService(new string[] { "TianYa.DotNetShare.Repository", "TianYa.DotNetShare.Service" }); //註入AutoMapper映射規則 //services.RegisterAutoMapperProfiles(typeof(MyProfile)); //如果MyProfile寫在Web項目中可通過該方式註入AutoMapper映射規則 services.RegisterAutoMapperProfiles(new string[] { "TianYa.DotNetShare.Service" });
Sharp核心類庫在底層實現了批量註入的邏輯，程式集的註入必須按照先後順序進行，先進行倉儲層註入然後再進行服務層註入。
接下來我們來看看控制器裡面怎麼弄：
using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using AutoMapper; using TianYa.DotNetShare.AutoMapperDemo.Models; using TianYa.DotNetShare.Model; using TianYa.DotNetShare.Model.ViewModel; using TianYa.DotNetShare.Service; namespace TianYa.DotNetShare.AutoMapperDemo.Controllers { public class HomeController : Controller { /// <summary> /// 自動映射 /// </summary> private readonly IMapper _mapper; /// <summary> /// 定義服務層學生抽象類對象 /// </summary> protected IStudentService StuService; /// <summary> /// 構造函數註入 /// </summary> public HomeController(IMapper mapper, IStudentService stuService) { _mapper = mapper; StuService = stuService; } public IActionResult Index() { var model = new Student { StuNo = "100001", Name = "張三", Age = 18, Sex = "男", Birthday = DateTime.Now.AddYears(-18), GradeId = 1, Tecs = new List<TecModel> { new TecModel { TecName = "成果名稱" } } }; var v_model = _mapper.Map<Student, V_Student>(model); var v_model_s = StuService.GetVStuInfo(model); return View(); } public IActionResult Privacy() { return View(); } [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)] public IActionResult Error() { return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier }); } } }
到這裡我們基礎的自動實體映射就算是處理好了，最後我們調試起來看下結果：
小結：
1、在該例子中我們實現了從Student（PO） 到 V_Student（VO）的實體映射。
2、可以發現在服務層中也註入成功了，說明AutoMapper依賴註入輔助組件的註入是全局的。
3、AutoMapper 預設是通過匹配欄位名稱和類型進行自動匹配，所以如果你進行轉換的兩個類中的某些欄位名稱不一樣，這時我們就需要進行手動的編寫轉換規則。
4、在AutoMapper中，我們可以通過 ForMember 方法對映射規則做進一步的加工。
未完待續......
參考博文：https://mp.weixin.qq.com/s/DyBEQbWQ0-IRP1Pkl_9RbA
版權聲明：如有雷同純屬巧合，如有侵權請及時聯繫本人修改，謝謝！！！
