使用CSVHelper解析CSV的DateTime失败，寻求正确配置方法

无法为给定格式的CSV文件配置正确的DateTime格式化方式，尝试多种方法后当前代码方案看似最接近可行状态，但仍无法正常运行。

问题代码示例 #

public class Parser
{
    public static List<Order> ParseCsv()
    {
        var config = new CsvConfiguration(CultureInfo.InvariantCulture)
        {
            Delimiter = ";",
            HasHeaderRecord = true,
            TrimOptions = TrimOptions.Trim,
            MissingFieldFound = null
        };
        using (var reader = new StringReader("'Purchase Date'\r\n'2023-02-14T12:03:40Z'"))
        using (var csv = new CsvReader(reader, config))
        {
            csv.Context.RegisterClassMap<PurchaseMap>();
            return csv.GetRecords<Order>().ToList();
        }
    }
}

public class PurchaseMap : ClassMap<Order>
{
    public PurchaseMap()
    {
        Map(m => m.PurchaseDate).Name("'Purchase Date'").TypeConverterOption.Format("yyyy-MM-ddTHH:mm:ss");
    }
}

public class Order
{
    public DateTime PurchaseDate { get; set; }
}

报错信息 #

CsvHelper.TypeConversion.TypeConverterException: '无法执行转换。
文本: ''2023-02-14T12:03:40Z''
成员名称: Purchase Date
成员类型: System.DateTime
类型转换器: 'CsvHelper.TypeConversion.DateTimeConverter'

问题根源 #

1. CSV中的表头和日期值都被单引号包裹，但当前配置未指定单引号为引号字符，导致CsvHelper将带引号的完整字符串当作字段内容，而非自动剥离引号。
2. 日期格式未包含末尾的Z（UTC时间标志），与实际值格式不匹配。
3. ClassMap中指定的表头名称带单引号，与解析后的实际表头名称不符。

修正步骤 #

1. 配置CsvHelper识别单引号为引号字符 #

在CsvConfiguration中添加Quote = '\''，让CsvHelper自动剥离字段前后的单引号：

var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
    Delimiter = ";",
    HasHeaderRecord = true,
    TrimOptions = TrimOptions.Trim,
    MissingFieldFound = null,
    Quote = '\'' // 指定单引号为引号字符
};

2. 修正日期格式与表头名称 #

在PurchaseMap中，去掉表头名称的单引号，并更新日期格式以匹配带Z的UTC格式：

public PurchaseMap()
{
    Map(m => m.PurchaseDate)
        .Name("Purchase Date") // 匹配解析后的表头名称
        .TypeConverterOption.Format("yyyy-MM-ddTHH:mm:ssZ"); // 包含UTC标志Z的格式
}

也可以直接使用ISO 8601标准格式"o"，它能自动识别带Z的UTC日期：

.TypeConverterOption.Format("o");

完整修正代码 #

public class Parser
{
    public static List<Order> ParseCsv()
    {
        var config = new CsvConfiguration(CultureInfo.InvariantCulture)
        {
            Delimiter = ";",
            HasHeaderRecord = true,
            TrimOptions = TrimOptions.Trim,
            MissingFieldFound = null,
            Quote = '\'' // 指定单引号为引号字符
        };
        using (var reader = new StringReader("'Purchase Date'\r\n'2023-02-14T12:03:40Z'"))
        using (var csv = new CsvReader(reader, config))
        {
            csv.Context.RegisterClassMap<PurchaseMap>();
            return csv.GetRecords<Order>().ToList();
        }
    }
}

public class PurchaseMap : ClassMap<Order>
{
    public PurchaseMap()
    {
        Map(m => m.PurchaseDate)
            .Name("Purchase Date")
            .TypeConverterOption.Format("yyyy-MM-ddTHH:mm:ssZ");
    }
}

public class Order
{
    public DateTime PurchaseDate { get; set; }
}

额外优化建议 #

如果需要保留UTC时区信息，建议将Order类中的PurchaseDate改为DateTimeOffset类型，这样能更精准地处理时区，避免转换时的信息丢失：

public class Order
{
    public DateTimeOffset PurchaseDate { get; set; }
}

此时无需修改格式配置，CsvHelper会自动解析带Z的UTC日期为DateTimeOffset。

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