.net core使用AutoMapper

原创于 2024-12-11 20:15:01 发布 · 1.3k 阅读

CC 4.0 BY-SA版权

文章标签：

AutoMapper 是一个用于 .NET 平台的对象映射工具，它简化了不同对象类型之间的转换过程。在软件开发中，尤其是在分层架构的应用程序里，常常需要在不同的对象模型之间进行数据传递，例如从数据库实体到视图模型、DTO（数据传输对象）或业务逻辑层的模型等。手动编写这些转换代码不仅繁琐而且容易出错，而 AutoMapper 可以自动化这个过程，提高开发效率和代码质量。

AutoMapper 的主要功能

属性匹配：根据属性名称自动匹配源对象和目标对象之间的对应关系，并进行赋值。
构造映射配置：允许开发者定义如何将一个类型的实例映射到另一个类型。
支持复杂映射：可以处理嵌套对象、集合以及更复杂的映射需求。
忽略某些属性：可以选择性地忽略不需要映射的属性。
自定义转换逻辑：对于那些不能直接映射的属性，可以指定自定义的转换逻辑。
验证映射配置：可以在运行时检查映射配置是否正确，确保所有必要的映射都被正确设置。

使用示例

首先，你需要安装 AutoMapper 包，可以通过 NuGet 安装：

Install-Package AutoMapper

然后，在你的应用程序中配置 AutoMapper：

// 创建映射配置
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<Source, Destination>();
    // 添加更多映射规则...
});

// 创建映射器实例
IMapper mapper = config.CreateMapper();

使用 AutoMapper 进行对象映射：

// 假设有两个类 Source 和 Destination
public class Source
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public class Destination
{
    public int Identifier { get; set; } // 对应于 Source.Id
    public string Title { get; set; }   // 对应于 Source.Name
}

// 使用 AutoMapper 进行映射
var source = new Source { Id = 1, Name = "Example" };
var destination = mapper.Map<Destination>(source);

// 现在 destination 包含了来自 source 的数据
Console.WriteLine($"Identifier: {destination.Identifier}, Title: {destination.Title}");

在这个例子中，我们创建了一个简单的映射配置，告诉 AutoMapper 如何将 Source 类型的对象转换为 Destination 类型的对象。通过 CreateMap<Source, Destination>() 方法，AutoMapper 会自动尝试根据属性名来匹配源和目标对象中的属性。如果属性名称不匹配或者需要特殊处理，还可以进一步定制映射规则。

AutoMapper 是一个非常强大且灵活的工具，能够极大地减少重复代码的数量，同时保持代码的可读性和维护性。

在.NET Core项目中使用Dapper和AutoMapper可以提高数据访问层和业务逻辑层之间的解耦，以及简化对象映射的过程。Dapper是一个轻量级的ORM（对象关系映射）工具，它帮助我们执行SQL查询并将结果映射到强类型的C#对象上。而AutoMapper则是一个对象-对象映射器，用于简化不同对象模型之间的转换过程。

Dapper的作用

当你从数据库中检索数据时，Dapper能够将查询结果直接映射到你的C#类中。例如，如果你有一个Product表，并且你想要获取所有产品记录，你可以使用Dapper来执行这个操作：

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

// 使用Dapper查询所有产品
using (var connection = new SqlConnection(connectionString))
{
    var products = connection.Query<Product>("SELECT * FROM Products").ToList();
}

AutoMapper的作用

假设你需要将Product实体映射到一个DTO（数据传输对象）或者视图模型中，这时AutoMapper就派上用场了。DTO或视图模型可能与实体有不同的结构，或是只包含实体的一部分属性。手动编写这些映射规则可能会非常繁琐，尤其是当你的应用中有许多这样的映射需求时。AutoMapper允许你定义一次映射规则，然后可以在整个应用程序中重复使用这些规则。

以下是如何使用AutoMapper将Product实体映射到ProductViewModel的一个例子：

public class ProductViewModel
{
    public int Id { get; set; }
    public string Title { get; set; } // 假设这里名称改为了Title
    public decimal Cost { get; set; } // 假设这里价格改为了Cost
}

// 配置AutoMapper
var config = new MapperConfiguration(cfg => {
    cfg.CreateMap<Product, ProductViewModel>()
       .ForMember(dest => dest.Title, opt => opt.MapFrom(src => src.Name))
       .ForMember(dest => dest.Cost, opt => opt.MapFrom(src => src.Price));
});

var mapper = config.CreateMapper();

// 使用Dapper查询产品后，通过AutoMapper映射到视图模型
var productViewModels = products.Select(p => mapper.Map<ProductViewModel>(p)).ToList();