C#中AutoMapper处理UserRole与UserRoleDTO外键映射失败的解决方法

问题背景 #

定义了3个对应SQL表的实体类：

public partial class Role
{
    public int Id { get; set; }

    public string "Role1" { get; set; } = null!;

    public virtual ICollection<RolesAction> RolesActions { get; } = new List<RolesAction>();
    public virtual ICollection<UserRole> UserRoles { get; } = new List<UserRole>();
}

public partial class User
{
    public int Id { get; set; }

    public string "Name" { get; set; } = null!;

    public virtual ICollection<UserRole> UserRoles { get; } = new List<UserRole>();
}

public partial class UserRole
{
    public int Id { get; set; }
    public int UserId { get; set; }
    public int RoleId { get; set; }

    public virtual Role Role { get; set; } = null!;
    public virtual User User { get; set; } = null!;
}

对应的DTO类：

public partial class RoleDTO
{
    public int Id { get; set; }

    public string "Role1" { get; set; } = null!;
}

public partial class UserDTO
{
    public int Id { get; set; }

    public string "Name" { get; set; } = null!;
}

public partial class UserRoleDTO
{
    public int Id { get; set; }

    public string "User" { get; set; }
    public string "Role" { get; set; }
}

已成功实现User与UserDTO的双向映射：

internal class UserAndUserDTO : Profile
{
    public UserAndUserDTO()
    {
        CreateMap<User, UserDTO>()
           .ReverseMap();
    }
}

但UserRole与UserRoleDTO的映射失败，当前配置：

internal class UserRoleAndUserRoleDTO : Profile
{
    public UserRoleAndUserRoleDTO()
    {
        CreateMap<UserRole, UserRoleDTO>()
            .ForMember(dest => dest.User,
                        opt => opt.MapFrom(src => src.User.Name))
            .ForMember(dest => dest.Role,
                        opt => opt.MapFrom(src => src.Role.Role1))
            .ReverseMap();  
    }
}

执行后抛出异常，需修改代码让映射正常工作。

问题原因 #

ReverseMap()无法自动处理字符串到实体对象的逆向映射：

• 正向映射逻辑是把UserRole关联实体的字符串字段（User.Name/Role.Role1）映射到UserRoleDTO的对应字段，这部分逻辑是成立的。
• 但逆向映射时，AutoMapper没有默认规则可以把UserRoleDTO中的字符串（User/Role字段）转换为UserRole里的User/Role实体对象，因此抛出异常。

解决方案 #

根据业务需求选择以下方案：

方案1：仅保留正向映射（无需逆向） #

如果不需要从UserRoleDTO映射回UserRole，直接移除ReverseMap()即可：

internal class UserRoleAndUserRoleDTO : Profile
{
    public UserRoleAndUserRoleDTO()
    {
        CreateMap<UserRole, UserRoleDTO>()
            .ForMember(dest => dest.User,
                        opt => opt.MapFrom(src => src.User.Name))
            .ForMember(dest => dest.Role,
                        opt => opt.MapFrom(src => src.Role.Role1));
        // 移除ReverseMap()
    }
}

方案2：手动配置逆向映射规则（需双向映射） #

如果必须支持双向映射，需要明确告诉AutoMapper如何从字符串转换为实体对象。通常需要依赖仓储/服务查询对应实体，示例代码如下：

internal class UserRoleAndUserRoleDTO : Profile
{
    public UserRoleAndUserRoleDTO()
    {
        // 正向映射
        CreateMap<UserRole, UserRoleDTO>()
            .ForMember(dest => dest.User, opt => opt.MapFrom(src => src.User.Name))
            .ForMember(dest => dest.Role, opt => opt.MapFrom(src => src.Role.Role1));

        // 手动配置逆向映射
        CreateMap<UserRoleDTO, UserRole>()
            .ForMember(dest => dest.Id, opt => opt.MapFrom(src => src.Id))
            // 根据用户名查询User实体，替换为你项目中实际的查询逻辑
            .ForMember(dest => dest.User, opt => opt.MapFrom((src, _, _, context) => 
                context.GetService<IUserRepository>()?.GetByUserName(src.User)))
            // 根据角色名查询Role实体，替换为你项目中实际的查询逻辑
            .ForMember(dest => dest.Role, opt => opt.MapFrom((src, _, _, context) => 
                context.GetService<IRoleRepository>()?.GetByRoleName(src.Role)))
            // 同步映射UserId和RoleId
            .ForMember(dest => dest.UserId, opt => opt.MapFrom((src, dest) => dest.User?.Id ?? 0))
            .ForMember(dest => dest.RoleId, opt => opt.MapFrom((src, dest) => dest.Role?.Id ?? 0));
    }
}

注意：

• 代码中的IUserRepository/IRoleRepository为假设的仓储接口，需替换为项目中实际用于查询用户、角色的服务/仓储。
• 需处理查询不到实体的null场景，避免空引用异常。

额外提示 #

实体类中属性名使用引号（如public string "Role1"）属于非常规写法，建议改为符合C#命名规范的标识符（如RoleName），避免潜在的语法或序列化问题。

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