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

版权声明：如有雷同纯属巧合，如有侵权请及时联系本人修改，谢谢！！！