C#使用AutoMapper進行對象映射的示例代碼

更新時間：2024年08月15日 10:20:18 作者：一個代碼獵人

AutoMapper 是一個對象到對象映射的庫,可以簡化 DTO (Data Transfer Objects) 和實體類之間的轉換,在大型應用程序中,通常需要將業(yè)務實體映射到視圖模型或 DTO 中,本文將詳細介紹如何在 C# 項目中使用 AutoMapper,包括安裝、配置、以及示例代碼

引言

AutoMapper 是一個對象到對象映射的庫，可以簡化 DTO (Data Transfer Objects) 和實體類之間的轉換。在大型應用程序中，通常需要將業(yè)務實體映射到視圖模型或 DTO 中，這樣可以減少代碼的重復性并提高可維護性。本文將詳細介紹如何在 C# 項目中使用 AutoMapper，包括安裝、配置、以及示例代碼。

一、安裝 AutoMapper

首先，需要在項目中安裝 AutoMapper，可以使用 NuGet Package Manager 進行安裝。

在 Visual Studio 中打開 NuGet 包管理控制臺，然后運行以下命令：

Install-Package AutoMapper

或者通過 NuGet 管理器搜索 AutoMapper 并進行安裝。

二、配置 AutoMapper

安裝完成后，需要配置 AutoMapper。通常在應用程序啟動時配置，可以在 ASP.NET Core 的 Startup 類中配置，或在普通的控制臺應用程序的入口處配置。

定義模型和 DTO

讓我們首先定義一個簡單的模型類和對應的 DTO 類。

public class User
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public DateTime DateOfBirth { get; set; }
}

public class UserDto
{
    public int Id { get; set; }
    public string FullName { get; set; }
    public int Age { get; set; }
}

創(chuàng)建映射配置

接下來，我們需要配置對象之間的映射關系。在 ASP.NET Core 項目中，可以在 Startup.cs 文件中進行配置。在控制臺應用程序中，可以在 Main 方法中進行配置。

using AutoMapper;
using System;

public class AutoMapperProfile : Profile
{
    public AutoMapperProfile()
    {
        // 配置映射關系
        CreateMap<User, UserDto>()
            .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => $"{src.FirstName} {src.LastName}"))
            .ForMember(dest => dest.Age, opt => opt.MapFrom(src => DateTime.Now.Year - src.DateOfBirth.Year));
    }
}

在上面的代碼中，我們定義了一個 AutoMapperProfile 類，它繼承自 Profile，并在構造函數中配置了 User 和 UserDto 之間的映射關系。

初始化 AutoMapper

然后，我們需要在應用程序啟動時初始化 AutoMapper。

在 ASP.NET Core 中，可以在 Startup.cs 中配置：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddAutoMapper(typeof(Startup));
    }
}

在控制臺應用程序中，可以在 Main 方法中初始化：

class Program
{
    static void Main(string[] args)
    {
        var config = new MapperConfiguration(cfg =>
        {
            cfg.AddProfile<AutoMapperProfile>();
        });

        IMapper mapper = config.CreateMapper();

        // 測試映射
        var user = new User
        {
            Id = 1,
            FirstName = "John",
            LastName = "Doe",
            DateOfBirth = new DateTime(1990, 1, 1)
        };

        var userDto = mapper.Map<UserDto>(user);

        Console.WriteLine($"Id: {userDto.Id}, FullName: {userDto.FullName}, Age: {userDto.Age}");
    }
}

在上面的代碼中，我們創(chuàng)建了 MapperConfiguration 并添加了我們剛才創(chuàng)建的 AutoMapperProfile。然后，通過 CreateMapper 方法創(chuàng)建一個 IMapper 實例，并使用它來執(zhí)行映射操作。

三、使用 AutoMapper

有了上述配置后，就可以使用 AutoMapper 進行對象映射了。以下是一個簡單的示例：

var user = new User
{
    Id = 1,
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = new DateTime(1990, 1, 1)
};

var userDto = mapper.Map<UserDto>(user);

Console.WriteLine($"Id: {userDto.Id}, FullName: {userDto.FullName}, Age: {userDto.Age}");

運行該代碼后，將輸出：

Id: 1, FullName: John Doe, Age: 34

AutoMapper 自動將 User 對象映射到 UserDto 對象，并且根據配置生成了 FullName 和 Age 的值。

四、總結

通過以上示例，您已經學習了如何在 C# 中使用 AutoMapper 進行對象映射。AutoMapper 是一個非常強大的工具，它可以減少手動編寫映射代碼的工作量，特別是在復雜項目中更是如此。希望本文對您有所幫助！

完整代碼示例：

using AutoMapper;
using System;

public class User
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public DateTime DateOfBirth { get; set; }
}

public class UserDto
{
    public int Id { get; set; }
    public string FullName { get; set; }
    public int Age { get; set; }
}

public class AutoMapperProfile : Profile
{
    public AutoMapperProfile()
    {
        CreateMap<User, UserDto>()
            .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => $"{src.FirstName} {src.LastName}"))
            .ForMember(dest => dest.Age, opt => opt.MapFrom(src => DateTime.Now.Year - src.DateOfBirth.Year));
    }
}

class Program
{
    static void Main(string[] args)
    {
        var config = new MapperConfiguration(cfg =>
        {
            cfg.AddProfile<AutoMapperProfile>();
        });

        IMapper mapper = config.CreateMapper();

        var user = new User
        {
            Id = 1,
            FirstName = "John",
            LastName = "Doe",
            DateOfBirth = new DateTime(1990, 1, 1)
        };

        var userDto = mapper.Map<UserDto>(user);

        Console.WriteLine($"Id: {userDto.Id}, FullName: {userDto.FullName}, Age: {userDto.Age}");
    }
}

這段代碼可以直接復制到您的項目中并運行，幫助您快速掌握 AutoMapper 的使用。

以上就是C#使用AutoMapper進行對象映射的示例代碼的詳細內容，更多關于C# AutoMapper對象映射的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: