ASP.NET Core MVC 从入门到精通之自动映射（二）

news2024/11/29 20:58:57

随着技术的发展，ASP.NET Core MVC也推出了好长时间，经过不断的版本更新迭代，已经越来越完善，本系列文章主要讲解ASP.NET Core MVC开发B/S系统过程中所涉及到的相关内容，适用于初学者，在校毕业生，或其他想从事ASP.NET Core MVC 系统开发的人员。

经过前几篇文章的讲解，初步了解ASP.NET Core MVC项目创建，启动运行，以及命名约定，创建控制器，视图，模型，接收参数，传递数据ViewData，ViewBag，路由，页面布局，wwwroot和客户端库，Razor语法，EnityFrameworkCore与数据库，HttpContext，Request，Response，Session，序列化，文件上传，自动映射等内容，今天继续讲解ASP.NET Core MVC 中自动映射第二部分等相关内容，仅供学习分享使用。

经过上一篇文章的讲解，已经对ASP.NET Core中进行自动映射，有了一个初步的了解，今天继续接着上一篇文章对自动映射的第二部分内容进行讲解。

字符替换

在实际开发中，如果映射源存在一些特殊字符【如：ë ，Ă等】，映射目标是正常的字符，则需要进行替换，才能映射。如下所示：

var configuration = new MapperConfiguration(c =>
{
    c.ReplaceMemberName("Ä", "A");
    c.ReplaceMemberName("í", "i");
    c.ReplaceMemberName("Airlina", "Airline");
});

进行以上配置之后，会自动将Äbc映射到Abc上，将íng映射到ing上，将AirlinaMark映射到AirlineMark上。

自动映射匹配前缀与后缀

数据源一般都会有固定的风格，如带有前缀，后缀等标识。那么如何将带前缀的属性映射到不带前缀的的属性上呢？

默认情况下，带前缀是无法自动映射的。如下错误示例，映射源有一个前缀s，映射目标没有，则无法进行自动映射。如下：

可以在映射匹配文件中，增加映射前缀RecognizePrefixes("s")，如下所示：

namespace DemoCoreMVC.Profiles
{
    public class AutomapProfile:Profile
    {
        public AutomapProfile()
        {
            RecognizePrefixes("s");
            SourceMemberNamingConvention = new LowerUnderscoreNamingConvention();
            DestinationMemberNamingConvention = new PascalCaseNamingConvention();
            //创建映射关系
            CreateMap<StudentViewModel, Student>();
        }
    }
}

经过前缀设置后，则可以进行自动映射，如下所示：

关于映射匹配前缀后缀设置，有以下几点需要注意：

一般前缀都是具有一定规律的设置，否则有些前缀a，有些前缀b，没有一定的规律，则无法完全匹配。
后缀通过RecognizePostfixes("s");设置即可，功能测试与前缀一致。
取消前缀设置ClearPrefixes();就是取消所有的前缀设置列表中设置的前缀。Automapper默认匹配了Get前缀，如果不需要可以清除。

映射控制(不常用)

使用ShouldMapField和ShouldMapProperty控制哪些属性和字段能够被映射

cfg.ShouldMapField = fi => false;
cfg.ShouldMapProperty = pi =>pi.GetMethod != null && (pi.GetMethod.IsPublic || pi.GetMethod.IsPrivate);

默认所有public的field和property都会被map，也会map private 的setter，但是不会map整个property都是internal/private的属性。

列表映射

在实际工作中，列表的应用场景还是比较多的，列表映射也比较常用。如下所示：

[HttpPost]
public IActionResult Add(StudentViewModel studentViewModel)
{
    var listStudents=new List<StudentViewModel>();
    listStudents.Add(studentViewModel);
    var students =  mapper.Map<List<StudentViewModel>,List< Student>>(listStudents);
    studentService.Adds(students);
    return View();
}

经过测试发现，只要映射了元素类型，列表可以自动映射。如下所示：

AutoMapper默认会自动映射以下类型：

IEnumerable
IEnumerable<T>
ICollection
ICollection<T>
IList
IList<T>
List<T>
Arrays

这几个集合之间可以相互映射，如：mapper.Map<Source[], IEnumerable<Destination>>(sources);

手动控制映射(不常用)

如果对于完全没有任何规律的映射，如何进行呢？如下两个映射数据类型：
映射源类型：

namespace DemoCoreMVC.ViewModels
{
    public class UserViewModel
    {
        public int UserId { get; set; }

        public string UserName { get; set; }

        public string Mail { get; set; }
    }
}

映射目标类型：

namespace DemoCoreMVC.Models
{
    public class User
    {
        public int Id { get; set; }

        public string Name { get; set; }

        public string Email { get; set; }
    }
}

需要手动配置映射属性列，如下所示：

public class AutomapProfile:Profile
{
    public AutomapProfile()
    {
        RecognizePrefixes("s");
        //RecognizePostfixes("s");
        SourceMemberNamingConvention = new LowerUnderscoreNamingConvention();
        DestinationMemberNamingConvention = new PascalCaseNamingConvention();
        //创建映射关系
        CreateMap<StudentViewModel, Student>();
        //ClearPrefixes();

        CreateMap<UserViewModel, User>()
            .ForMember(dest => dest.Id, opt => opt.MapFrom(source => source.UserId))
            .ForMember(dest => dest.Name, opt => opt.MapFrom(source => source.UserName))
            .ForMember(dest => dest.Email, opt => opt.MapFrom(source => source.Mail));
    }
}

映射示例

通过手动配置映射列后，就可以实现自动映射，如下所示：

public IActionResult Add(UserViewModel userViewModel)
{

    var user =  mapper.Map<UserViewModel,User>(userViewModel);

    return View();
}

手动映射测试结果如下：

注意：手动映射主要适用于属性完全不一致，没有前缀，后缀，任何规律可言的属性映射的情况，所以一般不太常用。

嵌套映射

对于复杂的嵌套类型，对象的属性可能是一个复杂引用类型对象。

映射源，其中属性User为类型为UserViewModel的引用类型。如下所示：

namespace DemoCoreMVC.ViewModels
{
    public class EmployeeViewModel
    {
        public int Id { get; set; }

        public UserViewModel User { get; set; }
    }
}

映射目标，其中属性Uer为类型为User的引用类型。如下所示：

namespace DemoCoreMVC.Models
{
    public class Employee
    {
        public int Id { get; set; }

        public User User { get; set; }
    }
}

如果要对应复杂的存在嵌套关系的对象进行映射，则需要对属性类型也进行创建映射关系。如下所示：

CreateMap<UserViewModel, User>()
    .ForMember(dest => dest.Id, opt => opt.MapFrom(source => source.UserId))
    .ForMember(dest => dest.Name, opt => opt.MapFrom(source => source.UserName))
    .ForMember(dest => dest.Email, opt => opt.MapFrom(source => source.Mail));
CreateMap<EmployeeViewModel,Employee>();

在控制器中调用，如下所示：

public IActionResult Add(UserViewModel userViewModel)
{
    EmployeeViewModel employeeViewModel = new EmployeeViewModel() { Id = 1, User = userViewModel };
    var employee = mapper.Map<EmployeeViewModel, Employee>(employeeViewModel);

    return View();
}

运行测试，如下所示：