OrchardCore中禁用JsonStringEnumConverter的配置方法

在OrchardCore 2.1.3版本中，系统默认引入了JsonStringEnumConverter，这一改动将枚举类型序列化为字符串而非整数。虽然这种改变对大多数应用场景有利，但对于某些特定场景，特别是需要严格控制存储空间使用的高频交易系统，这种改变可能带来不便。

背景分析

JsonStringEnumConverter是System.Text.Json提供的一个转换器，它能够将枚举值序列化为对应的字符串名称而非数字值。这种序列化方式具有更好的可读性，但在以下场景中可能不适用：

1. 需要与旧系统保持兼容，旧系统依赖枚举的整数值
2. 存储空间极其有限，需要最小化数据体积
3. 与其他系统交互，这些系统只能处理枚举的数值形式

OrchardCore在文档序列化中默认启用了这个转换器，这会影响内容项(ContentItem)和其他文档的存储格式。

解决方案

通过分析OrchardCore的源代码，我们发现可以通过修改DocumentJsonSerializerOptions和JOptions.Default的配置来移除JsonStringEnumConverter。以下是完整的实现方案：

public static class DocumentJsonSerializerExtensions
{
    public static void RemoveJsonStringEnumConverter(this IServiceCollection services)
    {
        services.Configure<DocumentJsonSerializerOptions>(options =>
        {
            var enumConverter = options.SerializerOptions.Converters
                .FirstOrDefault(x => x.GetType() == typeof(JsonStringEnumConverter));
            
            if (enumConverter != null)
            {
                options.SerializerOptions.Converters.Remove(enumConverter);
            }

            var defaultConverter = JOptions.Default.Converters
                .FirstOrDefault(x => x.GetType() == typeof(JsonStringEnumConverter));
            
            if (defaultConverter != null)
            {
                JOptions.Default.Converters.Remove(defaultConverter);
            }
        });
    }
}

在应用程序启动时调用此扩展方法：

public void ConfigureServices(IServiceCollection services)
{
    services.AddOrchardCms();
    services.RemoveJsonStringEnumConverter();
}

实现原理

这个解决方案通过两个关键步骤确保枚举值以整数形式序列化：

1. 从DocumentJsonSerializerOptions中移除JsonStringEnumConverter，这会影响OrchardCore文档的序列化行为
2. 从JOptions.Default中移除相同的转换器，确保所有使用默认JSON选项的地方都保持一致

需要注意的是，这个配置应该放在主Web项目的启动代码中，而不是模块的启动代码中。因为在模块被激活前，主应用可能已经执行了一些序列化操作。

性能考量

对于高频交易系统，使用整数而非字符串序列化枚举可以带来以下优势：

1. 减少存储空间：整数通常占用更少的字节
2. 提高序列化/反序列化速度：整数处理比字符串更高效
3. 降低网络传输开销：在分布式系统中尤为重要

兼容性建议

虽然本文介绍了如何禁用JsonStringEnumConverter，但在大多数情况下，建议开发者适应新的字符串序列化方式，因为：

1. 字符串形式的枚举值更具可读性
2. 更易于调试和维护
3. 是.NET生态系统的推荐做法

只有在确实需要整数序列化的特定场景下，才建议使用本文的解决方案。

通过这种灵活的配置方式，OrchardCore既保持了默认的最佳实践，又为特殊需求提供了解决方案，体现了框架设计的包容性和可扩展性。