ASP.NET Core Web 應用程序系列（五）- 在ASP.NET Core中使用AutoMapper進行實體映射

時間  2019-12-01
標籤 asp.net asp core web 應用 程序 系列 使用 automapper 進行 實體 映射 欄目 ASP 简体版
原文   原文鏈接

本章主要簡單介紹下在ASP.NET Core中如何使用AutoMapper進行實體映射。在正式進入主題以前咱們來看下幾個概念：前端

一、數據庫持久化對象PO（Persistent Object）：顧名思義，這個對象是用來將咱們的數據持久化到數據庫，通常來講，持久化對象中的字段會與數據庫中對應的 table 保持一致。web

二、視圖對象VO（View Object）：視圖對象 VO 是面向前端用戶頁面的，通常會包含呈現給用戶的某個頁面/組件中所包含的全部數據字段信息。數據庫

三、數據傳輸對象DTO（Data Transfer Object）：數據傳輸對象 DTO 通常用於前端展現層與後臺服務層之間的數據傳遞，以一種媒介的形式完成 數據庫持久化對象 與 視圖對象 之間的數據傳遞。數組

四、AutoMapper 是一個 OOM(Object-Object-Mapping) 組件，從名字上就能夠看出來，這一系列的組件主要是爲了幫助咱們實現實體間的相互轉換，從而避免咱們每次都採用手工編寫代碼的方式進行轉換。cookie

 

接下來正式進入本章主題，咱們直接經過一個使用案例來講明在ASP.NET Core中如何使用AutoMapper進行實體映射。app

在以前的基礎上咱們再添加一個web項目TianYa.DotNetShare.AutoMapperDemo用於演示AutoMapper的使用，首先來看一下咱們的解決方案：框架

分別對上面的工程進行簡單的說明：函數

一、TianYa.DotNetShare.Model：爲demo的實體層ui

二、TianYa.DotNetShare.Repository：爲demo的倉儲層即數據訪問層this

三、TianYa.DotNetShare.Service：爲demo的服務層即業務邏輯層

四、TianYa.DotNetShare.SharpCore：爲demo的Sharp核心類庫

五、TianYa.DotNetShare.AutoMapperDemo：爲demo的web層項目，MVC框架

約定：

一、公共的類庫，咱們選擇.NET Standard 2.0做爲目標框架，可與Framework進行共享。

二、本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; }
    }
}

二、學生類視圖對象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; }
    }
}

三、用於配合演示的成果實體

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; }
    }
}

2、服務層

 本demo的服務層須要引用如下幾個程序集：

一、咱們的實體層TianYa.DotNetShare.Model

二、咱們的倉儲層TianYa.DotNetShare.Repository

三、須要從NuGet上添加AutoMapper

約定：

一、服務層接口都以「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核心類庫中去統一處理。

3、Sharp核心類庫

 在以前項目的基礎上，咱們還須要從NuGet上引用如下2個程序集用於實現實體自動映射：

//AutoMapper基礎組件
AutoMapper
//AutoMapper依賴注入輔助組件
AutoMapper.Extensions.Microsoft.DependencyInjection

 一、首先咱們添加一個反射幫助類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;
        }
    }
}

二、接着咱們添加一個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依賴注入輔助組件進行批量依賴注入。

4、Web層

本demo的web項目須要引用如下幾個程序集：

一、TianYa.DotNetShare.Model 咱們的實體層

二、TianYa.DotNetShare.Service 咱們的服務層

三、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 });
        }
    }
}

到這裏咱們基礎的自動實體映射就算是處理好了，最後咱們調試起來看下結果：

 

 小結：

一、在該例子中咱們實現了從Student（PO） 到 V_Student（VO）的實體映射。

二、能夠發如今服務層中也注入成功了，說明AutoMapper依賴注入輔助組件的注入是全局的。

三、AutoMapper 默認是經過匹配字段名稱和類型進行自動匹配，因此若是你進行轉換的兩個類中的某些字段名稱不同，這時咱們就須要進行手動的編寫轉換規則。

四、在AutoMapper中，咱們能夠經過 ForMember 方法對映射規則作進一步的加工。

 

 未完待續......

 

參考博文：https://mp.weixin.qq.com/s/DyBEQbWQ0-IRP1Pkl_9RbA

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程