基于.Net Framework 4.6.1，如何让OData v4返回枚举值而非名称？

针对你遇到的OData默认返回枚举名称、但需要返回数值的问题，结合你使用的Microsoft.AspNet.OData v6.1.0、.NET Framework 4.6.1版本，我整理了两种可行的配置方式：

1. 全局配置（推荐） #

这种方式会让所有枚举在OData响应中都返回数值，适合全局统一需求。在你的WebAPI配置类（比如WebApiConfig.cs）中，配置OData路由的时候，通过setupAction修改ODataMessageWriterSettings的枚举序列化格式：

public static void Register(HttpConfiguration config)
{
    // 构建OData模型
    var builder = new ODataConventionModelBuilder();
    builder.EntitySet<YourTargetEntity>("YourEntitySetName"); // 替换成你的实体集和实体类型
    // 其他模型配置...

    var edmModel = builder.GetEdmModel();

    // 配置OData路由并设置枚举序列化格式
    config.MapODataServiceRoute(
        routeName: "ODataRoute",
        routePrefix: null,
        model: edmModel,
        batchHandler: new DefaultODataBatchHandler(GlobalConfiguration.DefaultServer),
        setupAction: container =>
        {
            var writerSettings = container.GetRequiredService<ODataMessageWriterSettings>();
            // 设置枚举序列化为数值格式
            writerSettings.EnumSerializerSettings.Format = EnumFormat.Value;
        });
}

修改完成后重启服务，OData返回的所有枚举字段就会显示对应的数值而非字符串名称了。

2. 局部/特定场景配置（可选） #

如果你只需要特定枚举或特定实体属性返回数值，可以通过自定义OData序列化器实现。这种方式相对复杂，适合精细化控制的场景。

比如，创建一个继承自ODataEntityTypeSerializer的自定义序列化器，重写WriteObject方法处理特定枚举属性：

public class CustomEntitySerializer : ODataEntityTypeSerializer
{
    public CustomEntitySerializer(ODataSerializerProvider serializerProvider) 
        : base(serializerProvider) { }

    public override void WriteObject(object graph, Type type, ODataMessageWriter messageWriter, ODataSerializerContext writeContext)
    {
        var entity = graph as YourTargetEntity;
        if (entity != null)
        {
            // 手动将枚举属性转换为数值
            entity.YourEnumProperty = (YourEnum)Convert.ToInt32(entity.YourEnumProperty);
        }
        base.WriteObject(graph, type, messageWriter, writeContext);
    }
}

然后在配置中注册这个自定义序列化器：

config.MapODataServiceRoute(
    routeName: "ODataRoute",
    routePrefix: null,
    model: edmModel,
    batchHandler: new DefaultODataBatchHandler(GlobalConfiguration.DefaultServer),
    setupAction: container =>
    {
        var serializerProvider = container.GetRequiredService<ODataSerializerProvider>();
        // 替换特定实体的序列化器
        serializerProvider.SetSerializer(typeof(YourTargetEntity), new CustomEntitySerializer(serializerProvider));
    });

如果没有特殊的精细化需求，还是全局配置更简洁高效。

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