CsvHelper新版本中csvWriter.Configuration.ReferenceHeaderPrefix的等效替代方案是什么？

Got it, I ran into this exact same hiccup when upgrading CsvHelper to version 20.0.0 and above—so I feel your pain! The ReferenceHeaderPrefix property on the configuration became read-only, which broke the old lambda assignment approach. But good news: the functionality is still there, it just shifted to a more flexible, map-focused setup.

Here are the two main ways to replicate your old behavior where you set csvWriter.Configuration.ReferenceHeaderPrefix = (memberType, memberName) => $"{memberName}_":

1. Use Class Maps (Recommended for Granular Control) #

The preferred approach now is to define a class map for your target type, and configure the reference property's header prefix directly in the map. This lets you set different prefixes for different references if you need to.

Let's say you have an Order class that references a Customer—here's how you'd set it up:

public class OrderMap : ClassMap<Order>
{
    public OrderMap()
    {
        // First map your regular properties
        Map(m => m.OrderId);
        Map(m => m.OrderDate);

        // Configure the Customer reference with your custom prefix logic
        References<CustomerMap>(m => m.Customer, refConfig =>
        {
            refConfig.HeaderPrefix((memberType, memberName) => $"{memberName}_");
        });
    }
}

public class CustomerMap : ClassMap<Customer>
{
    public CustomerMap()
    {
        Map(m => m.CustomerId);
        Map(m => m.Name);
    }
}

Then when writing your CSV, just register the map with your CsvWriter:

using (var writer = new StreamWriter("orders.csv"))
using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
{
    csv.Context.RegisterClassMap<OrderMap>();
    csv.WriteRecords(yourOrderList);
}

2. Global Configuration (For App-Wide Prefix) #

If you want the same prefix applied to every reference property across your entire application, you can set it globally via the TypeConverterOptionsCache:

var csvConfig = new CsvConfiguration(CultureInfo.InvariantCulture)
{
    // Add any other global config settings here
};

// Apply your custom prefix logic to all reference types
csvConfig.TypeConverterOptionsCache.GetOptions<object>().ReferenceHeaderPrefix = (memberType, memberName) => $"{memberName}_";

using (var writer = new StreamWriter("global-output.csv"))
using (var csv = new CsvWriter(writer, csvConfig))
{
    csv.WriteRecords(yourDataSet);
}

This will use your lambda for every reference property that doesn't have an explicit override in a class map.

Quick Note on the Change #

The CsvHelper team made this shift to prioritize class map-based configuration, which gives you more control over individual properties instead of a one-size-fits-all global setting. It's a bit more code upfront, but it's way more flexible if you need different prefixes for different references later on.

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