如何为多个地址DTO复用CreateAddressAsync方法？

问题背景 #

定义了基础Address实体：

public class Address
{
    public string? City { get; set; }
    public string? Country { get; set; }
    public string? Contact { get; set; }
    public string? Street1 { get; set; }
    public string? Street2 { get; set; }
    public string? State { get; set; }
    public string? Zip { get; set; }
}

针对不同用户需求设计了两个DTO：

public class AddressDto1
{
    public string? City { get; set; }
    public string? Country { get; set; }
    public string? Contact { get; set; }
    public string? Street1 { get; set; }
    public string? Street2 { get; set; }
    public string? State { get; set; }
    public string? Zip { get; set; }
} 

public class AddressDto2
{ 
    [Required] // 注意原代码拼写错误，应为Required
    public string Street1 { get; set; }
    [Required]
    public string Street2 { get; set; }
    public string? State { get; set; }
    public string? Zip { get; set; }
}

现有服务仅支持AddressDto1的创建，希望修改CreateAddressAsync方法，使其同时支持任意符合映射规则的地址DTO（如AddressDto2）。

现有服务代码：

public interface IAddressService
{
    public Task<AddressDto1> CreateAddressAsync(AddressDto1 AddressDto1);
}

public class AddressService:IAddressService
{
    public Task<AddressDto1> CreateAddressAsync(AddressDto1 addressDto1)
    {
        var newAddress = _mapper.Map<Address>(addressDto1);
        var addedAddress = await _dbContext.Addresses.AddAsync(newAddress);
        await _dbContext.SaveChangesAsync();
        return _mapper.Map<AddressDto1>(addedAddress.Entity);
    }
}

AutoMapper映射配置已完成：

public MappingProfile()
{
    CreateMap<AddressDto1, Address>().ReverseMap();
    CreateMap<AddressDto2, Address>().ReverseMap();
}

解决方案 #

通过泛型方法重构服务接口与实现，即可支持任意已配置映射规则的DTO类型：

1. 修改接口为泛型方法 #

public interface IAddressService
{
    Task<TDto> CreateAddressAsync<TDto>(TDto addressDto) where TDto : class;
}

2. 实现泛型版服务方法 #

public class AddressService : IAddressService
{
    private readonly IMapper _mapper;
    private readonly YourDbContext _dbContext;

    // 构造函数注入依赖（补充原代码缺失的依赖注入逻辑）
    public AddressService(IMapper mapper, YourDbContext dbContext)
    {
        _mapper = mapper;
        _dbContext = dbContext;
    }

    public async Task<TDto> CreateAddressAsync<TDto>(TDto addressDto) where TDto : class
    {
        // 将任意DTO映射为Address实体
        var newAddress = _mapper.Map<Address>(addressDto);
        
        // 保存到数据库
        var addedAddress = await _dbContext.Addresses.AddAsync(newAddress);
        await _dbContext.SaveChangesAsync();
        
        // 将保存后的实体映射回原DTO类型返回
        return _mapper.Map<TDto>(addedAddress.Entity);
    }
}

3. 调用示例 #

// User1使用AddressDto1创建地址
var dto1 = new AddressDto1 
{ 
    City = "Beijing", 
    Country = "CN", 
    Street1 = "Main St" 
};
var result1 = await _addressService.CreateAddressAsync(dto1);

// User2使用AddressDto2创建地址
var dto2 = new AddressDto2 
{ 
    Street1 = "Second Ave", 
    Street2 = "Unit 3" 
};
var result2 = await _addressService.CreateAddressAsync(dto2);

关键说明 #

• 泛型约束where TDto : class确保传入的是引用类型，符合DTO的设计特性
• AutoMapper会根据传入的TDto类型自动匹配已配置的映射规则（你已完成AddressDto1和AddressDto2与Address的双向映射，无需额外修改配置）
• 方法返回值与传入的DTO类型一致，满足不同用户的返回数据需求

内容的提问来源于stack exchange，提问作者Sadabadi