# RobotMapper

**Repository Path**: huangyong2022/RobotMapper

## Basic Information

- **Project Name**: RobotMapper
- **Description**: 在实际的项目中，我们一般需要将Entity映射为DTO，或者将DTO映射为ViewModel，我们的Model中循环引用可以说很多，例如Entity的外键等，而一般的映射工具例如Automapper在处理这类映射的时候效率很低，其他的映射工具又有着复杂的初始化配置，那么一款无需配置就可映射，并能自动解决循环引用问题的Mapper工具就此诞生，本映射工具就是为了解决这些问题而诞生的！将其命名为RobotMapper，意味着他就是“机器人映射”，你不需要做任何配置就能自动映射！
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 15
- **Created**: 2017-12-05
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RobotMapper

**Nuget地址：**[https://www.nuget.org/packages/RobotMapper/](https://www.nuget.org/packages/RobotMapper/)

**项目地址：**[https://gitee.com/wuyuege/RobotMapper](https://gitee.com/wuyuege/RobotMapper)

---

##   RobotMapper诞生背景
1. 在日常项目开发中，需要将数据访问层的Entity转化为数据传输层的DTO，或者将数据传输层的DTO转化为前端的ViewModel,而手写转换方法很烦，而且随着结构的增加，类的增加，代码量会比较大且不利于更新维护，因此需要一款能够自动映射工具帮我们实现这些工作。
1. 我们对映射工具也有如下要求：     
- **转化效率必须高**：显然，查询数据只需要0.001毫秒但是映射花费1秒这是我们不能接受的；      
- **配置必须简单甚至无需配置或者自动配置**：每次映射都需要进行复杂的配置无异于手动映射让人烦躁；  
- **解决循环引用问题**：尤其是数据访问层，由于数据库表之间的关系，我们的Entity会有很多一对一，一对多，多对多的导航属性，类型之间的互相引用必不可少，传统的映射工具无法**自动解决该问题**，要么进入死循环要么映射效率低下；

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

---

## RobotMapper使用介绍
让我们先创建对应的DTO和Entity

**Entity**
```CSharp
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**

```CSharp
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**

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


1. **无需配置**：

```CSharp
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);
```

---

2. **解决循环引用**     
**创建一个循环引用User**

```CSharp
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;
}
```
**仍然是自动映射**

```CSharp
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);
```

---

3. **效率问题**

```CSharp
var user = TestHelper.创建循环引用User();
for (int i = 1; i <= 100000; i++)
{
    var newuser = user.RobotMap<User, DTO.User>();
}
```
以上代码大家可自行测试，映射十万次：仅需1s

---


4. **批量映射**    

```CSharp
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毫秒

---

### 其他功能：
- 支持自定义映射配置：
    
```CSharp
[TestMethod]
public void 测试配置Bind()
{
    Mapper.Initialize(creator =>
    {
        creator.CreatMap<User, DTO.User>(config =>
        {
            config.Bind(x => x.User12.Name, y => y.UserName);
            config.Ignore(y => y.Roles);
        });
    });
}
```

---

- 支持忽略属性：

```CSharp
[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);
}
```

---
- 支持即用即配

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

```CSharp
[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);
}
```

---
### 详细文档：

- [自动配置策略](https://gitee.com/wuyuege/RobotMapper/wikis/pages?title=默认配置规则&parent=)
- [智能化解决循环引用问题](https://gitee.com/wuyuege/RobotMapper/wikis/pages?title=智能化解决循环引用问题&parent=)
- [高效与高速](https://gitee.com/wuyuege/RobotMapper/wikis/pages?title=高效与高速&parent=)
- [自定义绑定和忽略](https://gitee.com/wuyuege/RobotMapper/wikis/pages?title=自定义绑定和忽略&parent=)
- [即用即配](https://gitee.com/wuyuege/RobotMapper/wikis/pages?title=即用即配&parent=)
- [RobotMapper支持的类型](https://gitee.com/wuyuege/RobotMapper/wikis/pages?title=RobotMapper支持的类型&parent=)
- [RobotMapper目前不支持的类型](https://gitee.com/wuyuege/RobotMapper/wikis/pages?title=RobotMapper目前不支持的类型&parent=)
- 其他功能：待完善

---

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