AutoMapper中使用DateTime.ToString指定格式化字符串不生效的问题

我最近做API开发时碰到了个挠头的问题：明明在AutoMapper映射配置里给Appointment到AppointmentResponse指定了dd/MM/yyyy的日期格式，但API返回的日期却总是变成MM/dd/yyyy HH:mm:ss PM这种和本地PC一致的默认格式。下面是我的代码情况，以及排查和解决的思路，分享给大家：

先看我的代码实现 #

1. 处理查询的Handler代码

public async Task<Result<PagedResult<Responses.AppointmentResponse>>> Handle(Query.GetAppointmentQuery request, CancellationToken cancellationToken)
{
    var EventsQuery = GetAppointmentsQuery(request);

    var Events = await PagedResult<Domain.Entities.Appointment>.CreateAsync(EventsQuery,
            request.PageIndex, request.PageSize);

    var result = mapper.Map<PagedResult<Responses.AppointmentResponse>>(Events);

    return Result.Success(result);
}

2. AutoMapper配置文件

CreateMap<Appointment, AppointmentResponse>()
    .ForMember(dest => dest.CreatedDate, opt => opt.MapFrom(src => src.CreatedDate.ToString("dd/MM/yyyy")))
    .ForMember(dest => dest.UpdatedDate, opt => opt.MapFrom(src => src.UpdatedDate.Value.ToString("dd/MM/yyyy")))
    .ReverseMap();

CreateMap<PagedResult<Appointment>, PagedResult<AppointmentResponse>>().ReverseMap();

3. 分页结果类PagedResult的构造函数

public PagedResult(List<T> items, int pageIndex, int pageSize, int totalCount)
{
    this.Items = items;
    this.PageIndex = pageIndex;
    this.PageSize = pageSize;
    this.TotalCount = totalCount;
}

4. API实际输出的日期格式

"createdDate": "11/3/2024 1:25:25 PM"

可以看到，返回的日期不仅带了多余的时间部分，连日期顺序都和我指定的dd/MM/yyyy完全相反，变成了月/日/年的格式。

排查问题的几个关键坑 #

坑1：目标类属性类型不匹配

我首先检查了AppointmentResponse的属性类型——居然把CreatedDate和UpdatedDate定义成了DateTime而不是string！这直接导致：AutoMapper把src.CreatedDate.ToString("dd/MM/yyyy")的字符串结果，又隐式转换回了DateTime类型，等到JSON序列化时，系统又用默认格式把DateTime转成了字符串，完全覆盖了我之前的格式化设置。

坑2：PagedResult泛型集合映射可能未生效

虽然配置了PagedResult<Appointment>到PagedResult<AppointmentResponse>的映射，但我的PagedResult的Items属性是只读的（只有get没有set），AutoMapper会通过构造函数创建实例。如果构造函数的参数映射逻辑有问题，就会导致内部元素的映射被跳过，直接用原始DateTime属性序列化。

坑3：ToString的文化环境影响

另外，DateTime.ToString("dd/MM/yyyy")里的/是日期分隔符占位符，会被当前线程的文化设置替换成本地分隔符；如果不指定固定文化，在不同环境下还可能出现格式不一致的问题。

最终的解决方案 #

1. 修正目标类的属性类型

把AppointmentResponse里的CreatedDate和UpdatedDate改成string类型，确保AutoMapper映射的字符串结果能直接被序列化输出：

public class AppointmentResponse
{
    public string CreatedDate { get; set; }
    public string UpdatedDate { get; set; }
    // 其他属性...
}

2. 优化AutoMapper映射配置

在日期格式化时指定CultureInfo.InvariantCulture，避免受系统文化影响；同时显式指定PagedResult的构造逻辑，确保内部元素被正确映射：

using System.Globalization;

// ...

CreateMap<Appointment, AppointmentResponse>()
    .ForMember(dest => dest.CreatedDate, opt => opt.MapFrom(src => src.CreatedDate.ToString("dd/MM/yyyy", CultureInfo.InvariantCulture)))
    .ForMember(dest => dest.UpdatedDate, opt => opt.MapFrom(src => src.UpdatedDate.HasValue 
        ? src.UpdatedDate.Value.ToString("dd/MM/yyyy", CultureInfo.InvariantCulture) 
        : null))
    .ReverseMap();

// 显式指定PagedResult的构造逻辑，确保每个元素都被正确映射
CreateMap<PagedResult<Appointment>, PagedResult<AppointmentResponse>>()
    .ConstructUsing((src, context) => new PagedResult<AppointmentResponse>(
        src.Items.Select(item => context.Mapper.Map<AppointmentResponse>(item)).ToList(),
        src.PageIndex,
        src.PageSize,
        src.TotalCount
    ))
    .ReverseMap();

3. 验证PagedResult的属性可访问性

确保PagedResult的Items属性是可被AutoMapper识别的集合类型，构造函数参数能正确接收映射后的集合：

public class PagedResult<T>
{
    public List<T> Items { get; }
    public int PageIndex { get; }
    public int PageSize { get; }
    public int TotalCount { get; }

    public PagedResult(List<T> items, int pageIndex, int pageSize, int totalCount)
    {
        Items = items ?? throw new ArgumentNullException(nameof(items));
        PageIndex = pageIndex;
        PageSize = pageSize;
        TotalCount = totalCount;
    }

    // 静态创建方法...
}

调整后重新测试API，返回的日期格式就变成了预期的dd/MM/yyyy格式：

"createdDate": "03/11/2024"

备注：内容来源于stack exchange，提问作者Panda