五步掌握OOM框架AutoMapper基本使用

五步掌握OOM框架AutoMapper基本使用

第一步：安装AutoMapper

在使用AutoMapper之前，我们需要将其引入项目中，可以通过NuGet包管理器安装AutoMapper。在Visual Studio中打开 NuGet 包管理器控制台（Tools > NuGet Package Manager > Package Manager Console），输入以下命令来安装AutoMapper：

Install-Package AutoMapper

第二步：编写映射配置

在使用AutoMapper之前，我们需要配置源类型和目标类型之间的映射配置。在一个源类型和目标类型之间创建映射配置至少需要一个AutoMapper Profile类。以下示例展示了如何创建一个简单的映射配置：

using AutoMapper;

namespace MyNamespace
{
    public class MyProfile : Profile
    {
        public MyProfile ()
        {
            CreateMap<Source, Destination>();
        }
    }
}

Source 和 Destination 是我们要映射的类名，它们之间的映射关系由 CreateMap 方法进行了配置，AutoMapper 会自动匹配源类型和目标类型中的同名属性进行映射。这里省略了显式指定映射关系的代码。

第三步：初始化AutoMapper

在使用AutoMapper之前，我们需要进行初始化。通常情况下，在应用程序启动时进行一次全局的初始化操作即可。

using AutoMapper;

namespace MyNamespace
{
    public class AutoMapperConfig
    {
        public static void Initialize()
        {
            Mapper.Initialize(cfg => {
                cfg.AddProfile<MyProfile>();
            });
        }
    }
}

以上代码通过 Mapper.Initialize 方法对AutoMapper进行全局初始化，并将之前创建的 AutoMappe Profile类进行注册。

第四步：使用AutoMapper

在对AutoMapper进行以上几步配置后，我们就可以使用它进行数据转换了。以下是一个基本示例：

using AutoMapper;

namespace MyNamespace
{
    public class MyClass
    {
        public Destination MyMethod(Source source)
        {
            return Mapper.Map<Destination>(source);
        }
    }
}

以上代码展示了在 MyMethod 方法中，我们使用了 Mapper.Map 方法将一个 Source 类型的对象转换成 Destination 类型的对象。

第五步：验证AutoMapper的映射逻辑

在使用AutoMapper进行数据转换时，我们需要对映射逻辑进行验证，确保AutoMapper可以正确地将我们的源类型和目标类型进行转换。

using AutoMapper;

namespace MyNamespace
{
    public class MyClass
    {
        public void MyMethod(Source source)
        {
            var destination = Mapper.Map<Destination>(source);

            // Verify the mapping
            Assert.AreEqual(source.Id, destination.Id);
            Assert.AreEqual(source.Name, destination.Name);
        }
    }
}

以上代码展示了在 MyMethod 方法中，我们使用 Mapper.Map 方法将一个 Source 类型的对象转换成 Destination 类型的对象，并且断言转换后的 Destination 对象与我们预期的结果相同。

示例说明

以下是两个使用示例：

示例一

假设我们有以下两个类：

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public class UserDto
{
    public int Id { get; set; }
    public string Name { get; set; }
}

我们使用AutoMapper将 User 类型的对象转换成 UserDto 类型的对象。

首先，我们需要创建映射配置：

public class MappingProfile : Profile
{
    public MappingProfile()
    {
        CreateMap<User, UserDto>();
    }
}

然后，我们需要进行AutoMapper的初始化：

Mapper.Initialize(cfg => cfg.AddProfile<MappingProfile>());

最后，我们可以使用AutoMapper进行数据转换了：

var user = new User {Id = 1, Name = "Alice"};
var userDto = Mapper.Map<UserDto>(user);

转换后的 UserDto 对象将包含与 User 对象相同的值。

示例二

假设我们有以下两个类：

public class Order
{
    public int Id { get; set; }
    public decimal Amount { get; set; }
}

public class OrderDto
{
    public int Id { get; set; }
    public string AmountString { get; set; }
}

由于 Amount 属性的类型为 decimal，在将 Order 类型的对象转换成 OrderDto 类型的对象时，我们希望将 Amount 属性的值转换成货币格式的字符串。我们可以通过在映射配置中添加自定义值转换器来实现这一点：

public class MappingProfile : Profile
{
    public MappingProfile()
    {
        CreateMap<Order, OrderDto>()
            .ForMember(dest => dest.AmountString,
                opt => opt.MapFrom(src => src.Amount.ToString("C")));
    }
}

以上代码通过 ForMember 方法指定了 AmountString 属性的映射关系，将 Amount 属性的值转换成货币格式的字符串，并将转换结果保存到 AmountString 属性中。最后，我们可以使用AutoMapper进行数据转换了：

var order = new Order {Id = 1, Amount = 100.00m};
var orderDto = Mapper.Map<OrderDto>(order);

转换后的 OrderDto 对象的 AmountString 属性将包含值为 $100.00 的字符串。