RobotMapper

Releases

项目地址：https://gitee.com/wuyuege/RobotMapper

RobotMapper诞生背景

在日常项目开发中，需要将数据访问层的Entity转化为数据传输层的DTO，或者将数据传输层的DTO转化为前端的ViewModel,而手写转换方法很烦，而且随着结构的增加，类的增加，代码量会比较大且不利于更新维护，因此需要一款能够自动映射工具帮我们实现这些工作。
我们对映射工具也有如下要求：

转化效率必须高：显然，查询数据只需要0.001毫秒但是映射花费1秒这是我们不能接受的；
配置必须简单甚至无需配置或者自动配置：每次映射都需要进行复杂的配置无异于手动映射让人烦躁；
解决循环引用问题：尤其是数据访问层，由于数据库表之间的关系，我们的Entity会有很多一对一，一对多，多对多的导航属性，类型之间的互相引用必不可少，传统的映射工具无法自动解决该问题，要么进入死循环要么映射效率低下；

那么本映射工具“RobotMapper”就是为了解决以上问题而诞生的，是的，它叫RobotMapper,一切都是自动化完成！

RobotMapper使用介绍

让我们先创建对应的DTO和Entity

Entity

namespace Entity
{
    public class User
    {
        public User()
        {
            Roles = new List<Role>();
        }
        public string Id { get; set; }
        public string Name { get; set; }
        public string Code { get; set; }
        public string Department { get; set; }
        public List<Role> Roles { get; set; }
        public User User12 { get; set; }
    }
}

namespace Entity
{
    public class Role
    {
        public string Name { get; set; }

        public List<User> Users { get; set; }
    }
}

DTO

namespace DTO
{
    public class User
    {
        public User()
        {
            Roles = new List<Role>();
        }
        public string Id { get; set; }
        public string Name { get; set; }
        public string Code { get; set; }
        public string Department { get; set; }
        public List<Role> Roles { get; set; }
        public User User12 { get; set; }
        public string UserName { get; set; }
    }
}

namespace DTO
{
    public class Role
    {
        public string Name { get; set; }

        public List<User> Users { get; set; }
    }
}

接下来创建User

public static User 创建扁平化User()
{
    Entity.User user = new User()
    {
        Code = "Liuhai",
        Id = "hai.liu",
        Department = "部门1",
        Name = "海哥",
    };
    return user;
}

无需配置：

var user = TestHelper.创建扁平化User();
var newuser = user.RobotMap<User, DTO.User>();
Assert.AreEqual(user.Code, newuser.Code);
Assert.AreEqual(user.Id, newuser.Id);
Assert.AreEqual(user.Department, newuser.Department);
Assert.AreEqual(user.Name, newuser.Name);

解决循环引用
创建一个循环引用User

public static User 创建循环引用User()
{
    Entity.User user = new User()
    {
        Code = "Liuhai",
        Id = "hai.liu",
        Department = "部门1",
        Name = "海哥",
    };
    user.Roles.Add(new Role()
    {
        Name = "角色1",
        Users = new List<User>() { new User() { Name = "SB" } }
    });

    return user;
}

仍然是自动映射

var user = TestHelper.创建循环引用User();
var newuser = user.RobotMap<User, DTO.User>();
Assert.AreEqual(user.Code, newuser.Code);
Assert.AreEqual(user.Id, newuser.Id);
Assert.AreEqual(user.Department, newuser.Department);
Assert.AreEqual(user.Name, newuser.Name);
Assert.IsTrue(newuser.Roles.Count == 1);

效率问题

var user = TestHelper.创建循环引用User();
for (int i = 1; i <= 100000; i++)
{
    var newuser = user.RobotMap<User, DTO.User>();
}

以上代码大家可自行测试，映射十万次：仅需1s

批量映射

List<User> users = new List<User>();
for (int i = 1; i <= 10000; i++)
{
    var user = TestHelper.创建循环引用User();
    users.Add(user);
}
var newusers = users.RobotMap<User, DTO.User>();

以上代码大家可自行测试，批量映射一万条：仅需190毫秒

其他功能：

支持自定义映射配置：

[TestMethod]
public void 测试配置Bind()
{
    Mapper.Initialize(creator =>
    {
        creator.CreatMap<User, DTO.User>(config =>
        {
            config.Bind(x => x.User12.Name, y => y.UserName);
            config.BindName(x => x.User12, y => y.User13);
            config.Ignore(y => y.Roles);
        });
    });
}

支持忽略属性：

[TestMethod]
public void 测试忽略规则转换()
{
    Mapper.Initialize(creator =>
    {
        creator.CreatMap<User, DTO.User>(config =>
        {
            config.Ignore(y => y.Code);
            config.Ignore("Department", "Name");
        });
    });
    var user = TestHelper.创建扁平化User();
    var newuser = user.RobotMap<User, DTO.User>();
    Assert.IsNull(newuser.Code);
    Assert.IsNull(newuser.Department);
    Assert.IsNull(newuser.Name);
}

支持即用即配

[TestMethod]
public void 测试即用即配绑定()
{
    var user = TestHelper.创建自引用User();
    var newuser = user.RobotMap<User, DTO.User>(config=> 
    {
        config.Bind(x => x.User12.Name, y => y.UserName);
        config.BindName(x => x.User12, y => y.User13);
    });
    Assert.AreEqual(user.User12.Name, newuser.UserName);
}

[TestMethod]
public void 测试即用即配忽略()
{
    var user = TestHelper.创建扁平化User();
    var newuser = user.RobotMap<User, DTO.User>(config=> 
    {
        config.Ignore(y => y.Code);
        config.Ignore("Department", "Name");
    });
    Assert.IsNull(newuser.Code);
    Assert.IsNull(newuser.Department);
    Assert.IsNull(newuser.Name);
}

子类映射启用父类策略

在类与类之间进行映射时，当没有配置两者之间的映射关系时，可自动启用父类映射绑定规则：
==优先级为：源子类-目标子类>>源父类->>目标子类->>源->>目标父类->>源父类->>目标父类==
使用详情可查看：子类映射启用父类策略

雾月哥 / RobotMapper

RobotMapper

Releases

RobotMapper诞生背景

那么本映射工具“RobotMapper”就是为了解决以上问题而诞生的，是的，它叫RobotMapper,一切都是自动化完成！

RobotMapper使用介绍

其他功能：

注：即用即配的策略仅在本次映射中生效，与全局配置互不影响！

详细文档：

最后希望大家能为我找出bug，也希望大家能够给我提一些意见和建议！

简介

发行版 (10)

贡献者

近期动态

雾月哥 / RobotMapper .gitee-modal { width: 500px !important; }

RobotMapper

Releases

RobotMapper诞生背景

那么本映射工具“RobotMapper”就是为了解决以上问题而诞生的，是的，它叫RobotMapper,一切都是自动化完成！

RobotMapper使用介绍

其他功能：

注：即用即配的策略仅在本次映射中生效，与全局配置互不影响！

详细文档：

最后希望大家能为我找出bug，也希望大家能够给我提一些意见和建议！

简介

发行版 (10)

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

雾月哥 / RobotMapper